创建Ingress路由
更新时间 2026-06-22 10:43:19
最近更新时间: 2026-06-22 10:43:19
接口功能介绍
调用insertIngress接口创建Ingress路由
接口约束
无
URI
POST /v2/ingress/insertIngress
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID，请参考调用前必知-概述 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| envUuid | 是 | String | 环境uuid | ||
| ingressName | 是 | String | ingress路由名称，最长100个字符，由小写字母、数字、-及.组成，且开始和结尾只能是数字和字母 | ||
| ingressType | 是 | String | Ingress路由类型必须为nginx | ||
| clusterName | 是 | String | K8s集群名称 | ||
| namespace | 是 | String | K8s集群命名空间 | ||
| labels | 否 | Map of String | 标签 | ||
| annotations | 否 | Map of String | 注解 | ||
| rules | 是 | Array of Objects | Ingress路由转发规则列表 | rules |
表 rules
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| host | 是 | String | host由小写字母、数组、-和.组成，且最大长度为64位 | ||
| enableTls | 否 | Integer | 开启TLS，只能填写0关闭，1开启 | ||
| secretName | 否 | String | K8s保密字典名称 | ||
| paths | 是 | Array of Objects | Ingress路由paths列表 | paths |
表 paths
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| path | 是 | String | path路径，最大长度为1024 | ||
| pathType | 是 | String | pathType只能填写ImplementationSpecific值 | ||
| appDeployName | 是 | String | 应用实例名称 | ||
| appDeployUuid | 是 | String | 应用实例uuid | ||
| serviceName | 是 | String | 应用实例绑定的K8s service名称 | ||
| servicePort | 是 | Integer | 应用实例绑定的K8s service服务端口 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应编码 2000 success | ||
| message | String | 消息内容 | ||
| returnObj | Object | 返回数据 | ||
| error | String | 调用错误时返回的错误编码 |
枚举参数
无
请求示例
请求url
POST https://msap-global.ctapi.ctyun.cn/v2/ingress/insertIngress
请求头header
{
"regionId": "bb9fdb42056f11eda1610242ac110002"
}
请求体body
{
"envUuid": "e5fd85fc7f014d938e972a5413072e2e",
"ingressName": "666-2",
"ingressType": "nginx",
"clusterName": "cce-uq10qb2",
"namespace": "you",
"labels": {},
"annotations": {},
"rules": [
{
"host": "www.test.gogogo",
"enableTls": 0,
"paths": [
{
"path": "/a",
"pathType": "ImplementationSpecific",
"appDeployName": "consumer666",
"appDeployUuid": "4daa0cfbf1de4c90bee65c16cdbdc16c",
"serviceName": "test-666",
"servicePort": 18081
}
]
}
]
}
响应示例
{
"statusCode": 2000,
"message": "成功",
"returnObj": {
}
}
状态码
请参考 状态码
错误码
请参考 错误码
