链接复制成功!
查询SNAT规则列表
功能介绍
查询SNAT规则列表。
接口约束
可以在URI后面用'?'和'&'添加不同的查询条件组合。支持参数说明中所有非必选参数过滤,请参考请求样例。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/snat_rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
admin_state_up |
否 |
Boolean |
解冻/冻结状态。 取值范围: "true":解冻 "false":冻结 |
cidr |
否 |
String |
可以是网段或者主机格式,与network_id参数二选一。 Source_type=0时,cidr必须是vpc子网网段的子集(不能相等); Source_type=1时,cidr必须指定专线侧网段。 |
limit |
否 |
Integer |
功能说明:每页返回的个数。 取值范围:1~2000。 默认值:2000。 |
floating_ip_address |
否 |
String |
功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。 取值范围:最大长度1024字节。 |
global_eip_address |
否 |
String |
功能说明:全域弹性公网IP,多个全域弹性公网IP使用逗号分隔。 取值范围:最大长度1024字节。 |
floating_ip_id |
否 |
String |
功能说明:弹性公网IP的id,多个弹性公网IP使用逗号分隔。 取值范围:最大长度4096字节。 |
global_eip_id |
否 |
String |
功能说明:全域弹性公网IP的id,多个全域弹性公网IP使用逗号分隔。 取值范围:最大长度4096字节。 |
id |
否 |
String |
SNAT规则的ID。 |
description |
否 |
String |
SNAT规则的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 |
created_at |
否 |
String |
SNAT规则的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 |
nat_gateway_id |
否 |
Array of strings |
公网NAT网关实例的ID。 |
network_id |
否 |
String |
规则使用的网络id。与cidr参数二选一。 |
source_type |
否 |
Integer |
0:VPC侧,可以指定network_id 或者cidr 1:专线侧,只能指定cidr 不输入默认为0(VPC) |
status |
否 |
String |
SNAT规则的状态。 取值为: ACTIVE: 可用 PENDING_CREATE: 创建中 PENDING_UPDATE: 更新中 PENDING_DELETE: 删除中 EIP_FREEZED: EIP冻结 INACTIVE: 不可用 |
marker |
否 |
String |
分页查询的起始资源ID,表示从指定资源的下一条记录开始查询。
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
snat_rules |
Array of NatGatewaySnatRuleResponseBody objects |
查询SNAT规则列表的响应体。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
SNAT规则的ID。 |
tenant_id |
String |
项目的ID。 |
nat_gateway_id |
String |
公网NAT网关实例的ID。 |
cidr |
String |
cidr,可以是网段或者主机格式,与network_id参数二选一。 Source_type=0时,cidr必须是vpc 子网网段的子集(不能相等); Source_type=1时,cidr必须指定专线侧网段。 |
source_type |
Integer |
0: VPC侧,可以指定network_id 或者cidr 1: 专线侧,只能指定cidr 不输入默认为0(VPC) |
floating_ip_id |
String |
功能说明: 弹性公网IP的id,多个弹性公网IP使用逗号分隔。 |
description |
String |
SNAT规则的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 |
status |
String |
SNAT规则的状态。 取值为: ACTIVE: 可用 PENDING_CREATE: 创建中 PENDING_UPDATE: 更新中 PENDING_DELETE: 删除中 EIP_FREEZED: EIP冻结 INACTIVE: 不可用 |
created_at |
String |
SNAT规则的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 |
network_id |
String |
规则使用的网络id。与cidr参数二选一。 |
admin_state_up |
Boolean |
解冻/冻结状态。 取值范围:
|
floating_ip_address |
String |
功能说明: 弹性公网IP,多个弹性公网IP使用逗号分隔。 |
freezed_ip_address |
String |
功能说明: 冻结的弹性公网IP,多个冻结的弹性公网IP使用逗号分隔。 |
global_eip_id |
String |
全域弹性公网IP的id。 |
global_eip_address |
String |
全域弹性公网IP的地址。 |
请求示例
GET https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules?limit=2
响应示例
状态码: 200
查询SNAT规则列表成功。
{ "snat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "network_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "source_type" : 0, "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2017-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.242", "freezed_ip_address" : "", "description" : "my snat rule 01" }, { "floating_ip_id" : "6e496fba-abe9-4f5e-9406-2ad8c809ac8c", "status" : "ACTIVE", "nat_gateway_id" : "e824f1b4-4290-4ebc-8322-cfff370dbd1e", "admin_state_up" : true, "network_id" : "97e89905-f9c8-4ae3-9856-392b0b2fbe7f", "source_type" : 0, "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2017-11-17 07:43:44.830845", "id" : "4a1a10d7-0d9f-4846-8cda-24cffeffef5c", "floating_ip_address" : "5.21.11.142,5.21.11.143", "freezed_ip_address" : "5.21.11.142", "description" : "my snat rule 01" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
查询SNAT规则列表成功。 |
错误码
请参见错误码。