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

更新SNAT规则

功能介绍

更新指定的SNAT规则。

接口约束

更新弹性公网IP的id时,要求SNAT规则状态status = ACTIVE,要求网关管理员状态admin_state_up = True。 更新描述时,要求SNAT规则状态status = ACTIVE,要求网关管理员状态admin_state_up = True。

调用方法

请参见如何调用API

URI

PUT /v2/{project_id}/snat_rules/{snat_rule_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

最小长度:1

最大长度:36

snat_rule_id

String

SNAT规则的ID。

最小长度:36

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:1

最大长度:10240

表3 请求Body参数

参数

是否必选

参数类型

描述

snat_rule

UpdateNatGatewaySnatRuleOption object

更新SNAT规则的请求体。

表4 UpdateNatGatewaySnatRuleOption

参数

是否必选

参数类型

描述

nat_gateway_id

String

公网NAT网关的id。

最小长度:36

最大长度:36

public_ip_address

String

功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。 约束:弹性公网IP的id个数不能超过20个

global_eip_id

String

全域弹性公网IP的id。

description

String

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

最小长度:0

最大长度:255

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

snat_rule

NatGatewayUpdateSnatRuleResponseBody object

更新SNAT规则的响应体。

表6 NatGatewayUpdateSnatRuleResponseBody

参数

参数类型

描述

id

String

SNAT规则的ID。

最小长度:36

最大长度:36

tenant_id

String

项目的ID。

最小长度:1

最大长度:36

nat_gateway_id

String

公网NAT网关实例的ID。

最小长度:36

最大长度:36

source_type

Integer

0:VPC侧,可以指定network_id 或者cidr 1:专线侧,只能指定cidr 不输入默认为0(VPC)

最小值:0

最大值:1

缺省值:0

cidr

String

cidr,可以是网段或者主机格式,与network_id参数二选一。 Source_type=0时,cidr必须是vpc 子网网段的子集(不能相等); Source_type=1时,cidr必须指定专线侧网段。

最小长度:9

最大长度:18

floating_ip_id

String

功能说明:弹性公网IP的id,多个弹性公网IP使用逗号分隔。

description

String

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

最小长度:0

最大长度:255

status

String

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

枚举值:

  • ACTIVE

  • PENDING_CREATE

  • PENDING_UPDATE

  • PENDING_DELETE

  • EIP_FREEZED

  • INACTIVE

created_at

String

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

最小长度:1

最大长度:36

network_id

String

规则使用的网络id。与cidr参数二选一。

最小长度:36

最大长度:36

admin_state_up

Boolean

解冻/冻结状态。 取值范围:

  • "true":解冻

  • "false":冻结

floating_ip_address

String

功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。

public_ip_address

String

功能说明:弹性公网IP,多个弹性公网IP使用逗号分隔。

global_eip_address

String

全域弹性公网IP的地址。

global_eip_id

String

全域弹性公网IP的id。

请求示例

SNAT规则更新的请求体。

PUT https://{Endpoint}/v2/27e25061336f4af590faeabeb7fcd9a3/snat_rules/5b95c675-69c2-4656-ba06-58ff72e1d338 

{
  "snat_rule" : {
    "nat_gateway_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
    "description" : "my_snat_rule_update",
    "public_ip_address" : "10.15.10.11,10.15.10.12"
  }
}

响应示例

状态码: 200

PUT操作正常返回。

{
  "snat_rule" : {
    "floating_ip_id" : " bdc10a4c-d81a-41ec-adf7-de857f7c812a,7a094014-9657-463f-972b-e84d56b931a0",
    "status" : "ACTIVE",
    "nat_gateway_id" : "bbe7c2e7-3bad-445b-a067-b30acce66053",
    "admin_state_up" : true,
    "network_id" : "eaad9cd6-2372-4be1-9535-9bd37210ae7b",
    "source_type" : 0,
    "tenant_id" : "27e25061336f4af590faeabeb7fcd9a3",
    "created_at" : "2017-11-18 07:54:21.665430",
    "id" : "5b95c675-69c2-4656-ba06-58ff72e1d338",
    "public_ip_address" : "10.15.10.11,10.15.10.12",
    "floating_ip_address" : "10.15.10.11,10.15.10.12",
    "description" : "my_snat_rule_update"
  }
}

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

    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();
        UpdateNatGatewaySnatRuleRequest request = new UpdateNatGatewaySnatRuleRequest();
        UpdateNatGatewaySnatRuleRequestOption body = new UpdateNatGatewaySnatRuleRequestOption();
        UpdateNatGatewaySnatRuleOption snatRulebody = new UpdateNatGatewaySnatRuleOption();
        snatRulebody.withNatGatewayId("bbe7c2e7-3bad-445b-a067-b30acce66053")
            .withPublicIpAddress("10.15.10.11,10.15.10.12")
            .withDescription("my_snat_rule_update");
        body.withSnatRule(snatRulebody);
        request.withBody(body);
        try {
            UpdateNatGatewaySnatRuleResponse response = client.updateNatGatewaySnatRule(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
# 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 = UpdateNatGatewaySnatRuleRequest()
        snatRulebody = UpdateNatGatewaySnatRuleOption(
            nat_gateway_id="bbe7c2e7-3bad-445b-a067-b30acce66053",
            public_ip_address="10.15.10.11,10.15.10.12",
            description="my_snat_rule_update"
        )
        request.body = UpdateNatGatewaySnatRuleRequestOption(
            snat_rule=snatRulebody
        )
        response = client.update_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
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.UpdateNatGatewaySnatRuleRequest{}
	publicIpAddressSnatRule:= "10.15.10.11,10.15.10.12"
	descriptionSnatRule:= "my_snat_rule_update"
	snatRulebody := &model.UpdateNatGatewaySnatRuleOption{
		NatGatewayId: "bbe7c2e7-3bad-445b-a067-b30acce66053",
		PublicIpAddress: &publicIpAddressSnatRule,
		Description: &descriptionSnatRule,
	}
	request.Body = &model.UpdateNatGatewaySnatRuleRequestOption{
		SnatRule: snatRulebody,
	}
	response, err := client.UpdateNatGatewaySnatRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

PUT操作正常返回。

错误码

请参见错误码