更新时间:2024-12-20 GMT+08:00
分享

创建中转IP

功能介绍

创建中转IP。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/private-nat/transit-ips

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目的ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

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

表3 请求Body参数

参数

是否必选

参数类型

描述

transit_ip

CreatTransitIpOption object

创建中转IP的请求体。

表4 CreatTransitIpOption

参数

是否必选

参数类型

描述

virsubnet_id

String

当前项目子网的ID。

ip_address

String

中转IP地址。

enterprise_project_id

String

企业项目ID。创建中转IP时,关联的企业项目ID。

tags

Array of Tag objects

标签

表5 Tag

参数

是否必选

参数类型

描述

key

String

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

value

String

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

响应参数

状态码: 201

表6 响应Body参数

参数

参数类型

描述

transit_ip

TransitIp object

中转子网IP的响应体。

request_id

String

请求ID。

表7 TransitIp

参数

参数类型

描述

id

String

中转IP的ID。

project_id

String

项目的ID。

network_interface_id

String

中转IP的网络接口ID。

ip_address

String

中转IP的地址。

created_at

String

中转IP的创建时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ

updated_at

String

中转IP的更新时间,遵循UTC时间,格式是yyyy-mm-ddThh:mm:ssZ

virsubnet_id

String

当前租户子网的ID。取值约束:与transit_subnet_id参数二选一。默认空字符串。

tags

Array of Tag objects

标签列表。

gateway_id

String

中转IP绑定的私网NAT网关实例的ID。

enterprise_project_id

String

企业项目ID。创建中转IP时,关联的企业项目ID。

status

String

私网NAT中转IP的状态。

取值为:

"ACTIVE":正常运行

"FROZEN":冻结

表8 Tag

参数

参数类型

描述

key

String

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

value

String

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

请求示例

创建中转IP,其中,当前项目子网的id为2759da7b-8015-404c-ae0a-a389007b0e2a,中转IP地址为192.168.1.68,创建中转IP时,关联的企业项目id为2759da7b-8015-404c-ae0a-a389007b0e2a。

POST https://{Endpoint}/v3/da261828016849188f4dcc2ef94d9da9/private-nat/transit-ips

{
  "transit_ip" : {
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "ip_address" : "192.168.1.68",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ]
  }
}

响应示例

状态码: 201

创建中转IP成功。

{
  "transit_ip" : {
    "id" : "a2845109-3b2f-4627-b08f-09a726c0a6e7",
    "project_id" : "da261828016849188f4dcc2ef94d9da9",
    "network_interface_id" : "adebbdca-8c26-4c14-b34f-3f53cd2c42f2",
    "ip_address" : "192.168.1.68",
    "gateway_id" : "521bb3d9-8bed-4c6c-9ee8-669bd0620f76",
    "enterprise_project_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "created_at" : "2019-04-29T02:16:09",
    "updated_at" : "2019-04-29T02:16:09",
    "virsubnet_id" : "2759da7b-8015-404c-ae0a-a389007b0e2a",
    "tags" : [ {
      "key" : "key1",
      "value" : "value1"
    } ],
    "status" : "ACTIVE"
  },
  "request_id" : "747a911c17067a39692f75ac146fb47e"
}

SDK代码示例

SDK代码示例如下。

创建中转IP,其中,当前项目子网的id为2759da7b-8015-404c-ae0a-a389007b0e2a,中转IP地址为192.168.1.68,创建中转IP时,关联的企业项目id为2759da7b-8015-404c-ae0a-a389007b0e2a。

 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
59
60
61
62
63
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.*;

import java.util.List;
import java.util.ArrayList;

public class CreateTransitIpSolution {

    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();
        CreateTransitIpRequest request = new CreateTransitIpRequest();
        CreateTransitIpRequestBody body = new CreateTransitIpRequestBody();
        List<PrivateTag> listTransitIpTags = new ArrayList<>();
        listTransitIpTags.add(
            new PrivateTag()
                .withKey("key1")
                .withValue("value1")
        );
        CreatTransitIpOption transitIpbody = new CreatTransitIpOption();
        transitIpbody.withVirsubnetId("2759da7b-8015-404c-ae0a-a389007b0e2a")
            .withIpAddress("192.168.1.68")
            .withEnterpriseProjectId("2759da7b-8015-404c-ae0a-a389007b0e2a")
            .withTags(listTransitIpTags);
        body.withTransitIp(transitIpbody);
        request.withBody(body);
        try {
            CreateTransitIpResponse response = client.createTransitIp(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());
        }
    }
}

创建中转IP,其中,当前项目子网的id为2759da7b-8015-404c-ae0a-a389007b0e2a,中转IP地址为192.168.1.68,创建中转IP时,关联的企业项目id为2759da7b-8015-404c-ae0a-a389007b0e2a。

 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
# 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 = CreateTransitIpRequest()
        listTagsTransitIp = [
            PrivateTag(
                key="key1",
                value="value1"
            )
        ]
        transitIpbody = CreatTransitIpOption(
            virsubnet_id="2759da7b-8015-404c-ae0a-a389007b0e2a",
            ip_address="192.168.1.68",
            enterprise_project_id="2759da7b-8015-404c-ae0a-a389007b0e2a",
            tags=listTagsTransitIp
        )
        request.body = CreateTransitIpRequestBody(
            transit_ip=transitIpbody
        )
        response = client.create_transit_ip(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建中转IP,其中,当前项目子网的id为2759da7b-8015-404c-ae0a-a389007b0e2a,中转IP地址为192.168.1.68,创建中转IP时,关联的企业项目id为2759da7b-8015-404c-ae0a-a389007b0e2a。

 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 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.CreateTransitIpRequest{}
	var listTagsTransitIp = []model.PrivateTag{
        {
            Key: "key1",
            Value: "value1",
        },
    }
	ipAddressTransitIp:= "192.168.1.68"
	enterpriseProjectIdTransitIp:= "2759da7b-8015-404c-ae0a-a389007b0e2a"
	transitIpbody := &model.CreatTransitIpOption{
		VirsubnetId: "2759da7b-8015-404c-ae0a-a389007b0e2a",
		IpAddress: &ipAddressTransitIp,
		EnterpriseProjectId: &enterpriseProjectIdTransitIp,
		Tags: &listTagsTransitIp,
	}
	request.Body = &model.CreateTransitIpRequestBody{
		TransitIp: transitIpbody,
	}
	response, err := client.CreateTransitIp(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

201

创建中转IP成功。

错误码

请参见错误码

相关文档