华为云用户手册

响应示例 状态码： 201 创建SNAT规则成功。 { "snat_rule" : { "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a", "status" : "PENDING_CREATE", "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8", "admin_state_up" : true, "cidr" : "172.30.0.0/24", "description" : "", "source_type" : 1, "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3", "created_at" : "2017-11-18 07:54:21.665430", "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338", "floating_ip_address" : "5.21.11.226" }}

请求示例 创建SNAT规则，其中，公网NAT网关的id为a78fb3eb-1654-4710-8742-3fc49d5f04f8，弹性公网IP的id为bdc10a4c-d81a-41ec-adf7-de857f7c812a。 POST https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules{ "snat_rule" : { "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8", "cidr" : "172.30.0.0/24", "source_type" : 1, "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a", "description" : "my snat rule 01" }}

请求示例 创建公网NAT网关实例，其中，实例名称为nat_001，所属的VPC的id为d84f345c-80a1-4fa2-a39c-d0d397c3f09a，公网NAT网关下行口（DVR的下一跳）所属的network id为89d66639-aacb-4929-969d-07080b0f9fd9，SNAT最大连接数为10000。 POST https://{Endpoint}/v2/70505c941b9b4dfd82fd351932328a2f/nat_gateways { "nat_gateway" : { "name" : "nat_001", "description" : "my nat gateway 01", "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a", "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9", "spec" : "1", "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" }}

响应示例 状态码： 201 创建公网NAT网关实例成功。 { "nat_gateway" : { "id" : "14338426-6afe-4019-996b-3a9525296e11", "name" : "nat_001", "description" : "my nat gateway 01", "router_id" : "d84f345c-80a1-4fa2-a39c-d0d397c3f09a", "spec" : "1", "admin_state_up" : true, "tenant_id" : "70505c941b9b4dfd82fd351932328a2f", "internal_network_id" : "89d66639-aacb-4929-969d-07080b0f9fd9", "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2", "status" : "ACTIVE", "created_at" : "2019-04-22T08:47:13" }}

请求示例 创建DNAT规则，其中，公网NAT网关实例id为cda3a125-2406-456c-a11f-598e10578541，虚拟机对外提供服务的协议端口号为993，弹性公网IP的id为bf99c679-9f41-4dac-8513-9c9228e713e1，协议类型为tcp协议。 POST https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules{ "dnat_rule" : { "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "external_service_port" : 242, "description" : "my dnat rule 01" }}

响应示例 状态码： 201 创建DNAT规则成功。 { "dnat_rule" : { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d", "created_at" : "2019-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "external_service_port" : 242, "floating_ip_address" : "5.21.11.226", "description" : "my dnat rule 01" }}

请求示例 批量创建DNAT规则(第一条为指定端口的规则，第二条为all port类型的规则)，其中，公网NAT网关实例的id为dda3a125-2406-456c-a11f-598e10578541"，虚拟机对外提供服务的协议端口号为993，弹性公网IP的id为cf99c679-9f41-4dac-8513-9c9228e713e1，协议类型为any协议。 POST https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/batch{ "dnat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "external_service_port" : 242, "description" : "my dnat rule 01" }, { "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541", "private_ip" : "192.168.1.100", "internal_service_port" : 0, "protocol" : "any", "external_service_port" : 0, "description" : "my dnat rule 01" } ]}

响应示例 状态码： 201 POST操作正常返回。 { "dnat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "private_ip" : "", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2019-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.226", "external_service_port" : 242, "description" : "my dnat rule 01" }, { "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "", "private_ip" : "192.168.1.100", "internal_service_port" : 0, "protocol" : "any", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526", "created_at" : "2019-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089c2502ff", "floating_ip_address" : "5.21.11.227", "external_service_port" : 0, "description" : "my dnat rule 01" } ]}

请求示例 批量添加公网NAT网关资源标签，其中，操作标识为create，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。 POST https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/fe1a4cf0-27fe-4b97-a9b1-2c67c127f0e0/tags/action{ "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ]} 批量删除公网NAT网关资源标签，其中，操作标识为delete，标签列表中包含两个标签，其中第一个标签键为“key1”，对应的值为“value1”，第二个标签键为“key2”，对应的值为“value2”。 { "action" : "delete", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ]}

公网NAT网关DNAT规则 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 创建DNAT规则 POST /v2/{project_id}/dnat_rules nat:dnatRules:create √ √ 批量创建DNAT规则 POST /v2/{project_id}/dnat_rules/batch nat:dnatRules:create √ √ 查询DNAT规则列表 GET /v2/{project_id}/dnat_rules nat:dnatRules:list √ √ 查询DNAT规则详情 GET /v2/{project_id}/dnat_rules/{dnat_rule_id } nat:dnatRules:get √ √ 删除DNAT规则 DELETE /v2/{project_id}/nat_gateways/{nat_gateway_id}/dnat_rules/{dnat_rule_id} nat:dnatRules:delete √ √ 更新DNAT规则 PUT /v2/{project_id}/dnat_rules/{dnat_rule_id} nat:dnatRules:update √ √ 父主题： 权限策略和授权项

URI DELETE /v2/{project_id}/nat_gateways/{nat_gateway_id}/dnat_rules/{dnat_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目的ID。 最小长度：1 最大长度：36 获取方法详见获取项目ID。 nat_gateway_id 是 String 公网NAT网关实例的ID。 长度：36 dnat_rule_id 是 String DNAT规则的ID。 长度：36

URI DELETE /v2/{project_id}/nat_gateways/{nat_gateway_id}/snat_rules/{snat_rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目的ID。 最小长度：1 最大长度：36 获取方法详见获取项目ID。 nat_gateway_id 是 String 公网NAT网关实例的ID。 长度：36 snat_rule_id 是 String SNAT规则的ID。 长度：36

响应示例 状态码： 201 创建SNAT规则成功。 { "snat_rule" : { "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" }, "request_id" : "2937502e-73f9-4ba5-ae75-2293a0b35fb8"}

请求示例 创建SNAT规则，其中，SNAT规则的描述为my_snat_rule01，私网NAT网关实例的id为80da6f26-94eb-4537-97f0-5a56f4d04cfb，规则匹配的子网的id为5b9ea497-727d-4ad0-a99e-3984b3f5aaed。 https://{Endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/private-nat/snat-rules{ "snat_rule" : { "description" : "my_snat_rule01", "gateway_id" : "80da6f26-94eb-4537-97f0-5a56f4d04cfb", "virsubnet_id" : "5b9ea497-727d-4ad0-a99e-3984b3f5aaed", "transit_ip_ids" : [ "36a3049a-1682-48b3-b1cf-cb986a3350ef" ] }}

请求示例 创建私网NAT网关实例，其中，私网NAT网关实例的名称为private-nat-gateway-name，实例的规格为Small，所属的子网的id为373979ee-f4f0-46c5-80e3-0fbf72646b70。 POST https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/gateways{ "gateway" : { "name" : "private-nat-gateway-name", "description" : "private-nat-gateway-description", "spec" : "Small", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "downlink_vpcs" : [ { "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70" } ], "tags" : [ { "key" : "key1", "value" : "value1" } ] }}

响应示例 状态码： 201 创建私网NAT网关实例成功。 { "request_id" : "9882046a9b96f1405472e36d797e33dc", "gateway" : { "id" : "14338426-6afe-4019-996b-3a9525296e11", "name" : "private-nat-gateway-name", "description" : "private-nat-gateway-description", "spec" : "Small", "project_id" : "70505c941b9b4dfd82fd351932328a2f", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "status" : "ACTIVE", "created_at" : "2019-04-22T08:47:13", "updated_at" : "2019-04-22T08:47:13", "tags" : [ { "key" : "key1", "value" : "value1" } ], "downlink_vpcs" : [ { "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2", "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70" } ] }}

响应示例 状态码： 200 查询DNAT规则列表成功。 { "dnat_rules" : [ { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "private_ip" : "", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d", "created_at" : "2017-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.226", "external_service_port" : 242, "description" : "my dnat rule 01" }, { "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "dda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "", "private_ip" : "192.168.1.100", "internal_service_port" : 0, "protocol" : "any", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d", "created_at" : "2017-11-16 15:44:42.595173", "id" : "89195d50-0271-41f1-bded-4c089b2502ff", "floating_ip_address" : "5.21.11.227", "external_service_port" : 0, "description" : "my dnat rule 01" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dnat_rules Array of NatGatewayDnatRuleResponseBody objects 查询DNAT规则列表的响应体。 表5 NatGatewayDnatRuleResponseBody 参数 参数类型 描述 id String DNAT规则的ID。 长度：36 tenant_id String 项目的ID。 description String DNAT规则的描述。长度限制为255。 最大长度：255 port_id String 虚拟机或者裸机的Port ID，与private_ip参数二选一。 长度：36 private_ip String 用户私有IP地址，例如专线连接的私有云地址，与port_id参数二选一。 internal_service_port Integer 虚拟机或者裸机对外提供服务的协议端口号。取值范围：0~65535。 最小值：0 最大值：65535 最小长度：1 最大长度：5 nat_gateway_id String 公网NAT网关实例的ID。 最小长度：1 最大长度：36 floating_ip_id String 弹性公网IP的id。 最小长度：1 最大长度：36 floating_ip_address String 弹性公网IP的IP地址。 external_service_port Integer Floatingip对外提供服务的端口号。取值范围：0~65535。 status String 功能说明：DNAT规则的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE EIP_FREEZED INACTIVE admin_state_up Boolean 解冻/冻结状态。取值范围： − “true”： 解冻 − “false”： 冻结 internal_service_port_range String 虚拟机或者裸机对外提供服务的协议端口号范围。功能说明：该端口范围与external _service_port_range按顺序实现1:1映射。取值范围：1~65535。约束：只能以’-’字符连接端口范围。 external_service_port_range String Floatingip对外提供服务的端口号范围。功能说明：该端口范围与internal _service_port_range按顺序实现1:1映射。取值范围：1~65535。约束：只能以’-’字符连接端口范围 protocol String 协议类型，目前支持TCP/tcp、UDP/udp、ANY/any。对应协议号6、17、0。 最小长度：1 最大长度：3 枚举值： tcp udp any created_at String DNAT规则的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 最小长度：1 最大长度：36

响应示例 状态码： 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 表4 响应Body参数 参数 参数类型 描述 snat_rules Array of NatGatewaySnatRuleResponseBody objects 查询SNAT规则列表的响应体。 表5 NatGatewaySnatRuleResponseBody 参数 参数类型 描述 id String SNAT规则的ID。 长度：36 tenant_id String 项目的ID。 nat_gateway_id String 公网NAT网关实例的ID。 长度：36 cidr String cidr，可以是网段或者主机格式，与network_id参数二选一。source_type=0时，cidr必须是vpc子网网段的子集（不能相等）; source_type=1时，cidr必须指定专线侧网段。 最小长度：9 最大长度：39 source_type Integer 0：VPC侧，可以指定network_id 或者cidr 1：专线侧，只能指定cidr 缺省值：0 floating_ip_id String 功能说明：弹性公网IP的id，多个弹性公网IP的id使用逗号分隔。取值范围：最大长度4096字节。 description String SNAT规则的描述，长度限制为255。 最大长度：255 status String 功能说明：SNAT规则的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE EIP_FREEZED INACTIVE created_at String SNAT规则的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 最小长度：1 最大长度：36 network_id String 规则使用的网络id。与cidr参数二选一。 长度：36 admin_state_up Boolean 解冻/冻结状态。取值范围： "true"：解冻 "false"：冻结 floating_ip_address String 功能说明：弹性公网IP，多个弹性公网IP使用逗号分隔。取值范围：最大长度1024字节。 freezed_ip_address String 功能说明：冻结的弹性公网IP，多个冻结的弹性公网IP使用逗号分隔。取值范围：最大长度1024字节。

响应示例 状态码： 200 查询公网NAT网关实例列表成功 { "nat_gateways" : [ { "id" : "a253be25-ae7c-4013-978b-3c0785eccd63", "router_id" : "b1d81744-5165-48b8-916e-e56626feb88f", "status" : "ACTIVE", "description" : "nat01", "admin_state_up" : true, "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3", "created_at" : "2017-11-15 14:50:39.505112", "spec" : "2", "internal_network_id" : "5930796a-6026-4d8b-8790-6c6bfc9f87e8", "name" : "wj3", "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" }, { "id" : "e824f1b4-4290-4ebc-8322-cfff370dbd1e", "router_id" : "305dc52f-13dd-429b-a2d4-444a1039ba0b", "status" : "ACTIVE", "description" : "1234", "admin_state_up" : true, "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3", "created_at" : "2017-11-17 07:41:07.538062", "spec" : "2", "internal_network_id" : "fc09463b-4ef8-4c7a-93c8-92d9ca6daf9d", "name" : "lyl001", "enterprise_project_id" : "0" } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 nat_gateways Array of NatGatewayResponseBody objects 查询公网NAT网关实例列表的响应体。详见NatGateway字段说明。 表5 NatGatewayResponseBody 参数 参数类型 描述 id String 公网NAT网关实例的ID。 长度：36 tenant_id String 项目的ID。 name String 公网NAT网关实例的名字，长度限制为64。 最小长度：1 最大长度：64 description String 公网NAT网关实例的描述，长度限制为255。 最大长度：255 spec String 公网NAT网关的规格。取值为：“1”：小型，SNAT最大连接数10000；“2”：中型，SNAT最大连接数50000；“3”：大型，SNAT最大连接数200000；“4”：超大型，SNAT最大连接数1000000 枚举值： 1 2 3 4 status String 公网NAT网关实例的状态。 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE INACTIVE admin_state_up Boolean 解冻/冻结状态。取值范围： "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。 最大长度：36

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of Tag objects 包含标签对象列表，最多包含10个key，每个key下面的value最多10个，结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回包含所有标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无tag过滤条件时返回全量数据。 tags_any 否 Array of Tag objects 包含任意标签对象列表，最多包含10个key，每个key下面的value最多10个,结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 not_tags 否 Array of Tag objects 不包含标签对象列表，最多包含10个key，每个key下面的value最多10个, 结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回不包含标签的资源列表，key之间是与的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 not_tags_any 否 Array of Tag objects 不包含任意标签对象列表，最多包含10个key，每个key下面的value最多10个,结构体不能缺失，key不能为空或者空字符串。Key不能重复，同一个key中values不能重复。返回不包含标签的资源列表，key之间是或的关系，key-value结构中value是或的关系。无过滤条件时返回全量数据。 limit 否 String 查询记录数（action为count时无此参数）如果action为filter默认为1000，limit最多为1000,不能为负数，最小值为1 offset 否 String （索引位置）， 从offset指定的下一条数据开始查询。查询第一页数据时，不需要传入此参数，查询后续页码数据时，将查询前一页数据时响应体中的值带入此参数（action为count时无此参数）如果action为filter默认为0，必须为数字，不能为负数 action 是 String 操作标识（仅限于filter，count）：filter（过滤），count（查询总条数） 如果是filter就是分页查询，如果是count只需按照条件将总条数返回即可。禁止返回其他字段。 matches 否 Array of Match objects 搜索字段列表，key为要匹配的字段，如resource_name等。value为匹配的值。此字段为固定字典值。 根据不同的字段确认是否需要模糊匹配，如resource_name默认为模糊搜索（不区分大小写），如果value为空字符串精确匹配。resource_id为精确匹配。 表4 Tag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度127个unicode字符。key不能为空。(搜索时不对此参数做校验) ，key不能为空或者空字符串，不能为空格，校验和使用之前先trim 前后空格。 values 是 Array of strings 值列表。每个值最大长度255个unicode字符，不能为空格，校验和使用之前先trim 前后空格。 *为系统保留字符，value可为空但不可缺省。 如果里面的value是以*开头表示按照*后面的值全模糊匹配。 如果values为空列表，则表示any_value（查询任意value）。value之间为或的关系。 表5 Match 参数 是否必选 参数类型 描述 key 是 String 键。限定为resource_name。 value 是 String 值。每个值最大长度255个unicode字符。

请求示例 查询公网NAT网关资源实例，其中，操作标识为filter，进行分页查询，查询记录数为100条。 POST https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action{ "offset" : "100", "limit" : "100", "action" : "filter", "matches" : [ { "key" : "resource_name", "value" : "nat_gateways" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key2", "values" : [ "*value3", "value4" ] } ], "tags_any" : [ { "key" : "key3", "values" : [ "*value5", "value6" ] } ], "not_tags_any" : [ { "key" : "key4", "values" : [ "*value7", "value8" ] } ]} 查询公网NAT网关资源实例，其中，操作标识为count，按照条件将总条数返回。 POST https://{VPC_endpoint}/v2.0/9ad601814ac94c80bf7bb9073ded66fc/nat_gateways/resource_instances/action{ "action" : "count", "matches" : [ { "key" : "resource_name", "value" : "nat_gateways" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key2", "values" : [ "*value3", "value4" ] } ], "tags_any" : [ { "key" : "key3", "values" : [ "*value5", "value6" ] } ], "not_tags_any" : [ { "key" : "key4", "values" : [ "*value7", "value8" ] } ]}

响应示例 状态码： 200 查询操作成功。 示例1：action为filter时的响应体 示例2：action为count时的响应体 示例 1 { "resources" : [ { "resource_detail" : null, "resource_id" : "e5ad289f-9c56-4daf-b08b-2e53a983473a", "resource_name" : "nat_gateways", "tags" : [ { "key" : "key2", "value" : "value4" }, { "key" : "key2", "value" : "value3" } ] } ], "total_count" : 1000} 示例 2 { "total_count" : 1000}

响应示例 状态码： 200 查询DNAT规则列表成功。 { "dnat_rules" : [ { "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83", "project_id" : "da261828016849188f4dcc2ef94d9da9", "description" : "aa", "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec", "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707", "type" : "COMPUTE", "protocol" : "any", "internal_service_port" : "0", "transit_service_port" : "0", "private_ip_address" : "192.168.1.72", "created_at" : "2019-04-29T07:10:01", "updated_at" : "2019-04-29T07:10:01" }, { "id" : "25dcdb21-97de-43cd-b476-31637a47f05d", "project_id" : "da261828016849188f4dcc2ef94d9da9", "description" : "aa", "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec", "transit_ip_id" : "15abdf29-4a68-474c-9963-79c4e6d495d7", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "network_interface_id" : "9e2f0dbb-68b2-4c4b-9298-fa4f13187976", "type" : "COMPUTE", "protocol" : "any", "internal_service_port" : "0", "transit_service_port" : "0", "private_ip_address" : "192.168.1.99", "created_at" : "2019-04-29T07:15:41", "updated_at" : "2019-04-29T07:15:41" } ], "request_id" : "a7b00469-5a31-4274-bb10-59167243383e", "page_info" : { "previous_marker" : "14338426-6afe-4019-996b-018008113013", "current_count" : 2 }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dnat_rules Array of PrivateDnat objects 查询DNAT规则列表的响应体。 request_id String 请求ID。 最小长度：1 最大长度：36 page_info PageInfo object 分页信息。 表5 PrivateDnat 参数 参数类型 描述 id String DNAT规则的ID。 最小长度：36 最大长度：36 project_id String 项目的ID。 最小长度：36 最大长度：36 description String DNAT规则的描述。 最小长度：1 最大长度：36 transit_ip_id String 中转IP的ID。 最小长度：36 最大长度：36 gateway_id String 私网NAT网关实例的ID。 最小长度：1 最大长度：36 network_interface_id String 网络接口ID，支持计算、ELB、VIP等实例的端口。 最小长度：1 最大长度：36 type String DNAT规则后端的类型。 取值： COMPUTE：后端为计算实例。 VIP：后端为VIP的实例。 ELB：后端为ELB的实例。 ELBv3：后端为ELBv3的实例。 CUSTOMIZE：后端为自定义IP。 最小长度：1 最大长度：10 protocol String 协议类型。 目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。 最小长度：1 最大长度：3 枚举值： tcp udp any private_ip_address String 后端实例的私网IP地址。 最小长度：7 最大长度：15 internal_service_port String 后端实例的端口号。 最小值：0 最大值：65535 最小长度：1 最大长度：5 transit_service_port String 中转IP的端口号。 最小值：0 最大值：65535 最小长度：1 最大长度：5 enterprise_project_id String 企业项目ID。创建DNAT规则时，关联的企业项目ID。 最小长度：1 最大长度：36 created_at String DNAT规则的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 最小长度：1 最大长度：36 updated_at String DNAT规则的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 最小长度：1 最大长度：36 表6 PageInfo 参数 参数类型 描述 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 最小长度：1 最大长度：36 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 最小长度：1 最大长度：36 current_count Integer 分页查询资源时，本页的实例的个数。 最小值：1 最大值：2000

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 gateways Array of PrivateNat objects 查询私网NAT网关实例列表的响应体。 详见PrivateNat字段说明。 request_id String 请求ID。 最小长度：1 最大长度：36 page_info PageInfo object 分页信息。 表5 PrivateNat 参数 参数类型 描述 id String 私网NAT网关实例的ID。 最小长度：36 最大长度：36 project_id String 项目的ID。 最小长度：32 最大长度：32 name String 私网NAT网关实例的名字。 最小长度：1 最大长度：64 description String 私网NAT网关实例的描述。 最小长度：0 最大长度：255 spec String 私网NAT网关实例的规格。 取值为： "Small"：小型 "Medium"：中型 "Large"：大型 "Extra-large"：超大型 缺省值：Small 枚举值： Small Medium Large Extra-large status String 私网NAT网关实例的状态。 取值为： "ACTIVE"：正常运行 "FROZEN"：冻结 枚举值： ACTIVE FROZEN created_at String 私网NAT网关实例的创建时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 updated_at String 私网NAT网关实例的更新时间，遵循UTC时间，格式是yyyy-mm-ddThh:mm:ssZ。 downlink_vpcs Array of DownlinkVpc objects 私网NAT网关实例所属的VPC实例。 tags Array of Tag objects 标签列表。 enterprise_project_id String 企业项目ID。 创建私网NAT网关实例时，关联的企业项目ID。 最小长度：1 最大长度：36 表6 DownlinkVpc 参数 参数类型 描述 vpc_id String 私网NAT网关实例所属VPC的ID。 最小长度：36 最大长度：36 virsubnet_id String 私网NAT网关实例所属子网的ID。 最小长度：36 最大长度：36 表7 Tag 参数 参数类型 描述 key String 标签key值。 最小长度：1 最大长度：128 value String 标签value。 最小长度：0 最大长度：255 表8 PageInfo 参数 参数类型 描述 next_marker String 分页查询结果中最后一条记录的ID。通常用于查询下一页。 最小长度：1 最大长度：36 previous_marker String 分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。 最小长度：1 最大长度：36 current_count Integer 分页查询资源时，本页的实例的个数。 最小值：1 最大值：2000

响应示例 状态码： 200 查询私网NAT网关实例列表成功 { "gateways" : [ { "id" : "14338426-6afe-4019-996b-3a9525296e11", "name" : "private-nat-gateway-name1", "description" : "private-nat-gateway-description1", "spec" : "Small", "project_id" : "70505c941b9b4dfd82fd351932328a2f", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "status" : "ACTIVE", "created_at" : "2019-04-22T08:47:13", "updated_at" : "2019-04-22T08:47:13", "tags" : [ { "key" : "key1", "value" : "value1" } ], "downlink_vpcs" : [ { "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2", "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70" } ] }, { "id" : "65995b8e-dcb7-4ab4-9931-bc3c95beec0a", "name" : "private-nat-gateway-name2", "description" : "private-nat-gateway-description2", "spec" : "Small", "project_id" : "70505c941b9b4dfd82fd351932328a2f", "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a", "status" : "ACTIVE", "created_at" : "2019-04-22T09:06:54", "updated_at" : "2019-04-22T09:06:54", "tags" : [ { "key" : "key1", "value" : "value1" } ], "downlink_vpcs" : [ { "vpc_id" : "3cb66d44-9f75-4237-bfff-e37b14d23ad2", "virsubnet_id" : "373979ee-f4f0-46c5-80e3-0fbf72646b70" } ] } ], "request_id" : "a7b00469-5a31-4274-bb10-59167243383e", "page_info" : { "previous_marker" : "14338426-6afe-4019-996b-3a9525296e11", "current_count" : 2 }}

响应示例 状态码： 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"}