查询VPC入站网络列表 - ListCoreIngressNetworks
功能介绍
该接口用于查询某一个具体的Agent网关下的所有入站网络列表,不支持分页。
适用场景:
查询某一个具体的Agent网关下的所有入站网络列表。
URI
GET /v1/core/ingresses/{ingress_id}/vpc-networks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ingress_id |
是 |
String |
参数解释: Agent网关ID,用于标识入站网络所属的网关,用户可以通过AgentGateway的查询网关实例列表接口来查询到对应的网关ID。 约束限制: 不涉及。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释: 总数。 取值范围: 0 - 10 |
|
items |
Array of CoreIngressNetworkItem objects |
参数解释: VPC入站网络列表。 取值范围: 最小数量 0,最大数量 10。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: VPC附件ID。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 |
|
subnet_id |
String |
参数解释: VPC子网ID。 取值范围: 匹配标准的UUID格式(8-4-4-4-12的十六进制数字串,由连字符分隔),符合正则条件^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$。 |
|
ip_address |
String |
参数解释: 分配的IP地址。 取值范围: 长度为 1 - 32 个字符。 |
|
created_at |
String |
参数解释: 创建时间。 取值范围: UTC时间格式。 |
|
updated_at |
String |
参数解释: 更新时间。 取值范围: UTC时间格式。 |
|
default_private_zone_domain_name |
String |
参数解释: 默认私网域名。 取值范围: 长度为 1 - 512 个字符。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。枚举值说明:AgentArts.03000400表示客户端请求参数错误。 取值范围: 固定值:AgentArts.03000400。 |
|
error_msg |
String |
错误详细信息。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。枚举值说明:AgentArts.03000401表示未授权(认证令牌缺失、无效或已过期)。 取值范围: 不涉及。 |
|
error_msg |
String |
参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。枚举值说明:AgentArts.03000403表示禁止访问(认证后权限不足)。 取值范围: 固定值:AgentArts.03000403。 |
|
error_msg |
String |
参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
|
coded_authorization_message |
String |
参数解释: IAM5 当OpenAPI无权限时报错信息。 取值范围: 长度为 1 - 1024 个字符。 |
|
details |
Array of CoreRunErrorDetail objects |
参数解释: 依赖的下游服务错误信息列表。 取值范围: 最小数量 0,最大数量 10。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 长度为 18 个字符。 |
|
error_msg |
String |
参数解释: 错误信息。 取值范围: 长度为 1 - 1024 个字符。 |
状态码:429
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。枚举值说明:AgentArts.03000429表示请求过于频繁(触发限流)。 取值范围: 固定值:AgentArts.03000429。 |
|
error_msg |
String |
参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。枚举值说明:AgentArts.03000500表示服务器内部错误。 取值范围: 固定值:AgentArts.03000500。 |
|
error_msg |
String |
参数解释: 错误详细信息。 取值范围: 长度为 1 - 512 个字符。 |
请求示例
无
响应示例
状态码:200
查询成功,返回VPC入站网络列表。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询成功,返回VPC入站网络列表。 |
|
400 |
请求参数错误。 |
|
401 |
未授权(认证令牌缺失、无效或已过期)。 |
|
403 |
禁止访问(认证后权限不足)。 |
|
429 |
请求过于频繁(触发限流)。 |
|
500 |
服务器内部错误。 |
错误码
请参见错误码。