文档首页/ NAT网关 NAT/ API参考/ API(私网NAT网关)/ 中转子网/ 更新中转子网 - UpdateTransitSubnet
更新时间:2025-12-10 GMT+08:00
分享

更新中转子网 - UpdateTransitSubnet

功能介绍

更新指定的中转子网。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    nat:transitSubnets:update

    Write

    transitSubnet *

    g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v3/{project_id}/private-nat/transit-subnets/{transit_subnet_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

transit_subnet_id

String

中转子网ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

表3 请求Body参数

参数

是否必选

参数类型

描述

transit_subnet

UpdateTransitSubnetOption object

更新中转子网请求体

表4 UpdateTransitSubnetOption

参数

是否必选

参数类型

描述

name

String

中转子网的名字。仅支持数字、字母、_(下划线)、-(中划线)、中文。

只有中转子网的申请方才可修改中转子网的名字,审批方不可修改。

description

String

中转子网的描述。长度范围小于等于255个字符,不能包含“<”和“>”。

只有中转子网的申请方才可修改中转子网的描述,审批方不可修改。

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

transit_subnet

TransitSubnet object

中转子网的响应体

request_id

String

请求ID

表6 TransitSubnet

参数

参数类型

描述

id

String

中转子网的ID

name

String

中转子网的名称

description

String

中转子网的描述

virsubnet_project_id

String

中转子网的子网所属的项目ID

project_id

String

项目ID

vpc_id

String

中转子网的子网所属VPC的ID

virsubnet_id

String

中转子网的子网ID

cidr

String

中转子网的子网网段

type

String

中转子网类型。取值范围:VPC

status

String

中转子网状态。

取值范围:

ACTIVE: 当前资源状态正常。

INACTIVE: 不可用。

ip_count

Integer

当前中转子网下已分配的中转子网IP数量。

created_at

String

中转子网创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

updated_at

String

中转子网更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ。

tags

Array of Tag objects

标签列表

表7 Tag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。key不能为空。

value

String

值。每个值最大长度255个unicode字符。

请求示例

更新中转子网的名字和描述。

PUT https://{Endpoint}/v3/70505c941b9b4dfd82fd351932328a2f/private-nat/transit-subnets/48b55781-306c-4a90-9cc0-d376337fae4f

{
  "transit_subnet" : {
    "name" : "transit-subnet_t2",
    "description" : "transit-subnet-description2"
  }
}

响应示例

状态码:200

更新中转子网成功。

{
  "request_id" : "9882046a9b96f1405472e36d797e33dc",
  "transit_subnet" : {
    "id" : "48b55781-306c-4a90-9cc0-d376337fae4f",
    "name" : "transit-subnet_t1",
    "description" : "transit-subnet-description",
    "virsubnet_project_id" : "aea5011c0bc2454d8645a560345da810",
    "project_id" : "aea5011c0bc2454d8645a560345da810",
    "vpc_id" : "f9169a4f-5f0a-41ce-b2a3-834c15b038c2",
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "cidr" : "192.168.1.0/24",
    "type" : "VPC",
    "status" : "ACTIVE",
    "ip_count" : 0,
    "created_at" : "2021-07-01T09:15:54Z",
    "updated_at" : "2021-04-01T09:15:54Z",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }
}

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
52
53
54
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 UpdateTransitSubnetSolution {

    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();
        UpdateTransitSubnetRequest request = new UpdateTransitSubnetRequest();
        request.withTransitSubnetId("{transit_subnet_id}");
        UpdateTransitSubnetRequestBody body = new UpdateTransitSubnetRequestBody();
        UpdateTransitSubnetOption transitSubnetbody = new UpdateTransitSubnetOption();
        transitSubnetbody.withName("transit-subnet_t2")
            .withDescription("transit-subnet-description2");
        body.withTransitSubnet(transitSubnetbody);
        request.withBody(body);
        try {
            UpdateTransitSubnetResponse response = client.updateTransitSubnet(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
37
38
39
# 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 = UpdateTransitSubnetRequest()
        request.transit_subnet_id = "{transit_subnet_id}"
        transitSubnetbody = UpdateTransitSubnetOption(
            name="transit-subnet_t2",
            description="transit-subnet-description2"
        )
        request.body = UpdateTransitSubnetRequestBody(
            transit_subnet=transitSubnetbody
        )
        response = client.update_transit_subnet(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
44
45
46
47
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.UpdateTransitSubnetRequest{}
	request.TransitSubnetId = "{transit_subnet_id}"
	nameTransitSubnet:= "transit-subnet_t2"
	descriptionTransitSubnet:= "transit-subnet-description2"
	transitSubnetbody := &model.UpdateTransitSubnetOption{
		Name: &nameTransitSubnet,
		Description: &descriptionTransitSubnet,
	}
	request.Body = &model.UpdateTransitSubnetRequestBody{
		TransitSubnet: transitSubnetbody,
	}
	response, err := client.UpdateTransitSubnet(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

更新中转子网成功。

400

Bad Request

错误码

请参见错误码

相关文档