更新时间:2024-03-28 GMT+08:00

更新DNAT规则

功能介绍

更新指定的DNAT规则。

接口约束

更新操作时,要求DNAT规则状态status = ACTIVE,要求网关管理员状态admin_state_up = True。port_id和private_ip不能同时生效。对于all port类型的规则,要求internal_service_port = 0,external_service_port = 0,protocol = ANY。 更新操作涉及以下字段更新时,要求这些字段必须一起更新。包括:port_id、private_ip、internal_service_port、external_service_port、floating_ip_id、protocol、internal_service_port_range、external_service_port_range。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/dnat_rules/{dnat_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:36

dnat_rule_id

String

DNAT规则的ID。

最小长度:36

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 用户Token也就是调用获取用户Token获取请求认证接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:1

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

dnat_rule

UpdateNatGatewayDnatRuleOption object

更新DNAT规则的请求体。

表4 UpdateNatGatewayDnatRuleOption

参数

是否必选

参数类型

描述

nat_gateway_id

String

NAT网关的id。

最小长度:36

最大长度:36

description

String

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

最小长度:0

最大长度:255

port_id

String

虚拟机或者裸机的Port ID,对应虚拟私有云场景,与private_ip参数二选一。

最小长度:36

最大长度:36

private_ip

String

用户私有IP地址,对应专线、云连接场景,与port_id参数二选一。

最小长度:7

最大长度:15

protocol

String

协议类型,目前支持TCP/tcp、UDP/udp、ANY/any。 对应协议号6、17、0。

最小长度:1

最大长度:3

枚举值:

  • TCP

  • UDP

  • ANY

floating_ip_id

String

弹性公网IP的id。

最小长度:36

最大长度:36

internal_service_port

Integer

虚拟机或者裸机对外提供服务的协议端口号。 取值范围:0~65535。

最小值:0

最大值:65535

最小长度:1

最大长度:5

external_service_port

Integer

Floatingip对外提供服务的端口号。 取值范围:0~65535。

最小值:0

最大值:65535

最小长度:1

最大长度:10

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。

最小长度:36

最大长度:36

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

dnat_rule

NatGatewayDnatRuleResponseBody object

DNAT规则的响应体。

表6 NatGatewayDnatRuleResponseBody

参数

参数类型

描述

id

String

DNAT规则的ID。

最小长度:36

最大长度:36

tenant_id

String

项目的ID。

最小长度:1

最大长度:36

description

String

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

最小长度:0

最大长度:255

port_id

String

虚拟机或者裸机的Port ID,对应虚拟私有云场景,与private_ip参数二选一。

最小长度:36

最大长度:36

private_ip

String

用户私有IP地址,对应专线、云连接场景,与port_id参数二选一。

最小长度:7

最大长度:15

internal_service_port

Integer

虚拟机或者裸机对外提供服务的协议端口号。 取值范围:0~65535。

最小值:0

最大值:65535

最小长度:1

最大长度:5

nat_gateway_id

String

公网NAT网关实例的ID。

最小长度:1

最大长度:36

floating_ip_id

String

弹性公网IP的id。

最小长度:1

最大长度:36

floating_ip_address

String

弹性公网IP的IP地址。

最小长度:7

最大长度:15

external_service_port

Integer

Floatingip对外提供服务的端口号。 取值范围:0~65535。

status

String

DNAT规则的状态。 取值为: "ACTIVE": 可用 "PENDING_CREATE":创建中 "PENDING_UPDATE":更新中 "PENDING_DELETE":删除中 "EIP_FREEZED":EIP冻结 "INACTIVE":不可用

枚举值:

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • EIP_FREEZED

  • 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。

最小长度:1

最大长度:3

枚举值:

  • tcp

  • udp

  • any

created_at

String

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

最小长度:1

最大长度:36

global_eip_id

String

全域弹性公网IP的id。

最小长度:36

最大长度:36

global_eip_address

String

全域弹性公网IP的地址。

最小长度:7

最大长度:15

请求示例

PUT https://{Endpoint}/v2/d199ba7e0ba64899b2e81518104b1526/dnat_rules/79195d50-0271-41f1-bded-4c089b2502ff

{
  "dnat_rule" : {
    "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
    "description" : "my dnat-rules"
  }
}

响应示例

状态码: 200

更新DNAT规则成功。

{
  "dnat_rule" : {
    "status" : "ACTIVE",
    "nat_gateway_id" : "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
    "admin_state_up" : true,
    "port_id" : "9a469561-daac-4c94-88f5-39366e5ea193",
    "internal_service_port" : 993,
    "protocol" : "tcp",
    "tenant_id" : "d199ba7e0ba64899b2e81518104b1526",
    "floating_ip_id" : "cf99c679-9f41-4dac-8513-9c9228e713e1",
    "created_at" : "2017-11-15 15:44:42.595173",
    "id" : "79195d50-0271-41f1-bded-4c089b2502ff",
    "floating_ip_address" : "5.21.11.226",
    "external_service_port" : 242,
    "description" : "my dnat rule"
  }
}

SDK代码示例

SDK代码示例如下。

 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 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 UpdateNatGatewayDnatRuleSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        NatClient client = NatClient.newBuilder()
                .withCredential(auth)
                .withRegion(NatRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateNatGatewayDnatRuleRequest request = new UpdateNatGatewayDnatRuleRequest();
        UpdateNatGatewayDnatRuleRequestBody body = new UpdateNatGatewayDnatRuleRequestBody();
        UpdateNatGatewayDnatRuleOption dnatRulebody = new UpdateNatGatewayDnatRuleOption();
        dnatRulebody.withNatGatewayId("a78fb3eb-1654-4710-8742-3fc49d5f04f8")
            .withDescription("my dnat-rules");
        body.withDnatRule(dnatRulebody);
        request.withBody(body);
        try {
            UpdateNatGatewayDnatRuleResponse response = client.updateNatGatewayDnatRule(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());
        }
    }
}
 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = NatClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(NatRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateNatGatewayDnatRuleRequest()
        dnatRulebody = UpdateNatGatewayDnatRuleOption(
            nat_gateway_id="a78fb3eb-1654-4710-8742-3fc49d5f04f8",
            description="my dnat-rules"
        )
        request.body = UpdateNatGatewayDnatRuleRequestBody(
            dnat_rule=dnatRulebody
        )
        response = client.update_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)
 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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := nat.NewNatClient(
        nat.NatClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateNatGatewayDnatRuleRequest{}
	descriptionDnatRule:= "my dnat-rules"
	dnatRulebody := &model.UpdateNatGatewayDnatRuleOption{
		NatGatewayId: "a78fb3eb-1654-4710-8742-3fc49d5f04f8",
		Description: &descriptionDnatRule,
	}
	request.Body = &model.UpdateNatGatewayDnatRuleRequestBody{
		DnatRule: dnatRulebody,
	}
	response, err := client.UpdateNatGatewayDnatRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

更新DNAT规则成功。

错误码

请参见错误码