创建DNAT规则
功能介绍
创建DNAT规则。
接口约束
创建规则时,要求网关状态status = ACTIVE,要求网关管理员状态admin_state_up = True。 port_id和private_ip不能同时生效。 对于all port类型的规则,要求internal_service_port = 0,external_service_port = 0,protocol = ANY.
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/dnat_rules
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目的ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
dnat_rule |
是 |
CreateNatGatewayDnatOption object |
创建DNAT规则的请求体。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
DNAT规则的描述,长度范围小于等于255个字符,不能包含“<”和“>”。 |
port_id |
否 |
String |
虚拟机或者裸机的Port ID,对应虚拟私有云场景,与private_ip参数二选一。 |
private_ip |
否 |
String |
用户私有IP地址,对应专线、云连接场景,与port_id参数二选一。 |
nat_gateway_id |
是 |
String |
公网NAT网关实例的ID。 |
internal_service_port |
是 |
Integer |
虚拟机或者裸机对外提供服务的协议端口号。 取值范围: 0~65535。 |
floating_ip_id |
是 |
String |
弹性公网IP的id。 |
external_service_port |
是 |
Integer |
Floatingip对外提供服务的端口号。 取值范围: 0~65535。 |
protocol |
是 |
String |
协议类型,目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。 |
internal_service_port_range |
否 |
String |
虚拟机或者裸机对外提供服务的协议端口号范围。 功能说明: 该端口范围与external _service_port_range按顺序实现1:1映射。 取值范围: 1~65535。 约束: 只能以’-’字符连接端口范围。 |
external_service_port_range |
否 |
String |
Floatingip对外提供服务的端口号范围。 功能说明: 该端口范围与internal _service_port_range按顺序实现1:1映射。 取值范围: 1~65535。 约束: 只能以’-’字符连接端口范围。 |
global_eip_id |
否 |
String |
全域弹性公网IP的id。 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
dnat_rule |
DNAT规则的响应体。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
DNAT规则的ID。 |
tenant_id |
String |
项目的ID。 |
description |
String |
DNAT规则的描述。长度范围小于等于255个字符,不能包含“<”和“>”。 |
port_id |
String |
虚拟机或者裸机的Port ID,对应虚拟私有云场景,与private_ip参数二选一。 |
private_ip |
String |
用户私有IP地址,对应专线、云连接场景,与port_id参数二选一。 |
internal_service_port |
Integer |
虚拟机或者裸机对外提供服务的协议端口号。 取值范围: 0~65535。 |
nat_gateway_id |
String |
公网NAT网关实例的ID。 |
global_eip_id |
String |
全域弹性公网IP的id,与弹性公网IP的id二选一。 |
global_eip_address |
String |
全域弹性公网IP的IP地址。 |
floating_ip_id |
String |
弹性公网IP的id。 |
floating_ip_address |
String |
弹性公网IP的IP地址。 |
external_service_port |
Integer |
Floatingip对外提供服务的端口号。 取值范围: 0~65535。 |
status |
String |
DNAT规则的状态。 取值为: ACTIVE: 可用 PENDING_CREATE: 创建中 PENDING_UPDATE: 更新中 PENDING_DELETE: 删除中 EIP_FREEZED: EIP冻结 INACTIVE: 不可用 |
admin_state_up |
Boolean |
解冻/冻结状态。 取值范围: − “true”: 解冻 − “false”: 冻结 |
internal_service_port_range |
String |
虚拟机或者裸机对外提供服务的协议端口号范围。 功能说明: 该端口范围与external _service_port_range按顺序实现1:1映射。 取值范围: 1~65535。 约束: 只能以’-’字符连接端口范围。 |
external_service_port_range |
String |
Floatingip对外提供服务的端口号范围。 功能说明: 该端口范围与internal _service_port_range按顺序实现1:1映射。 取值范围: 1~65535。 约束: 只能以’-’字符连接端口范围 |
protocol |
String |
协议类型,目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。 |
created_at |
String |
DNAT规则的创建时间,格式是yyyy-mm-dd hh:mm:ss.SSSSSS。 |
请求示例
创建dnat规则。
POST https://{NAT_endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules { "dnat_rule" : { "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "external_service_port" : 242, "description" : "my dnat rule 01" } }
响应示例
状态码: 201
创建DNAT规则成功。
{ "dnat_rule" : { "floating_ip_id" : "bf99c679-9f41-4dac-8513-9c9228e713e1", "status" : "ACTIVE", "nat_gateway_id" : "cda3a125-2406-456c-a11f-598e10578541", "admin_state_up" : true, "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193", "internal_service_port" : 993, "protocol" : "tcp", "tenant_id" : "d199ba7e0ba64899b2e81518104b1526d", "created_at" : "2019-11-15 15:44:42.595173", "id" : "79195d50-0271-41f1-bded-4c089b2502ff", "external_service_port" : 242, "floating_ip_address" : "5.21.11.226", "description" : "my dnat rule 01" } }
SDK代码示例
SDK代码示例如下。
创建dnat规则。
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 57 58 |
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 CreateNatGatewayDnatRuleSolution { 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(); CreateNatGatewayDnatRuleRequest request = new CreateNatGatewayDnatRuleRequest(); CreateNatGatewayDnatRuleOption body = new CreateNatGatewayDnatRuleOption(); CreateNatGatewayDnatOption dnatRulebody = new CreateNatGatewayDnatOption(); dnatRulebody.withDescription("my dnat rule 01") .withPortId("9a469561-daac-4c94-88f5-39366e5ea193") .withNatGatewayId("cda3a125-2406-456c-a11f-598e10578541") .withInternalServicePort(993) .withFloatingIpId("bf99c679-9f41-4dac-8513-9c9228e713e1") .withExternalServicePort(242) .withProtocol("tcp"); body.withDnatRule(dnatRulebody); request.withBody(body); try { CreateNatGatewayDnatRuleResponse response = client.createNatGatewayDnatRule(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()); } } } |
创建dnat规则。
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 |
# 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 = CreateNatGatewayDnatRuleRequest() dnatRulebody = CreateNatGatewayDnatOption( description="my dnat rule 01", port_id="9a469561-daac-4c94-88f5-39366e5ea193", nat_gateway_id="cda3a125-2406-456c-a11f-598e10578541", internal_service_port=993, floating_ip_id="bf99c679-9f41-4dac-8513-9c9228e713e1", external_service_port=242, protocol="tcp" ) request.body = CreateNatGatewayDnatRuleOption( dnat_rule=dnatRulebody ) response = client.create_nat_gateway_dnat_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) |
创建dnat规则。
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 |
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.CreateNatGatewayDnatRuleRequest{} descriptionDnatRule:= "my dnat rule 01" portIdDnatRule:= "9a469561-daac-4c94-88f5-39366e5ea193" dnatRulebody := &model.CreateNatGatewayDnatOption{ Description: &descriptionDnatRule, PortId: &portIdDnatRule, NatGatewayId: "cda3a125-2406-456c-a11f-598e10578541", InternalServicePort: int32(993), FloatingIpId: "bf99c679-9f41-4dac-8513-9c9228e713e1", ExternalServicePort: int32(242), Protocol: "tcp", } request.Body = &model.CreateNatGatewayDnatRuleOption{ DnatRule: dnatRulebody, } response, err := client.CreateNatGatewayDnatRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建DNAT规则成功。 |
错误码
请参见错误码。