创建SNAT规则
功能介绍
创建SNAT规则。
接口约束
创建规则时,要求网关状态status = ACTIVE,要求网关管理员状态admin_state_up = True
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/snat_rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
snat_rule |
是 |
创建SNAT规则的请求体。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
nat_gateway_id |
是 |
String |
公网NAT网关实例的ID。 |
cidr |
否 |
String |
cidr,可以是网段或者主机格式,与network_id参数二选一。 Source_type=0时,cidr必须是vpc 子网网段的子集(不能相等); Source_type=1时,cidr必须指定专线侧网段。 |
network_id |
否 |
String |
规则使用的网络id。与cidr参数二选一。 |
description |
否 |
String |
SNAT规则的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 |
source_type |
否 |
Integer |
0: VPC侧,可以指定network_id 或者cidr 1: 专线侧,只能指定cidr 不输入默认为0(VPC) |
floating_ip_id |
是 |
String |
功能说明: 弹性公网IP的id,多个弹性公网IP使用逗号分隔。 约束: 弹性公网IP的id个数不能超过20个。 |
global_eip_id |
否 |
String |
全域弹性公网IP的id。 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
snat_rule |
创建SNAT规则的响应体。 |
参数 |
参数类型 |
描述 |
---|---|---|
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使用逗号分隔。 |
global_eip_id |
String |
功能说明:全域弹性公网IP的id,多个全域弹性公网IP使用逗号分隔,与弹性公网IP的id二选一。 取值范围:最大长度4096字节。 |
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 |
解冻/冻结状态。 取值范围:
|
floating_ip_address |
String |
功能说明: 弹性公网IP,多个弹性公网IP使用逗号分隔。 |
global_eip_address |
String |
全域弹性公网IP的地址。 |
请求示例
SNAT规则创建的请求体。
POST https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/snat_rules { "snat_rule" : { "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8", "cidr" : "172.30.0.0/24", "source_type" : 1, "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a", "description" : "my snat rule 01" } }
响应示例
状态码: 201
创建SNAT规则成功。
{ "snat_rule" : { "floating_ip_id" : "bdc10a4c-d81a-41ec-adf7-de857f7c812a", "status" : "PENDING_CREATE", "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8", "admin_state_up" : true, "cidr" : "172.30.0.0/24", "description" : "", "source_type" : 1, "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3", "created_at" : "2017-11-18 07:54:21.665430", "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338", "floating_ip_address" : "5.21.11.226" } }
SDK代码示例
SDK代码示例如下。
SNAT规则创建的请求体。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.nat.v2.region.NatRegion; import com.huaweicloud.sdk.nat.v2.*; import com.huaweicloud.sdk.nat.v2.model.*; public class CreateNatGatewaySnatRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); NatClient client = NatClient.newBuilder() .withCredential(auth) .withRegion(NatRegion.valueOf("<YOUR REGION>")) .build(); CreateNatGatewaySnatRuleRequest request = new CreateNatGatewaySnatRuleRequest(); CreateNatGatewaySnatRuleRequestOption body = new CreateNatGatewaySnatRuleRequestOption(); CreateNatGatewaySnatRuleOption snatRulebody = new CreateNatGatewaySnatRuleOption(); snatRulebody.withNatGatewayId("a78fb3eb-1654-4710-8742-3fc49d5f04f8") .withCidr("172.30.0.0/24") .withDescription("my snat rule 01") .withSourceType(1) .withFloatingIpId("bdc10a4c-d81a-41ec-adf7-de857f7c812a"); body.withSnatRule(snatRulebody); request.withBody(body); try { CreateNatGatewaySnatRuleResponse response = client.createNatGatewaySnatRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
SNAT规则创建的请求体。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdknat.v2.region.nat_region import NatRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdknat.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = NatClient.new_builder() \ .with_credentials(credentials) \ .with_region(NatRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateNatGatewaySnatRuleRequest() snatRulebody = CreateNatGatewaySnatRuleOption( nat_gateway_id="a78fb3eb-1654-4710-8742-3fc49d5f04f8", cidr="172.30.0.0/24", description="my snat rule 01", source_type=1, floating_ip_id="bdc10a4c-d81a-41ec-adf7-de857f7c812a" ) request.body = CreateNatGatewaySnatRuleRequestOption( snat_rule=snatRulebody ) response = client.create_nat_gateway_snat_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
SNAT规则创建的请求体。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" nat "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/nat/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := nat.NewNatClient( nat.NatClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateNatGatewaySnatRuleRequest{} cidrSnatRule:= "172.30.0.0/24" descriptionSnatRule:= "my snat rule 01" sourceTypeSnatRule:= int32(1) snatRulebody := &model.CreateNatGatewaySnatRuleOption{ NatGatewayId: "a78fb3eb-1654-4710-8742-3fc49d5f04f8", Cidr: &cidrSnatRule, Description: &descriptionSnatRule, SourceType: &sourceTypeSnatRule, FloatingIpId: "bdc10a4c-d81a-41ec-adf7-de857f7c812a", } request.Body = &model.CreateNatGatewaySnatRuleRequestOption{ SnatRule: snatRulebody, } response, err := client.CreateNatGatewaySnatRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建SNAT规则成功。 |
错误码
请参见错误码。