创建SNAT规则CreatePrivateSnat
接口说明
创建SNAT规则。
约束说明
创建规则时,要求网关状态status = "ACTIVE"。
URL
POST https://nat.cn-north-4.myhuaweicloud.com/v3/{project_id}/private-nat/snat-rules
请求参数
| 名称 | 类型 | IN | 必选 | 描述 |
|---|---|---|---|---|
|
X-Auth-Token
|
string | header | 是 |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
|
project_id
|
string | path | 是 |
项目的ID。 |
Body参数
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
snat_rule
|
CreatePrivateSnatOption object | 是 |
创建SNAT规则的请求体。 |
参数：
snat_rule
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
gateway_id
|
string | 是 |
私网NAT网关 实例的ID。 |
|
cidr
|
string | 否 |
功能说明:规则匹配的CIDR。取值约束:与virsubnet_id参数二选一。 |
|
virsubnet_id
|
string | 否 |
功能说明:规则匹配的子网的ID。 取值约束:与cidr参数二选一。 |
|
description
|
string | 否 |
SNAT规则的描述。 |
|
transit_ip_ids
|
Array of strings | 是 |
功能说明:中转IP的ID的列表。 取值约束:中转IP的ID个数不能超过1个。 |
返回参数
返回码: 201
创建SNAT规则成功。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
snat_rule
|
PrivateSnat object | 否 |
SNAT规则的响应体。 |
|
request_id
|
string | 否 |
请求ID。 |
201 snat_rule
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
id
|
string | 否 |
SNAT规则的ID。 |
|
project_id
|
string | 否 |
项目的ID。 |
|
gateway_id
|
string | 否 |
私网 NAT网关 实例的ID。 |
|
cidr
|
string | 否 |
功能说明:规则匹配的CIDR。 取值约束:
|
|
virsubnet_id
|
string | 否 |
功能说明:规则匹配的子网的ID。 取值约束:与cidr参数二选一。 |
|
description
|
string | 否 |
SNAT规则的描述。 |
|
transit_ip_associations
|
Array of AssociatedTransitIp objects | 否 |
关联的中转IP详情列表。 |
|
created_at
|
string | 否 |
SNAT规则的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
|
updated_at
|
string | 否 |
SNAT规则的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。 |
|
ent erp rise_project_id
|
string | 否 |
企业项目id |
201 snat_rule.transit_ip_associations
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
|
transit_ip_id
|
string | 否 |
中转IP的ID。 |
|
transit_ip_address
|
string | 否 |
中转IP地址。 |
请求示例
示例 1
SNAT规则创建的请求体。
"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" ] } }
返回示例
返回码：201
创建SNAT规则成功。
示例 1
{
"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_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"
}
SDK
点击 NAT网关 (NAT) SDK, 下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。
错误码
请参考 错误码说明。
