查询SNAT规则列表
功能介绍
查询SNAT规则列表。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/private-nat/snat-rules
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目的ID。 最小长度：1 最大长度：36 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
limit |
否 |
Integer |
功能说明：每页返回的个数。 取值范围：0~2000。 默认值：2000。 最小值：1 最大值：2000 缺省值：2000 |
marker |
否 |
String |
功能说明：分页查询起始的资源ID，为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。 最小长度：36 最大长度：36 |
page_reverse |
否 |
Boolean |
是否查询前一页。 |
id |
否 |
Array |
SNAT规则的ID。 数组长度：1 - 10 |
project_id |
否 |
Array |
项目的ID。 数组长度：1 - 10 |
description |
否 |
Array |
SNAT规则的描述。长度范围小于等于255个字符，不能包含“<”和“>”。 数组长度：1 - 10 |
gateway_id |
否 |
Array |
私网NAT网关实例的ID。 数组长度：1 - 10 |
cidr |
否 |
Array |
规则匹配的CIDR。 数组长度：1 - 10 |
virsubnet_id |
否 |
Array |
规则匹配的子网的ID。 数组长度：1 - 10 |
transit_ip_id |
否 |
Array |
中转IP的ID。 数组长度：1 - 10 |
transit_ip_address |
否 |
Array |
中转IP地址。 数组长度：1 - 10 |
enterprise_project_id |
否 |
Array |
企业项目ID。创建SNAT规则时，关联的企业项目ID。 数组长度：1 - 10 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度：1 最大长度：10240 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
snat_rules |
Array of PrivateSnat objects |
查询SNAT规则列表的响应体。 数组长度：0 - 2000 |
page_info |
PageInfo object |
分页信息。 |
request_id |
String |
请求ID。 最小长度：1 最大长度：36 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
SNAT规则的ID。 最小长度：36 最大长度：36 |
project_id |
String |
项目的ID。 最小长度：36 最大长度：36 |
gateway_id |
String |
私网NAT网关实例的ID。 最小长度：36 最大长度：36 |
cidr |
String |
功能说明：规则匹配的CIDR。 取值约束：
最小长度：9 最大长度：18 |
virsubnet_id |
String |
功能说明：规则匹配的子网的ID。 取值约束：与cidr参数二选一。 最小长度：36 最大长度：36 |
description |
String |
SNAT规则的描述。长度范围小于等于255个字符，不能包含“<”和“>”。 最小长度：1 最大长度：36 |
transit_ip_associations |
Array of AssociatedTransitIp objects |
关联的中转IP详情列表。 数组长度：1 - 1 |
created_at |
String |
SNAT规则的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 最小长度：1 最大长度：36 |
updated_at |
String |
SNAT规则的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 最小长度：1 最大长度：36 |
enterprise_project_id |
String |
企业项目id 最小长度：1 最大长度：36 |
请求示例
GET https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules
响应示例
状态码： 200
查询SNAT规则列表成功。
{
"snat_rules" : [ {
"id" : "8a522ff9-8158-494b-83cd-533b045700e6",
"project_id" : "cfa563efb77d4b6d9960781d82530fd8",
"description" : "snat rule description",
"gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
"cidr" : "",
"virsubnet_id" : "95df1b88-d9bc-4edd-a808-a771dd4ded32",
"transit_ip_associations" : [ {
"transit_ip_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
"transit_ip_address" : "172.20.1.98"
} ],
"created_at" : "2019-10-22T03:33:07",
"updated_at" : "2019-10-22T03:33:07"
}, {
"id" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
"project_id" : "cfa563efb77d4b6d9960781d82530fd8",
"description" : "snat rule description",
"gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb",
"cidr" : "",
"virsubnet_id" : "5b9ea497-727d-4ad0-a99e-3984b3f5aaed",
"transit_ip_associations" : [ {
"transit_ip_id" : "36a3049a-1682-48b3-b1cf-cb986a3350ef",
"transit_ip_address" : "172.20.1.10"
} ],
"created_at" : "2019-10-22T03:31:19",
"updated_at" : "2019-10-22T03:31:19"
} ],
"page_info" : {
"next_marker" : "af4dbb83-7ca0-4ed1-b28b-668c1f9c6b81",
"previous_marker" : "8a522ff9-8158-494b-83cd-533b045700e6",
"current_count" : 2
},
"request_id" : "69806207-62e3-4950-b463-ff5c1779b714"
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询SNAT规则列表成功。 |
错误码
请参见错误码。
