文档首页/ NAT网关 NAT/ API参考（安卡拉区域）/ API（私网NAT网关）/ DNAT规则/ 查询DNAT规则列表
更新时间：2024-04-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询DNAT规则列表

功能介绍

查询DNAT规则列表。

接口约束

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

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/private-nat/dnat-rules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

最小长度：1

最大长度：36
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

功能说明：每页返回的个数。 取值范围：0~2000。 默认值：2000。

最小值：1

最大值：2000

缺省值：2000

marker

否

String

功能说明：分页查询起始的资源ID，为空时查询第一页。 值从上一次查询的PageInfo中的next_marker或者previous_marker中获取。

最小长度：36

最大长度：36

page_reverse

否

Boolean

是否查询前一页。

id

否

Array

DNAT规则的ID。

数组长度：1 - 10

project_id

否

Array

项目的ID。

数组长度：1 - 10

enterprise_project_id

否

Array

企业项目ID。创建DNAT规则时，关联的企业项目ID。

数组长度：1 - 10

description

否

Array

DNAT规则的描述。长度范围小于等于255个字符，不能包含“<”和“>”。

数组长度：1 - 10

gateway_id

否

Array

私网NAT网关实例的ID。

数组长度：1 - 10

transit_ip_id

否

Array

中转IP的ID。

数组长度：1 - 10

external_ip_address

否

Array

中转IP的地址。

数组长度：1 - 10

network_interface_id

否

Array

网络接口ID，支持计算、ELB、VIP等实例的网络接口。

数组长度：1 - 10

type

否

Array

DNAT规则后端的类型。 取值： COMPUTE：后端为计算实例。 VIP：后端为VIP的实例。 ELB：后端为ELB的实例。 ELBv3：后端为ELBv3的实例。 CUSTOMIZE：后端为自定义IP。

数组长度：1 - 10

private_ip_address

否

Array

后端实例的IP私网地址。

数组长度：1 - 10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度：1

最大长度：10240

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

dnat_rules

Array of PrivateDnat objects

查询DNAT规则列表的响应体。

数组长度：0 - 2000

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规则的描述。长度范围小于等于255个字符，不能包含“<”和“>”。

最小长度：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

请求示例

GET https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules

响应示例

状态码： 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

查询DNAT规则列表成功。

错误码

请参见错误码。

父主题： DNAT规则