更新时间:2025-07-04 GMT+08:00

更新DNAT规则

功能介绍

更新指定的DNAT规则。

调用方法

请参见如何调用API

URI

PUT /v3/{project_id}/private-nat/dnat-rules/{dnat_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

dnat_rule_id

String

DNAT规则的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

表3 请求Body参数

参数

是否必选

参数类型

描述

dnat_rule

UpdatePrivateDnatOption object

更新DNAT规则的请求体。

表4 UpdatePrivateDnatOption

参数

是否必选

参数类型

描述

description

String

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

transit_ip_id

String

中转IP的ID。

network_interface_id

String

计算实例、ELBV2、ELBV3、VIP等资源的端口ID。说明:该字段和private_ip_address字段必须二选一,否则会出现错误。

private_ip_address

String

后端资源(计算实例、ELBV2、ELBV3、VIP等)的私网IP地址。说明:该字段和network_interface_id字段必须二选一,否则会出现错误。

protocol

String

协议类型。

目前支持TCP/tcp、UDP/udp、ANY/any。

对应协议号6、17、0。

internal_service_port

String

后端实例的端口号(计算实例、ELBV2、ELBV3、VIP等)。

transit_service_port

String

中转IP的端口号。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

dnat_rule

PrivateDnat object

DNAT规则的响应体。

request_id

String

请求ID。

表6 PrivateDnat

参数

参数类型

描述

id

String

DNAT规则的ID。

project_id

String

项目的ID。

description

String

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

transit_ip_id

String

中转IP的ID。

gateway_id

String

私网NAT网关实例的ID。

network_interface_id

String

网络接口ID,支持计算、ELBV2、ELBV3、VIP等实例的端口。

type

String

DNAT规则后端的类型。

取值:

COMPUTE:后端为计算实例。

VIP:后端为VIP的实例。

ELB:后端为ELBv2的实例。

ELBv3:后端为ELBv3的实例。

CUSTOMIZE:后端为自定义IP。

protocol

String

协议类型。

目前支持TCP/tcp、UDP/udp、ANY/any。

对应协议号6、17、0。

private_ip_address

String

后端资源(计算实例、ELBV2、ELBV3、VIP等)的私网IP地址。

internal_service_port

String

后端实例的端口号(计算实例、ELBV2、ELBV3、VIP等)。

transit_service_port

String

中转IP的端口号。

enterprise_project_id

String

企业项目ID。创建DNAT规则时,关联的企业项目ID。

created_at

DateTime

DNAT规则的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

updated_at

DateTime

DNAT规则的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

status

String

私网NAT的DNAT规则状态。

取值为:

"ACTIVE":正常运行

"FROZEN":冻结

请求示例

更新DNAT规则,其中,DNAT规则的描述为my dnat-rules 03。

PUT https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/dnat-rules/24dd6bf5-48f2-4915-ad0b-5bb111d39c83

{
  "dnat_rule" : {
    "description" : "my dnat-rules 03"
  }
}

响应示例

状态码:200

更新DNAT规则成功。

{
  "dnat_rule" : {
    "id" : "24dd6bf5-48f2-4915-ad0b-5bb111d39c83",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "description" : "dnat rule description",
    "gateway_id" : "0adefb29-a6c2-48a5-8637-2be67fa03fec",
    "transit_ip_id" : "3faa719d-6d18-4ccb-a5c7-33e65a09663e",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "network_interface_id" : "dae9393a-b536-491c-a5a2-72edc1104707",
    "type" : "COMPUTE",
    "protocol" : "any",
    "internal_service_port" : "0",
    "transit_service_port" : "0",
    "private_ip_address" : "192.168.1.72",
    "created_at" : "2019-04-29T07:10:01",
    "updated_at" : "2019-04-29T07:10:01",
    "status" : "ACTIVE"
  },
  "request_id" : "747a911c17067a39692f75ac146fb47e"
}

SDK代码示例

SDK代码示例如下。

更新DNAT规则,其中,DNAT规则的描述为my dnat-rules 03。

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

    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();
        UpdatePrivateDnatRequest request = new UpdatePrivateDnatRequest();
        request.withDnatRuleId("{dnat_rule_id}");
        UpdatePrivateDnatRequestBody body = new UpdatePrivateDnatRequestBody();
        UpdatePrivateDnatOption dnatRulebody = new UpdatePrivateDnatOption();
        dnatRulebody.withDescription("my dnat-rules 03");
        body.withDnatRule(dnatRulebody);
        request.withBody(body);
        try {
            UpdatePrivateDnatResponse response = client.updatePrivateDnat(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规则,其中,DNAT规则的描述为my dnat-rules 03。

 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
# 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 = UpdatePrivateDnatRequest()
        request.dnat_rule_id = "{dnat_rule_id}"
        dnatRulebody = UpdatePrivateDnatOption(
            description="my dnat-rules 03"
        )
        request.body = UpdatePrivateDnatRequestBody(
            dnat_rule=dnatRulebody
        )
        response = client.update_private_dnat(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规则,其中,DNAT规则的描述为my dnat-rules 03。

 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
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.UpdatePrivateDnatRequest{}
	request.DnatRuleId = "{dnat_rule_id}"
	descriptionDnatRule:= "my dnat-rules 03"
	dnatRulebody := &model.UpdatePrivateDnatOption{
		Description: &descriptionDnatRule,
	}
	request.Body = &model.UpdatePrivateDnatRequestBody{
		DnatRule: dnatRulebody,
	}
	response, err := client.UpdatePrivateDnat(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

更新DNAT规则成功。

错误码

请参见错误码