调用ListIngresses接口获取Ingress列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求头
该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头。
请求语法
GET /pop/v1/sam/ingress/IngressList HTTP/1.1
请求参数
名称 |
类型 |
位置 |
是否必选 |
示例值 |
描述 |
NamespaceId | String | Query | 是 | cn-beijing | 命名空间ID。 |
AppId | String | Query | 否 | bbf3a590-6d13-46fe-8ca9-c947a20b**** | 应用ID。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
RequestId | String | 91F93257-7A4A-4BD3-9A7E-2F6EAE6D**** | 请求ID。 |
Message | String | success | 附加信息。取值说明如下:
|
TraceId | String | 0a98a02315955564772843261e**** | 调用链ID,用于精确查询调用信息。 |
Data | Object | 返回结果。 |
|
IngressList | Array of Ingress | 路由规则列表。 |
|
SlbId | String | lb-uf62****6d13tq2u5 | SLB ID。 |
NamespaceId | String | cn-shanghai | 命名空间ID。 |
Description | String | test | 路由规则名称。 |
ListenerPort | String | 80 | SLB监听端口。 |
SlbType | String | internet | SLB类型。取值说明如下:
|
CertId | String | 13624*****73809_16f8e549a20_1175189789_12****3210 | CLB证书ID。 |
CertIds | String | 87***35-cn-hangzhou,812***3-cn-hangzhou | ALB多证书ID。 |
Name | String | lb-uf6jt0nu4z6ior943****-80-f5**** | 路由规则名称。 |
Id | Long | 18 | 路由规则ID。 |
LoadBalanceType | String | clb | 负载均衡SLB的类型。取值说明如下:
|
ListenerProtocol | String | HTTP | 负载均衡SLB支持的请求转发协议。取值说明如下:
在CreateIngress和UpadateIngress中,该参数非必填项,如果创建或更新网关路由规则时未填写该参数,则调用该API时不返回。 |
MseGatewayId | String | gw-d5df01a1bae748f1a7c4e325d2fd**** | MSE云原生网关实例ID。 |
MseGatewayPort | String | 80 | 服务对应的端口。 |
MseGatewayProtocol | String | HTTP | MSE云原生网关支持的请求转发协议。取值说明如下:
|
ErrorCode | String | 空 | 错误码。取值说明如下:
|
Code | String | 200 | 接口状态或POP错误码。取值说明如下:
|
Success | Boolean | true | 获取Ingress列表是否成功。取值说明如下:
|
示例
请求示例
GET /pop/v1/sam/ingress/IngressList?NamespaceId=cn-beijing&AppId=bbf3a590-6d13-46fe-8ca9-c947a20b**** HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListIngressesResponse>
<RequestId>91F93257-7A4A-4BD3-9A7E-2F6EAE6D****</RequestId>
<Message>success</Message>
<TraceId>0a98a02315955564772843261e****</TraceId>
<Data>
<IngressList>
<SlbId>lb-uf62****6d13tq2u5</SlbId>
<NamespaceId>cn-shanghai</NamespaceId>
<Description>test</Description>
<ListenerPort>80</ListenerPort>
<SlbType>internet</SlbType>
<CertId>13624*****73809_16f8e549a20_1175189789_12****3210</CertId>
<CertIds>87***35-cn-hangzhou,812***3-cn-hangzhou</CertIds>
<Name>lb-uf6jt0nu4z6ior943****-80-f5****</Name>
<Id>18</Id>
<LoadBalanceType>clb</LoadBalanceType>
<ListenerProtocol>HTTP</ListenerProtocol>
<MseGatewayId>gw-d5df01a1bae748f1a7c4e325d2fd****</MseGatewayId>
<MseGatewayPort>80</MseGatewayPort>
<MseGatewayProtocol>HTTP</MseGatewayProtocol>
</IngressList>
</Data>
<Code>200</Code>
<Success>true</Success>
</ListIngressesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
"Message" : "success",
"TraceId" : "0a98a02315955564772843261e****",
"Data" : {
"IngressList" : [ {
"SlbId" : "lb-uf62****6d13tq2u5",
"NamespaceId" : "cn-shanghai",
"Description" : "test",
"ListenerPort" : "80",
"SlbType" : "internet",
"CertId" : "13624*****73809_16f8e549a20_1175189789_12****3210",
"CertIds" : "87***35-cn-hangzhou,812***3-cn-hangzhou",
"Name" : "lb-uf6jt0nu4z6ior943****-80-f5****",
"Id" : 18,
"LoadBalanceType" : "clb",
"ListenerProtocol" : "HTTP",
"MseGatewayId" : "gw-d5df01a1bae748f1a7c4e325d2fd****",
"MseGatewayPort" : "80",
"MseGatewayProtocol" : "HTTP"
} ]
},
"Code" : "200",
"Success" : true
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidParameter.NotEmpty | You must specify the parameter %s. | 不合法的参数:%s不能为空。 |
400 | InvalidParameter.Obviously | The specified parameter is invalid {%s}. | 不合法的参数{%s}。 |
400 | InvalidParameter.WithMessage | The parameter is invalid {%s}: %s | 不合法的参数{%s}:%s。 |
访问错误中心查看更多错误码。
反馈
- 本页导读 (1)
文档反馈