Creating a VPC Attachment
Function
This API is used to create a VPC attachment for an enterprise router.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
er_id |
Yes |
String |
Enterprise router ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Client-Token |
No |
String |
Idempotence identifier Minimum: 1 Maximum: 64 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
vpc_attachment |
Yes |
VpcAttachmentCreateRequest object |
VPC attachment |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
vpc_id |
Yes |
String |
VPC ID. The value contains a maximum of 36 characters in UUID format with hyphens (-). |
name |
Yes |
String |
VPC attachment name. The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.). Minimum: 1 Maximum: 64 |
virsubnet_id |
Yes |
String |
VPC subnet ID. The value contains a maximum of 36 characters in UUID format with hyphens (-). |
description |
No |
String |
Description. The value can contain no more than 255 characters and cannot contain angle brackets (< or >). Minimum: 0 Maximum: 255 |
auto_create_vpc_routes |
No |
Boolean |
The default value is false. If the value is set to true, a route with the enterprise router as the next hop will be automatically added to the route tables of the VPC. Default: false |
tags |
No |
Array of Tag objects |
Tag information |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
No |
String |
Tag key.
Minimum: 1 Maximum: 128 |
value |
No |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 202
Parameter |
Type |
Description |
---|---|---|
X-Client-Token |
String |
Idempotence identifier |
Parameter |
Type |
Description |
---|---|---|
vpc_attachment |
VpcAttachmentDetails object |
VPC attachment |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
id |
String |
VPC attachment ID |
name |
String |
VPC attachment name |
vpc_id |
String |
VPC id |
virsubnet_id |
String |
VPC subnet ID |
auto_create_vpc_routes |
Boolean |
The default value is false. If this parameter is set to true, routes with this enterprise router as the next hop and 10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16 as the destinations will be automatically added to the route tables of the VPC. Default: false |
state |
String |
VPC attachment status. Value options: pending, available, modifying, deleting, deleted, failed, initiating_request, rejected, pending_acceptance, freezed, and invalid |
created_at |
String |
Creation time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
updated_at |
String |
Update time in the format of YYYY-MM-DDTHH:mm:ss.sssZ |
tags |
Array of Tag objects |
Tag information |
description |
String |
Description of the VPC attachment |
project_id |
String |
Project ID |
vpc_project_id |
String |
ID of the project that the VPC belongs to |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key.
Minimum: 1 Maximum: 128 |
value |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Example Requests
Creating a VPC attachment named vpc-atta, with the VPC subnet specified
POST https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/vpc-attachments
{
"vpc_attachment" : {
"name" : "vpc-atta",
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8"
}
}
Example Responses
Status code: 202
Accepted
{
"vpc_attachment" : {
"id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
"name" : "vpc-atta",
"vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
"virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
"project_id" : "08d5a9564a704afda6039ae2babbef3c",
"state" : "pending",
"auto_create_vpc_routes" : false,
"created_at" : "2020-03-11T15:13:31Z",
"updated_at" : "2020-03-11T15:13:31Z"
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
SDK Sample Code
The SDK sample code is as follows.
Java
Creating a VPC attachment named vpc-atta, with the VPC subnet specified
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 |
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.er.v3.region.ErRegion;
import com.huaweicloud.sdk.er.v3.*;
import com.huaweicloud.sdk.er.v3.model.*;
public class CreateVpcAttachmentSolution {
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);
ErClient client = ErClient.newBuilder()
.withCredential(auth)
.withRegion(ErRegion.valueOf("<YOUR REGION>"))
.build();
CreateVpcAttachmentRequest request = new CreateVpcAttachmentRequest();
request.withErId("{er_id}");
CreateVpcAttachmentBody body = new CreateVpcAttachmentBody();
VpcAttachmentCreateRequest vpcAttachmentbody = new VpcAttachmentCreateRequest();
vpcAttachmentbody.withVpcId("b715e131-3371-4e17-a2de-4f669e24439a")
.withName("vpc-atta")
.withVirsubnetId("aacdc21d-90f9-45ef-ab48-80ec1bbe15b8");
body.withVpcAttachment(vpcAttachmentbody);
request.withBody(body);
try {
CreateVpcAttachmentResponse response = client.createVpcAttachment(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());
}
}
}
|
Python
Creating a VPC attachment named vpc-atta, with the VPC subnet specified
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdker.v3.region.er_region import ErRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdker.v3 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 = ErClient.new_builder() \
.with_credentials(credentials) \
.with_region(ErRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = CreateVpcAttachmentRequest()
request.er_id = "{er_id}"
vpcAttachmentbody = VpcAttachmentCreateRequest(
vpc_id="b715e131-3371-4e17-a2de-4f669e24439a",
name="vpc-atta",
virsubnet_id="aacdc21d-90f9-45ef-ab48-80ec1bbe15b8"
)
request.body = CreateVpcAttachmentBody(
vpc_attachment=vpcAttachmentbody
)
response = client.create_vpc_attachment(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Go
Creating a VPC attachment named vpc-atta, with the VPC subnet specified
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
er "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/er/v3/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 := er.NewErClient(
er.ErClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.CreateVpcAttachmentRequest{}
request.ErId = "{er_id}"
vpcAttachmentbody := &model.VpcAttachmentCreateRequest{
VpcId: "b715e131-3371-4e17-a2de-4f669e24439a",
Name: "vpc-atta",
VirsubnetId: "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8",
}
request.Body = &model.CreateVpcAttachmentBody{
VpcAttachment: vpcAttachmentbody,
}
response, err := client.CreateVpcAttachment(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
More
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 |
---|---|
202 |
Accepted |
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