NAT网关

NAT

查询NAT网关列表

功能介绍

‎查询NAT网关列表

URI

GET /v2.0/nats

请求消息

参数	参数类型	是否必选	描述
name	string	否	根据NAT网关名称过滤列表结果。
id	string	否	根据NAT网关ID过滤列表结果。
description	string	否	根据NAT网关描述过滤列表结果。
enabled	string	否	根据NAT网关是否启用过滤列表结果。
project_id	string	否	根据NAT网关所属项目的项目ID过滤列表l结果。
router_id	string	否	根据NAT网关关联的路由器的ID过滤列表结果。
fields	string	否	希望服务器返回的字段。如果不指定字段查询参数，则网络API返回策略设置允许的所有属性。通过使用fields参数，API只返回所请求的属性集。Fields参数可以指定多次。例如，如果在请求URL中指定fields=id&fields=name，则只返回id和name属性。

响应消息

参数	参数类型	描述
nats	[object]	NAT网关对象列表。
id	string	NAT网关ID。
name	string	NAT网关名称。
project_id	string	NAT网关所属项目ID。
router_id	string	NAT网关关联的路由ID。
enabled	boolean	NAT网关是否启用。
description	string	NAT网关描述。
has_rules	boolean	NAT网关中是否包含规则。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	NAT网关所属项目ID。

请求示例

GET http://{endpoint}/v2.0/nats

正常响应示例

{
  "nats": [
    {
      "id": "b4062829-b3ec-4103-a6d2-175e62f3b2c7",
      "name": "test_nat",
      "project_id": "a2086024e2ba4dd4b3e804fd3829e8af",
      "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
      "enabled": true,
      "description": "Test NAT API",
      "has_rules": true,
      "revision_number": 0,
      "created_at": "2024-04-26T06:19:56Z",
      "updated_at": "2024-04-26T06:19:56Z",
      "tenant_id": "a2086024e2ba4dd4b3e804fd3829e8af"
    }
  ]
}

正常响应代码

200

错误码

401, 403

创建NAT网关

功能介绍

‎创建NAT网关

URI

POST /v2.0/nats

请求消息

参数	参数类型	是否必选	描述
nat	object	是	NAT网关对象。
name	string	否	NAT名称。
description	string	否	NAT描述。
router_id	string	是	与NAT网关关联的路由器。
enabled	boolean	否	NAT是否启用。

响应消息

参数	参数类型	描述
nat	object	NAT网关对象。
id	string	NAT网关ID。
name	string	NAT网关名称。
project_id	string	NAT网关所属项目ID。
router_id	string	NAT网关关联的路由ID。
enabled	boolean	NAT网关是否启用。
description	string	NAT网关描述。
has_rules	boolean	NAT网关中是否包含规则。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	NAT网关所属项目ID。

请求示例

POST http://{endpoint}/v2.0/nats

{
  "nat": {
    "name": "hello",
    "description": "A NAT.",
    "router_id": "0a280e0f-ce93-4f68-b8f7-b819e812a39a",
    "enabled": true
  }
}

正常响应示例

{
  "nat": {
    "id": "f8711ad9-b6ea-4dd6-98b1-b65d3cf6aa89",
    "name": "test_nat",
    "tenant_id": "dff8006950c146caad161dd0ba545764",
    "enabled": true,
    "description": "A NAT.",
    "has_rules": false,
    "router_id": "0a280e0f-ce93-4f68-b8f7-b819e812a39a",
    "created_at": "2023-11-28T06:10:33Z",
    "updated_at": "2023-11-28T06:10:33Z",
    "revision_number": 0,
    "project_id": "dff8006950c146caad161dd0ba545764"
  }
}

正常响应代码

201

错误码

401, 403

查询NAT网关详情

功能介绍

‎查询NAT网关详情

URI

GET /v2.0/nats/{nat_id}

参数	参数类型	是否必选	描述
nat_id	string	是	获取详情的NAT网关ID。

请求消息

参数	参数类型	是否必选	描述
fields	string	否	希望服务器返回的字段。如果不指定字段查询参数，则网络API返回策略设置允许的所有属性。通过使用fields参数，API只返回所请求的属性集。Fields参数可以指定多次。例如，如果在请求URL中指定fields=id&fields=name，则只返回id和name属性。

响应消息

参数	参数类型	描述
nat	object	NAT网关对象。
id	string	NAT网关ID。
name	string	NAT网关名称。
project_id	string	NAT网关所属项目ID。
router_id	string	NAT网关关联的路由ID。
enabled	boolean	NAT网关是否启用。
description	string	NAT网关描述。
has_rules	boolean	NAT网关中是否包含规则。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	NAT网关所属项目ID。

请求示例

GET http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf

正常响应示例

{
  "nat": {
    "id": "e7d9b5e1-0431-4eac-802d-f0764c8e5faf",
    "name": "errrrr11",
    "project_id": "31152673f0684baf82d1978b8bb93adc",
    "router_id": "33088652-bf97-41bd-b74a-e62b21e4c643",
    "enabled": true,
    "description": "2222200",
    "has_rules": false,
    "revision_number": 21,
    "created_at": "2023-11-15T09:26:39Z",
    "updated_at": "2023-11-22T03:32:19Z",
    "tenant_id": "31152673f0684baf82d1978b8bb93adc"
  }
}

正常响应代码

200

错误码

401, 403, 404

删除NAT网关

功能介绍

‎删除NAT网关

URI

DELETE /v2.0/nats/{nat_id}

参数	参数类型	是否必选	描述
nat_id	string	是	需要删除的NAT网关ID。

请求消息

无

响应消息

无

请求示例

DELETE http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf

正常响应示例

无

正常响应代码

204

错误码

401, 403, 404

更新NAT网关

功能介绍

‎更新NAT网关

URI

PUT /v2.0/nats/{nat_id}

参数	参数类型	是否必选	描述
nat_id	string	是	需要更新的NAT网关ID。

请求消息

参数	参数类型	是否必选	描述
name	string	否	NAT网关名称。
description	string	否	NAT网关描述。
enabled	boolean	否	NAT网关是否启用。

响应消息

参数	参数类型	描述
nat	object	NAT网关对象。
id	string	NAT网关ID。
name	string	NAT网关名称。
project_id	string	NAT网关所属项目ID。
router_id	string	NAT网关关联的路由ID。
enabled	boolean	NAT网关是否启用。
description	string	NAT网关描述。
has_rules	boolean	NAT网关中是否包含规则。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	NAT网关所属项目ID。

请求示例

PUT http://{endpoint}/v2.0/nats/cdb28ce6-4d7f-4214-b848-c76239db9e69

{
  "nat": {
    "name": "test_nat",
    "description": "A NAT.",
    "enabled": true
  }
}

正常响应示例

{
  "nat": {
    "id": "cdb28ce6-4d7f-4214-b848-c76239db9e69",
    "name": "test_nat",
    "project_id": "dff8006950c146caad161dd0ba545764",
    "router_id": "0a280e0f-ce93-4f68-b8f7-b819e812a39a",
    "enabled": true,
    "description": "A NAT.",
    "has_rules": false,
    "revision_number": 4,
    "created_at": "2023-11-28T06:13:19Z",
    "updated_at": "2023-11-28T06:25:49Z",
    "tenant_id": "dff8006950c146caad161dd0ba545764"
  }
}

正常响应代码

200

错误码

401, 403, 404

SNAT

查询SNAT规则列表

功能介绍

‎查询SNAT规则列表

URI

GET /v2.0/nats/{nat_id}/snat_rules

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。

请求消息

参数	参数类型	是否必选	描述
id	string	否	根据SNAT规则的ID过滤列表。
floatingip_id	string	否	根据FloatingIP的ID过滤列表。
internal_cidr	string	否	根据CIDR过滤列表。
enabled	string	否	根据SNAT规则是否启用过滤列表。
project_id	string	否	根据SNAT规则所属的项目ID过滤列表。
description	string	否	根据SNAT规则的描述过滤列表。
fields	string	否	希望服务器返回的字段。如果不指定字段查询参数，则网络API返回策略设置允许的所有属性。通过使用fields参数，API只返回所请求的属性集。Fields参数可以指定多次。例如，如果在请求URL中指定fields=id&fields=name，则只返回id和name属性。

响应消息

参数	参数类型	描述
snat_rules	[object]	[SNAT对象。]
id	string	SNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
internal_cidr	string	SNAT规则适用于CIDR地址，CIDR掩码长度越长，优先级越高。
enabled	boolean	资源是否启用。
project_id	string	资源所属的项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	资源所属的项目ID。

请求示例

GET http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/snat_rules

正常响应示例

{
    "snat_rules": [
        {
            "id": "59eda16d-8a17-4fe8-a00e-015ff22e65e9",
            "floatingip_id": "d67bc2a5-d64f-423a-8cc0-230a42216aa5",
            "internal_cidr": "192.168.3.0/24",
            "enabled": true,
            "project_id": "31152673f0684baf82d1978b8bb93adc",
            "description": "w121w33333",
            "revision_number": 11,
            "external_ip_address": "172.16.10.21",
            "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
            "created_at": "2023-11-16T03:05:04Z",
            "updated_at": "2023-11-28T12:28:50Z",
            "tenant_id": "31152673f0684baf82d1978b8bb93adc"
        },
        {
            "id": "660815c2-db00-40eb-acb4-6385029bcfe5",
            "internal_cidr": "192.168.34.0/25",
            "enabled": true,
            "project_id": "dff8006950c146caad161dd0ba545764",
            "description": "A snat rule.",
            "revision_number": 0,
            "external_ip_address": "172.16.10.21",
            "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
            "created_at": "2023-11-28T11:59:49Z",
            "updated_at": "2023-11-28T11:59:49Z",
            "tenant_id": "dff8006950c146caad161dd0ba545764"
        }
    ]
}

正常响应代码

200

错误码

401, 403, 404

创建SNAT规则

功能介绍

‎创建SNAT规则

URI

POST /v2.0/nats/{nat_id}/snat_rules

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID

请求消息

参数	参数类型	是否必选	描述
snat_rule	object	是	SNAT规则对象。
floating_ip	string¦null	是	公网IP的ID，为空时代表使用该路由器的外部IP。
internal_cidr	string	是	此SNAT规则适用的CIDR，掩码长度越高优先级越高。
enabled	boolean	是	是否启用该SNAT规则。
description	string	是	SNAT规则的描述。

响应消息

参数	参数类型	描述
snat_rule	object	SNAT规则对象
id	string	SNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
internal_cidr	string	SNAT规则适用于CIDR地址，CIDR掩码长度越长，优先级越高。
enabled	boolean	资源是否启用。
project_id	string	资源所属的项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	资源所属的项目ID。

请求示例

POST http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/snat_rules

{
    "snat_rule": {
        "floating_ip": null,
        "internal_cidr": "192.168.34.0/25",
        "enabled": true,
        "description": "A snat rule."
    }
}

正常响应示例

{
  "snat_rule": {
    "id": "660815c2-db00-40eb-acb4-6385029bcfe5",
    "floatingip_id": null,
    "internal_cidr": "192.168.34.0/25",
    "enabled": true,
    "project_id": "dff8006950c146caad161dd0ba545764",
    "external_ip_address": "172.16.10.21",
    "description": "A snat rule.",
    "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
    "revision_number": 0,
    "created_at": "2023-11-28T11:59:49Z",
    "updated_at": "2023-11-28T11:59:49Z",
    "tenant_id": "dff8006950c146caad161dd0ba545764"
  }
}

正常响应代码

201

错误码

401, 403, 404

查询SNAT规则详情

功能介绍

‎查询SNAT规则详情

URI

GET /v2.0/nats/{nat_id}/snat_rules/{snat_rule_id}

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID
snat_rule_id	string	是	获取详情的SNAT规则ID

请求消息

参数	参数类型	是否必选	描述
fields	string	否	希望服务器返回的字段。如果不指定字段查询参数，则网络API返回策略设置允许的所有属性。通过使用fields参数，API只返回所请求的属性集。Fields参数可以指定多次。例如，如果在请求URL中指定fields=id&fields=name，则只返回id和name属性。

响应消息

参数	参数类型	描述
snat_rule	object	SNAT对象。
id	string	SNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
internal_cidr	string	SNAT规则适用于CIDR地址，CIDR掩码长度越长，优先级越高。
enabled	boolean	资源是否启用。
project_id	string	资源所属的项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	资源所属的项目ID。

请求示例

GET http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/snat_rules/660815c2-db00-40eb-acb4-6385029bcfe5

正常响应示例

{
    "snat_rule": {
        "id": "660815c2-db00-40eb-acb4-6385029bcfe5",
        "floatingip_id": "ff3b2ad0-ca22-4955-87d6-2d2d27f78568",
        "internal_cidr": "192.168.34.0/25",
        "enabled": true,
        "project_id": "dff8006950c146caad161dd0ba545764",
        "external_ip_address": "172.16.10.21",
        "description": "A snat rule.",
        "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
        "revision_number": 0,
        "created_at": "2023-11-28T11:59:49Z",
        "updated_at": "2023-11-28T11:59:49Z",
        "tenant_id": "dff8006950c146caad161dd0ba545764"
    }
}

正常响应代码

200

错误码

401, 403, 404

删除SNAT规则

功能介绍

‎删除SNAT规则

URI

DELETE /v2.0/nats/{nat_id}/snat_rules/{snat_rule_id}

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。
snat_rule_id	string	是	需要删除的SNAT规则ID。

请求消息

无

响应消息

无

请求示例

DELETE http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/snat_rules/660815c2-db00-40eb-acb4-6385029bcfe5

正常响应示例

无

正常响应代码

204

错误码

401, 403, 404

更新SNAT规则

功能介绍

‎更新SNAT规则

URI

PUT /v2.0/nats/{nat_id}/snat_rules/{snat_rule_id}

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。
snat_rule_id	string	是	需要更新的SNAT规则ID。

请求消息

参数	参数类型	是否必选	描述
snat_rule	object	是	SNAT规则对象。
enabled	boolean	否	是否启用该SNAT规则。
description	string	否	SNAT规则的描述。

响应消息

参数	参数类型	描述
snat_rule	object	SNAT对象。
id	string	SNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
internal_cidr	string	SNAT规则适用于CIDR地址，CIDR掩码长度越长，优先级越高。
enabled	boolean	资源是否启用。
project_id	string	资源所属的项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	资源所属的项目ID。

请求示例

PUT http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/snat_rules/660815c2-db00-40eb-acb4-6385029bcfe5

{
  "snat_rule": {
    "enabled": false,
    "description": "disabled"
  }
}

正常响应示例

{
  "snat_rule": {
    "id": "660815c2-db00-40eb-acb4-6385029bcfe5",
    "floatingip_id": "ff3b2ad0-ca22-4955-87d6-2d2d27f78568",
    "internal_cidr": "192.168.34.0/25",
    "enabled": false,
    "project_id": "dff8006950c146caad161dd0ba545764",
    "external_ip_address": "172.16.10.21",
    "description": "321",
    "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
    "revision_number": 1,
    "created_at": "2023-11-28T11:59:49Z",
    "updated_at": "2023-12-04T03:19:57Z",
    "tenant_id": "dff8006950c146caad161dd0ba545764"
  }
}

正常响应代码

200

错误码

401, 403, 404

DNAT

查询DNAT规则列表

功能介绍

‎查询DNAT规则列表

URI

GET /v2.0/nats/{nat_id}/dnat_rules

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID

请求消息

参数	参数类型	是否必选	描述
id	string	否	根据DNAT规则的ID过滤列表。
floatingip_id	string	否	根据FloatingIP的ID过滤列表。
external_port	string	否	根据外部端口过滤列表。
protocol	string	否	根据协议过滤列表。当前仅支持TCP/UDP两种协议。
enabled	string	否	根据DNAT规则是否启用过滤列表。
project_id	string	否	根据DNAT规则所属的项目ID过滤列表。
description	string	否	根据DNAT规则的描述过滤列表。
fields	string	否	希望服务器返回的字段。如果不指定字段查询参数，则网络API返回策略设置允许的所有属性。通过使用fields参数，API只返回所请求的属性集。Fields参数可以指定多次。例如，如果在请求URL中指定fields=id&fields=name，则只返回id和name属性。

响应消息

参数	参数类型	描述
dnat_rules	[object]	DNAT规则对象列表
id	string	DNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
external_port	integer	DNAT外部端口。
internal_ip_address	string	DNAT内部地址。
internal_port	integer	DNAT内部端口。
protocol	string	DNAT使用的协议，当前仅支持TCP/UDP两种协议。
enabled	boolean	资源是否启用。
project_id	string	所属项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	所属项目ID。

请求示例

GET http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/dnat_rules

正常响应示例

{
  "dnat_rules": [
    {
      "id": "3a2f8a65-9bd9-458d-ad9f-3c11562864a8",
      "floatingip_id": "16e2976f-aae4-462b-b302-ec8b6a327d90",
      "external_port": 80,
      "project_id": "31152673f0684baf82d1978b8bb93adc",
      "protocol": "tcp",
      "internal_ip_address": "192.168.188.31",
      "internal_port": 80,
      "external_ip_address": "172.16.10.21",
      "enabled": true,
      "description": "A dnat rule.",
      "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
      "revision_number": 2,
      "created_at": "2023-11-22T02:40:32Z",
      "updated_at": "2023-11-29T02:55:44Z",
      "tenant_id": "31152673f0684baf82d1978b8bb93adc"
    },
    {
      "id": "9f1d13fe-cebc-439c-acf6-79f8885c43b9",
      "external_port": 99,
      "project_id": "dff8006950c146caad161dd0ba545764",
      "protocol": "udp",
      "internal_ip_address": "192.168.33.58",
      "internal_port": 99,
      "external_ip_address": "172.16.10.21",
      "enabled": true,
      "description": "A dnat rule.",
      "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
      "revision_number": 0,
      "created_at": "2023-11-29T03:13:31Z",
      "updated_at": "2023-11-29T03:13:31Z",
      "tenant_id": "dff8006950c146caad161dd0ba545764"
    }
  ]
}

正常响应代码

200

错误码

401, 403, 404

创建DNAT规则

功能介绍

‎创建DNAT规则

URI

POST /v2.0/nats/{nat_id}/dnat_rules

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。

请求消息

参数	参数类型	是否必选	描述
dnat_rule	object	是	DNAT规则对象。
floatingip_id	string¦null	是	公网IP的ID，为空时代表使用该路由器的外部IP。
external_port	integer	是	DNAT规则的外部端口。
internal_ip_address	string	是	DNAT规则的内部地址。
internal_port	integer	是	DNAT规则的内部端口。
protocol	string	是	DNAT使用的协议，当前仅支持TCP/UDP两种协议。
enabled	boolean	是	是否启用该DNAT规则。
description	string	是	DNAT规则的描述。

响应消息

参数	参数类型	描述
dnat_rule	object	dnat规则对象
id	string	DNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
external_port	integer	DNAT外部端口。
internal_ip_address	string	DNAT内部地址。
internal_port	integer	DNAT内部端口。
protocol	string	DNAT使用的协议，当前仅支持TCP/UDP两种协议。
enabled	boolean	资源是否启用。
project_id	string	所属项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	所属项目ID。

请求示例

POST http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/dnat_rules

{
  "dnat_rule": {
    "floatingip_id": "ff3b2ad0-ca22-4955-87d6-2d2d27f78568",
    "external_port": 39,
    "internal_ip_address": "192.168.33.58",
    "internal_port": 66,
    "protocol": "tcp",
    "enabled": true,
    "description": ""
  }
}

正常响应示例

{
  "dnat_rule": {
    "id": "a424ed3a-6d99-4070-b4d8-3d567ed0ef12",
    "floatingip_id": "ff3b2ad0-ca22-4955-87d6-2d2d27f78568",
    "external_port": 39,
    "project_id": "dff8006950c146caad161dd0ba545764",
    "protocol": "tcp",
    "internal_ip_address": "192.168.33.58",
    "internal_port": 66,
    "external_ip_address": "172.16.10.21",
    "enabled": true,
    "description": "",
    "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
    "revision_number": 0,
    "created_at": "2023-11-29T03:03:59Z",
    "updated_at": "2023-11-29T03:03:59Z",
    "tenant_id": "dff8006950c146caad161dd0ba545764"
  }
}

正常响应代码

201

错误码

401, 403, 404

查询DNAT规则详情

功能介绍

‎查询DNAT规则详情

URI

GET /v2.0/nats/{nat_id}/dnat_rules/{dnat_rule_id}

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。
dnat_rule_id	string	是	需要更新的DNAT规则ID。

请求消息

参数	参数类型	是否必选	描述
fields	string	否	希望服务器返回的字段。如果不指定字段查询参数，则网络API返回策略设置允许的所有属性。通过使用fields参数，API只返回所请求的属性集。Fields参数可以指定多次。例如，如果在请求URL中指定fields=id&fields=name，则只返回id和name属性。

响应消息

参数	参数类型	描述
dnat_rule	object	dnat规则对象
id	string	DNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
external_port	integer	DNAT外部端口。
internal_ip_address	string	DNAT内部地址。
internal_port	integer	DNAT内部端口。
protocol	string	DNAT使用的协议，当前仅支持TCP/UDP两种协议。
enabled	boolean	资源是否启用。
project_id	string	所属项目ID。
external_ip_address	string	资源绑定的外部IP地址，如果floatingip_id为空则显示路由器网关的外部地址，否则显示公网地址。
router_id	string	资源关联的路由ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	所属项目ID。

请求示例

GET http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/dnat_rules/3a2f8a65-9bd9-458d-ad9f-3c11562864a8

正常响应示例

{
  "dnat_rule": {
    "id": "3a2f8a65-9bd9-458d-ad9f-3c11562864a8",
    "floatingip_id": "16e2976f-aae4-462b-b302-ec8b6a327d90",
    "external_port": 80,
    "project_id": "31152673f0684baf82d1978b8bb93adc",
    "protocol": "tcp",
    "internal_ip_address": "192.168.188.31",
    "internal_port": 80,
    "external_ip_address": "172.16.10.21",
    "enabled": true,
    "description": "",
    "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
    "revision_number": 0,
    "created_at": "2023-11-22T02:40:32Z",
    "updated_at": "2023-11-22T02:40:32Z",
    "tenant_id": "31152673f0684baf82d1978b8bb93adc"
  }
}

正常响应代码

200

错误码

401, 403, 404

删除DNAT规则

功能介绍

‎删除DNAT规则

URI

DELETE /v2.0/nats/{nat_id}/dnat_rules/{dnat_rule_id}

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。
dnat_rule_id	string	是	需要删除的DNAT规则ID。

请求消息

无

响应消息

无

请求示例

DELETE http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/dnat_rules/3a2f8a65-9bd9-458d-ad9f-3c11562864a8

正常响应示例

无

正常响应代码

204

错误码

401, 403, 404

更新DNAT规则

功能介绍

‎更新DNAT规则

URI

PUT /v2.0/nats/{nat_id}/dnat_rules/{dnat_rule_id}

参数	参数类型	是否必选	描述
nat_id	string	是	NAT网关ID。
dnat_rule_id	string	是	需要更新的DNAT规则ID。

请求消息

参数	参数类型	是否必选	描述
dnat_rule	object	是	DNAT规则对象。
enabled	boolean	否	是否启用该DNAT规则。
description	string	否	DNAT规则的描述。

响应消息

参数	参数类型	描述
dnat_rule	object	dnat规则对象。
id	string	DNAT规则ID。
floatingip_id	string¦null	公网地址ID，如果为空则代表使用路由器网关的外部地址。
external_port	integer	DNAT外部端口。
internal_ip_address	string	DNAT内部地址。
internal_port	integer	DNAT内部端口。
protocol	string	DNAT使用的协议，当前仅支持TCP/UDP两种协议。
enabled	boolean	资源是否启用。
project_id	string	所属项目ID。
description	string	资源的描述。
revision_number	integer	资源的版本号。
created_at	string	创建时间。
updated_at	string	更新时间。
tenant_id	string	所属项目ID。

请求示例

PUT http://{endpoint}/v2.0/nats/e7d9b5e1-0431-4eac-802d-f0764c8e5faf/dnat_rules/3a2f8a65-9bd9-458d-ad9f-3c11562864a8

{
  "dnat_rule": {
    "enabled": false,
    "description": "A dnat rule."
  }
}

正常响应示例

{
  "dnat_rule": {
    "id": "3a2f8a65-9bd9-458d-ad9f-3c11562864a8",
    "floatingip_id": "16e2976f-aae4-462b-b302-ec8b6a327d90",
    "external_port": 80,
    "project_id": "31152673f0684baf82d1978b8bb93adc",
    "protocol": "tcp",
    "internal_ip_address": "192.168.188.31",
    "internal_port": 80,
    "external_ip_address": "172.16.10.21",
    "enabled": false,
    "description": "A dnat rule.",
    "router_id": "9335f398-25d6-411c-a3d9-8773d04c37c7",
    "revision_number": 2,
    "created_at": "2023-11-22T02:40:32Z",
    "updated_at": "2023-11-29T02:55:44Z",
    "tenant_id": "31152673f0684baf82d1978b8bb93adc"
  }
}

正常响应代码

200

错误码

401, 403