# 查询SNAT规则列表 - ListPrivateSnats #### 功能介绍 查询SNAT规则列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-natgateway/nat_api_0053.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-natgateway/nat_api_0063.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | nat:privateNatSnatRules:list | List | privateSnatRule \* | g:EnterpriseProjectId | - | - | #### URI GET /v3/{project_id}/private-nat/snat-rules 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目的ID。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | 功能说明：每页返回的个数。 取值范围：1\~2000。 默认值：2000。 | | marker | 否 | String | 功能说明：分页查询起始的资源ID，为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。 | | page_reverse | 否 | Boolean | 是否查询前一页。 | | id | 否 | Array of strings | SNAT规则的ID。 | | project_id | 否 | Array of strings | 项目的ID。 | | description | 否 | Array of strings | SNAT规则的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | gateway_id | 否 | Array of strings | 私网NAT网关实例的ID。 | | cidr | 否 | Array of strings | 规则匹配的CIDR。 | | virsubnet_id | 否 | Array of strings | 规则匹配的子网的ID。 | | transit_ip_id | 否 | Array of strings | 中转IP的ID。 | | transit_ip_address | 否 | Array of strings | 中转IP地址。 | | enterprise_project_id | 否 | Array of strings | 企业项目ID。创建SNAT规则时，关联的企业项目ID。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的"X-Subject-Token"的值即为Token值。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | snat_rules | Array of [PrivateSnat] objects | 查询SNAT规则列表的响应体。 | | page_info | [PageInfo] object | 分页信息。 | | request_id | String | 请求ID。 | 表5PrivateSnat | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | SNAT规则的ID。 | | project_id | String | 项目的ID。 | | gateway_id | String | 私网NAT网关实例的ID。 | | cidr | String | 功能说明：规则匹配的CIDR。 取值约束： - 与virsubnet_id参数二选一。 - cidr不能与已有snat规则的网段相同。 | | virsubnet_id | String | 功能说明：规则匹配的子网的ID。 取值约束：与cidr参数二选一。 | | description | String | SNAT规则的描述。长度范围小于等于255个字符，不能包含"\<"和"\>"。 | | transit_ip_associations | Array of [AssociatedTransitIp] objects | 关联的中转IP详情列表。 | | created_at | String | SNAT规则的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 | | updated_at | String | SNAT规则的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 | | enterprise_project_id | String | 企业项目id | | status | String | 私网NAT的SNAT规则状态。 取值为： - ACTIVE：正常运行 - FROZEN：冻结 - INACTIVE：不可用 | 表6AssociatedTransitIp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | transit_ip_id | String | 中转IP的ID。 | | transit_ip_address | String | 中转IP地址。 | 表7PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | 分页查询结果中最后一条记录的ID。通常用于查询下一页。 | | previous_marker | String | 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 | | current_count | Integer | 分页查询资源时，本页的实例的个数。 | #### 请求示例 ``` 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:07Z", "updated_at" : "2019-10-22T03:33:07Z", "status" : "ACTIVE" }, { "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:19Z", "updated_at" : "2019-10-22T03:31:19Z", "status" : "ACTIVE" } ], "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规则列表成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-natgateway/ErrorCode.html)。