Querying VPC Attachments
Function
This API is used to query the VPC attachments of the enterprise router.
Constraints
VPC attachments can be queried in the following methods:
-
Filtering query is supported. You can query by ID, state, enterprise project ID, and VPC ID. You can query multiple resources at a time or use combined criteria to query resources.
-
Pagination query is supported. You can use limit and marker together for pagination query.
-
Only sorting by a single field (id, name, description, created_at, or updated_at) is supported.
Calling Method
For details, see Calling APIs.
URI
GET /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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 0 to 2000 Minimum: 0 Maximum: 2000 |
marker |
No |
String |
ID of the last enterprise router on the previous page. If this parameter is left blank, the first page is queried. This parameter must be used together with limit. Minimum: 1 Maximum: 128 |
state |
No |
Array |
Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request |
id |
No |
Array |
Query by resource ID. Multiple resources can be queried at a time. |
sort_key |
No |
Array |
Keyword for sorting. The keyword can be id, name, or state. By default, id is used. |
sort_dir |
No |
Array |
Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc. |
vpc_id |
No |
Array |
VPC id |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
vpc_attachments |
Array of VpcAttachmentDetails objects |
VPC attachments |
page_info |
PageInfo object |
Pagination query information |
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, and pending_acceptance |
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 |
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. The value can contain a maximum of 36 Unicode characters, including uppercase letters, lowercase letters, digits, hyphens (-), and underscores (_). Minimum: 1 Maximum: 128 |
value |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Example Requests
-
Querying all VPC attachments in pagination
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments?limit=10
-
Querying all VPC attachments
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/vpc-attachments
Example Responses
Status code: 200
OK
{ "vpc_attachments" : [ { "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "b715e131-3371-4e17-a2de-4f669e24439a", "virsubnet_id" : "aacdc21d-90f9-45ef-ab48-80ec1bbe15b8", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31Z", "updated_at" : "2020-03-11T15:13:31Z" }, { "id" : "6f83b848-8331-4271-ac0c-ef94b7686402", "name" : "vpc-attach-01", "vpc_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f", "virsubnet_id" : "2b55f334-a15e-43a9-ab11-b34c2dbb6fac", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "state" : "available", "created_at" : "2020-03-11T15:13:31Z", "updated_at" : "2020-03-11T15:13:31Z" } ], "page_info" : { "next_marker" : "1", "current_count" : 2 }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
SDK Sample Code
The SDK sample code is as follows.
Java
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.er.v3.region.ErRegion; import com.huaweicloud.sdk.er.v3.*; import com.huaweicloud.sdk.er.v3.model.*; import java.util.List; import java.util.ArrayList; public class ListVpcAttachmentsSolution { 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); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("<YOUR REGION>")) .build(); ListVpcAttachmentsRequest request = new ListVpcAttachmentsRequest(); request.withVpcId(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withState(); request.withId(); request.withSortKey(); request.withSortDir(); try { ListVpcAttachmentsResponse response = client.listVpcAttachments(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
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListVpcAttachmentsRequest() request.vpc_id = request.limit = <limit> request.marker = "<marker>" request.state = request.id = request.sort_key = request.sort_dir = response = client.list_vpc_attachments(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
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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := er.NewErClient( er.ErClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListVpcAttachmentsRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ListVpcAttachments(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 |
---|---|
200 |
OK |
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