Assigning a Transit IP Address
Function
This API is used to assign a transit IP address.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/private-nat/transit-ips
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the user token. It is a response to the API used to obtain a user token. This API is the only one that does not require authentication. The value of X-Subject-Token in the response header is the token value. Minimum: 1 Maximum: 512 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
transit_ip |
Yes |
CreatTransitIpOption object |
Specifies the request body for assigning a transit IP address. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
virsubnet_id |
Yes |
String |
Specifies the subnet ID of the current project. Minimum: 1 Maximum: 36 |
ip_address |
No |
String |
Specifies the transit IP address. Minimum: 7 Maximum: 35 |
enterprise_project_id |
No |
String |
Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned. Default: 0 Minimum: 1 Maximum: 36 |
tags |
No |
Array of Tag objects |
Specifies the tag of the transit IP address. Array Length: 0 - 2000 |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
transit_ip |
TransitIp object |
Specifies the response body of the transit IP address. |
request_id |
String |
Specifies the request ID. Minimum: 1 Maximum: 36 |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the ID of the transit IP address. Minimum: 36 Maximum: 36 |
project_id |
String |
Specifies the project ID. Minimum: 1 Maximum: 36 |
network_interface_id |
String |
Specifies the network interface ID of the transit IP address. Minimum: 36 Maximum: 36 |
ip_address |
String |
Specifies the transit IP address. Minimum: 7 Maximum: 35 |
created_at |
String |
Specifies when the transit IP address was assigned. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36 |
updated_at |
String |
Specifies when the transit IP address was updated. It is a UTC time in the yyyy-mm-ddThh:mm:ssZ format. Minimum: 1 Maximum: 36 |
virsubnet_id |
String |
Specifies the subnet ID of the current tenant. Minimum: 0 Maximum: 36 |
tags |
Array of Tag objects |
Specifies the list of tags. Array Length: 1 - 10 |
gateway_id |
String |
Specifies the ID of the private NAT gateway associated with the transit IP address. Minimum: 36 Maximum: 36 |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that is associated with the transit IP address when the transit IP address is being assigned. Minimum: 1 Maximum: 36 |
Example Requests
Assigning a transit IP address (Setting virsubnet_id to 2759da7b-8015-404c-ae0a-a389007b0e2a, ip_address to 192.168.1.68, and enterprise_project_id to 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" } ] } }
Example Responses
Status code: 201
Transit IP address assigned.
{ "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" } ] }, "request_id" : "747a911c17067a39692f75ac146fb47e" }
SDK Sample Code
The SDK sample code is as follows.
Assigning a transit IP address (Setting virsubnet_id to 2759da7b-8015-404c-ae0a-a389007b0e2a, ip_address to 192.168.1.68, and enterprise_project_id to 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 |
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"); ICredential auth = new BasicCredentials() .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()); } } } |
Assigning a transit IP address (Setting virsubnet_id to 2759da7b-8015-404c-ae0a-a389007b0e2a, ip_address to 192.168.1.68, and enterprise_project_id to 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 |
# 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 = 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) |
Assigning a transit IP address (Setting virsubnet_id to 2759da7b-8015-404c-ae0a-a389007b0e2a, ip_address to 192.168.1.68, and enterprise_project_id to 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 |
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.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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
Transit IP address assigned. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot