查询实例的自定义入方向端口列表
功能介绍
查询实例的自定义入方向端口列表。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-ports
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID，获取方式请参见获取项目ID。 |
instance_id |
是 |
String |
实例ID，在API网关控制台的“实例信息”中获取。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Long |
偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 |
limit |
否 |
Integer |
每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 |
protocol |
否 |
String |
入方向端口的请求协议。
枚举值：
|
ingress_port |
否 |
Integer |
入方向端口的端口号，支持的端口范围为1024~49151。 最小值：1024 最大值：49151 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
size |
Integer |
本次返回的列表长度 |
total |
Long |
满足条件的记录数 |
ingress_port_infos |
Array of IngressPortInfo objects |
实例自定义入方向端口列表。 |
参数 |
参数类型 |
描述 |
|---|---|---|
protocol |
String |
实例自定义入方向端口协议。
枚举值：
|
ingress_port |
Integer |
实例自定义入方向端口，支持的端口范围为1024~49151。 最小值：1024 最大值：49151 |
ingress_port_id |
String |
实例自定义入方向端口ID。 最小长度：32 最大长度：36 |
status |
String |
实例自定义入方向端口的有效状态。
枚举值：
|
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码： 200
OK
{
"total" : 1,
"size" : 1,
"ingress_port_infos" : [ {
"protocol" : "HTTP",
"ingress_port" : 8080,
"ingress_port_id" : "0ae98839d78043d8a6dff54d7cb096dc",
"status" : "normal"
} ]
}
状态码： 401
Unauthorized
{
"error_code" : "APIC.7102",
"error_msg" : "Incorrect token or token resolution failed"
}
状态码： 403
Forbidden
{
"error_code" : "APIC.7106",
"error_msg" : "No permissions to request for the method"
}
状态码： 500
Internal Server Error
{
"error_code" : "APIC.9000",
"error_msg" : "Failed to request internal service"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal Server Error |
错误码
请参见错误码。
