文档首页/ NAT网关 NAT/ API参考/ API（公网NAT网关）/ SNAT规则/ 查询指定的SNAT规则详情
更新时间：2024-12-20 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询指定的SNAT规则详情

功能介绍

查询指定的SNAT规则详情。

接口约束

null

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/snat_rules/{snat_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目的ID。

snat_rule_id

是

String

SNAT规则的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用户Token也就是调用获取用户Token获取请求认证接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

snat_rule

NatGatewaySnatRuleResponseBody object

SNAT规则的响应体。
表4 NatGatewaySnatRuleResponseBody

参数

参数类型

描述

id

String

SNAT规则的ID。

tenant_id

String

项目的ID。

nat_gateway_id

String

公网NAT网关实例的ID。

cidr

String

cidr，可以是网段或者主机格式，与network_id参数二选一。

Source_type=0时，cidr必须是vpc 子网网段的子集(不能相等）;

Source_type=1时，cidr必须指定专线侧网段。

source_type

Integer

0: VPC侧，可以指定network_id 或者cidr

1: 专线侧，只能指定cidr

不输入默认为0（VPC）

floating_ip_id

String

功能说明: 弹性公网IP的id，多个弹性公网IP使用逗号分隔。

description

String

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

status

String

SNAT规则的状态。

取值为:

ACTIVE: 可用

PENDING_CREATE: 创建中

PENDING_UPDATE: 更新中

PENDING_DELETE: 删除中

EIP_FREEZED: EIP冻结

INACTIVE: 不可用

created_at

String

SNAT规则的创建时间，格式是yyyy-mm-dd hh:mm:ss.SSSSSS。

network_id

String

规则使用的网络id。与cidr参数二选一。

admin_state_up

Boolean

解冻/冻结状态。

取值范围:

  • true: 解冻

  • false: 冻结

floating_ip_address

String

功能说明: 弹性公网IP，多个弹性公网IP使用逗号分隔。

freezed_ip_address

String

功能说明: 冻结的弹性公网IP，多个冻结的弹性公网IP使用逗号分隔。

global_eip_id

String

全域弹性公网IP的id。

global_eip_address

String

全域弹性公网IP的地址。

请求示例

GET https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules/5b95c675-69c2-4656-ba06-58ff72e1d33

响应示例

状态码： 200

查询SNAT规则成功。

{
  "snat_rule" : {
    "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a",
    "status" : "ACTIVE",
    "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
    "admin_state_up" : true,
    "network_id" : "eaad9cd6-2372-4be1-9535-9bd37210ae7b",
    "source_type" : 0,
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526",
    "created_at" : "2017-11-18 07:54:21.665430",
    "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "floating_ip_address" : "5.21.11.226",
    "freezed_ip_address" : "",
    "description" : "my snat rule 01"
  }
}

状态码

状态码

描述

200

查询SNAT规则成功。

错误码

请参见错误码。

父主题： SNAT规则

相关文档