查询DNAT规则列表

功能介绍

查询DNAT规则列表。

接口约束

可以在URI后面用'?'和'&'添加不同的查询条件组合，支持参数说明中所有非必选参数过滤，请参考请求样例。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/dnat_rules

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目的ID。最小长度：1 最大长度：36

表2 Query参数
参数	是否必选	参数类型	描述
admin_state_up	否	Boolean	解冻/冻结状态。取值范围： "true"：解冻 "false"：冻结
external_service_port	否	Integer	Floatingip对外提供服务的端口号。取值范围：0~65535。最小值：0 最大值：65535 最小长度：1 最大长度：5
floating_ip_address	否	String	弹性公网的IP地址。最小长度：7 最大长度：15
status	否	Array	DNAT规则的状态。取值为： "ACTIVE": 可用 "PENDING_CREATE"：创建中 "PENDING_UPDATE"：更新中 "PENDING_DELETE"：删除中 "EIP_FREEZED"：EIP冻结 "INACTIVE"：不可用数组长度：1 - 10 枚举值： ACTIVE PENDING_CREATE PENDING_UPDATE PENDING_DELETE EIP_FREEZED INACTIVE
floating_ip_id	否	String	弹性公网IP的id。最小长度：36 最大长度：36
internal_service_port	否	Integer	虚拟机或者裸机对外提供服务的协议端口号。取值范围：0~65535。最小值：0 最大值：65535 最小长度：1 最大长度：5
limit	否	Integer	功能说明：每页返回的个数。取值范围：0~2000。默认值：2000。最小值：1 最大值：2000 缺省值：2000
id	否	String	DNAT规则的ID。最小长度：1 最大长度：36
description	否	String	DNAT规则的描述，长度范围小于等于255个字符，不能包含“<”和“>”。最小长度：0 最大长度：255
created_at	否	String	DNAT规则的创建时间，格式是yyyy-mm-dd hh:mm:ss.SSSSSS。最小长度：1 最大长度：36
nat_gateway_id	否	Array	公网NAT网关实例的ID。数组长度：1 - 10
port_id	否	String	虚拟机或者裸机的Port ID，对应虚拟私有云场景，与private_ip参数二选一。最小长度：36 最大长度：36
private_ip	否	String	用户私有IP地址，对应专线、云连接场景，与port_id参数二选一。最小长度：7 最大长度：15
protocol	否	Array	协议类型，目前支持TCP/tcp、UDP/udp、ANY/any。对应协议号6、17、0。数组长度：1 - 10
marker	否	String	分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。若不传入marker和limit参数，查询结果返回第一页全部资源记录（默认2000条）。若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的资源记录（默认2000条）。最小值：36 最大值：36

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。最小长度：1 最大长度：10240

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
dnat_rules	Array of NatGatewayDnatRuleResponseBody objects	查询DNAT规则列表的响应体。数组长度：0 - 2000

表5 NatGatewayDnatRuleResponseBody
参数	参数类型	描述
id	String	DNAT规则的ID。最小长度：36 最大长度：36
tenant_id	String	项目的ID。最小长度：1 最大长度：36
description	String	DNAT规则的描述。长度范围小于等于255个字符，不能包含“<”和“>”。最小长度：0 最大长度：255
port_id	String	虚拟机或者裸机的Port ID，对应虚拟私有云场景，与private_ip参数二选一。最小长度：36 最大长度：36
private_ip	String	用户私有IP地址，对应专线、云连接场景，与port_id参数二选一。最小长度：7 最大长度：15
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地址。最小长度：7 最大长度：15
external_service_port	Integer	Floatingip对外提供服务的端口号。取值范围：0~65535。
status	String	DNAT规则的状态。取值为： "ACTIVE": 可用 "PENDING_CREATE"：创建中 "PENDING_UPDATE"：更新中 "PENDING_DELETE"：删除中 "EIP_FREEZED"：EIP冻结 "INACTIVE"：不可用枚举值： 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规则的创建时间，格式是yyyy-mm-dd hh:mm:ss.SSSSSS。最小长度：1 最大长度：36
global_eip_id	String	全域弹性公网IP的id。最小长度：36 最大长度：36
global_eip_address	String	全域弹性公网IP的地址。最小长度：7 最大长度：15

请求示例

GET https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526d/dnat_rules?limit=2

响应示例

状态码： 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	查询DNAT规则列表成功。

错误码

请参见错误码。

父主题： DNAT规则

上一篇：DNAT规则

下一篇：创建DNAT规则

查询DNAT规则列表

功能介绍

接口约束

调用方法

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

您对此文档页面的整体评价？