查询NAT网关列表
功能介绍
查询NAT网关列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/nat-gateways
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
公网NAT网关实例的ID。 |
|
enterprise_project_id |
否 |
String |
企业项目ID。创建公网NAT网关实例时，关联的企业项目ID。 |
|
description |
否 |
String |
公网NAT网关实例的描述，长度限制为255。 |
|
created_at |
否 |
String |
公网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 |
|
name |
否 |
String |
公网NAT网关实例的名字，长度限制为64。公网NAT网关实例的名字仅支持数字、字母、_（下划线）、-（中划线）、中文。 |
|
status |
否 |
Array of strings |
公网NAT网关实例的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE INACTIVE |
|
spec |
否 |
Array of strings |
公网NAT网关实例的规格。取值为： "1"：小型，SNAT最大连接数10000；"2"：中型，SNAT最大连接数50000；"3"：大型，SNAT最大连接数200000；"4"：超大型，SNAT最大连接数1000000。 |
|
router_id |
否 |
String |
VPC的id。 |
|
limit |
否 |
Integer |
功能说明：每页返回的个数。取值范围：1~2000。默认值：2000。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
nat_gateways |
Array of NatGateway objects |
网关实例信息列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
网关实例的ID。 |
|
tenant_id |
String |
项目的ID。 |
|
name |
String |
公网NAT网关实例的名字，长度限制为64。 |
|
description |
String |
公网NAT网关实例的描述，长度限制为255。 |
|
spec |
String |
公网NAT网关的规格。取值为：“1”：小型，SNAT最大连接数10000；“2”：中型，SNAT最大连接数50000；“3”：大型，SNAT最大连接数200000；“4”：超大型，SNAT最大连接数1000000。 |
|
status |
String |
公网NAT网关实例的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE INACTIVE |
|
admin_state_up |
String |
公网NAT网关实例的名字，长度限制为64。 解冻/冻结状态。取值范围： "true"：解冻 "false"：冻结 |
|
created_at |
String |
公网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 |
|
router_id |
String |
VPC的id。 |
|
internal_network_id |
String |
公网NAT网关下行口（DVR的下一跳）所属的network id。 |
|
enterprise_project_id |
String |
企业项目ID。创建公网NAT网关实例时，关联的企业项目ID。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，失败时返回。 |
|
error_msg |
String |
错误描述。 |
|
error_detail |
String |
错误详情。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
无
响应示例
状态码：200
校验结果。
{
"nat_gateways" : [ {
"id" : "string",
"tenant_id" : "string",
"name" : "string",
"description" : "string",
"spec" : "string",
"status" : "string",
"admin_state_up" : "string",
"created_at" : "string",
"router_id" : "string",
"internal_network_id" : "string",
"enterprise_project_id" : "string"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
校验结果。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。
