CreateIngress_Serverless 应用引擎_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
sae:CreateIngress
Create
全部资源
*

请求语法

POST /pop/v1/sam/ingress/Ingress HTTP/1.1

请求参数

字段名称字段详情
NamespaceIdstring

应用所在命名空间 ID,目前不支持跨命名空间的应用。

示例值:cn-beijing:sae-test参考取值来源:
    UpdateNamespace
    CreateNamespace
    DescribeNamespace
Descriptionstring

路由规则名称。

示例值:ingress-for-sae-test
SlbIdstring

路由规则所使用的 SLB 实例 ID。展开详情

示例值:lb-uf6hucc7inlqrtcq5****
ListenerPortinteger<int32>

SLB 监听端口,该端口不能被占用。

示例值:80
CertIdstring

CLB 证书 ID。取值说明如下:展开详情

示例值:188077086902****_176993d****_181437****_108724****
CertIdsstring

ALB 多证书 ID。取值说明如下:展开详情

示例值:87***35-cn-hangzhou,812***3-cn-hangzhou
DefaultRulestring

默认转发规则。按照 IP 地址,通过指定端口转发流量到指定应用。参数说明如下:展开详情

示例值:{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080}
Rulesstring

转发规则。按照域名和请求路径,通过指定端口转发流量到指定应用。参数说明如下:展开详情

示例值:[{"appId":"395b60e4-0550-458d-9c54-a265d036****","containerPort":8080,"domain":"www.sae.site","path":"/path1"},{"appId":"666403ce-d25b-47cf-87fe-497565d2****","containerPort":8080,"domain":"sae.site","path":"/sys/(.*)/(.*)/aaa","backendProtocol":"http"}]
LoadBalanceTypestring

负载均衡 SLB 的类型。取决于创建路由规则时填写的类型,更新时不可变更。取值说明如下:展开详情

示例值:clb
ListenerProtocolstring

请求转发协议。取值说明如下:展开详情

示例值:HTTP
SecurityPolicyIdstring

安全策略实例 ID。

示例值:sp-bp1bpn0kn9****
RequestTimeoutinteger<int32>

指定请求超时时间。单位:秒。取值范围:1~180。展开详情

示例值:3
IdleTimeoutinteger<int32>

指定连接空闲超时时间。单位:秒。取值范围:1~60。展开详情

示例值:15
EnableXForwardedForboolean
EnableXForwardedForClientSrcPortboolean
EnableXForwardedForProtoboolean
EnableXForwardedForSlbIdboolean
EnableXForwardedForSlbPortboolean
AddressTypestring
LoadBalancerEditionstring
ZoneMappingsstring
CorsConfigstring
参考取值来源:
    DescribeApplicationConfig

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Messagestring

附加信息。取值说明如下:展开详情

示例值:success
TraceIdstring

调用链 ID,用于精确查询调用信息。

示例值:0a98a02315955564772843261e****
Dataobject

返回结果。

ErrorCodestring

错误码。取值说明如下:展开详情

示例值:
Codestring

接口状态或 POP 错误码。取值说明如下:展开详情

示例值:200
Successboolean

创建路由规则是否成功。取值说明如下:展开详情

示例值:true

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParameter.NotEmpty
You must specify the parameter %s.诊断
400
InvalidParameter.Obviously
The specified parameter is invalid {%s}.诊断
400
InvalidParameter.WithMessage
The parameter is invalid {%s}: %s诊断
400
Slb.NotFound
The SLB instance does not exist: slbId [%s]诊断
400
Exceed.IngressRule
The number of Ingress related rules must be less than or equal to 40.诊断
400
SlbListenerPort.NotAvailable
The SLB listening port is unavailable: slbId [%s], port [%s]诊断
400
SSLCert.NotFound
The specified SSL certificate cannot be found.诊断
404
InvalidResponse.Api
The response of API %s is empty.诊断

变更历史

变更时间变更内容概要操作
2025-03-21
新增请求参数CorsConfig
2025-01-10
变更请求参数SlbId
新增请求参数AddressType
新增请求参数LoadBalancerEdition
新增请求参数ZoneMappings
2024-10-29
变更请求参数SecurityPolicyId
变更请求参数RequestTimeout
变更请求参数IdleTimeout
新增请求参数EnableXForwardedFor
新增请求参数EnableXForwardedForClientSrcPort
新增请求参数EnableXForwardedForProto
新增请求参数EnableXForwardedForSlbId
新增请求参数EnableXForwardedForSlbPort
2024-09-11
新增请求参数IdleTimeout
2024-08-21
新增请求参数SecurityPolicyId
新增请求参数RequestTimeout
2022-12-02
新增请求参数CertIds

相关示例