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.

URI¶

GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
er_id	Yes	String	Enterprise router ID

**Table 2** Query Parameters¶
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 of strings	Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request
id	No	Array of strings	Query by resource ID. Multiple resources can be queried at a time.
sort_key	No	Array of strings	Keyword for sorting. The keyword can be id, name, or state. By default, id is used.
sort_dir	No	Array of strings	Sorting order. There are two value options: asc (ascending order) and desc (descending order). The default value is asc.
vpc_id	No	Array of strings	VPC id

Request Parameters¶

None

Response Parameters¶

Status code: 200

**Table 3** Response body parameters¶
Parameter	Type	Description
vpc_attachments	Array of VpcAttachmentDetails objects	VPC attachments
page_info	PageInfo object	Pagination query information
request_id	String	Request ID

**Table 4** VpcAttachmentDetails¶
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 YYYY-MM-DDTHH:mm:ss.sssZ
updated_at	String	Update time in the format YYYY-MM-DDTHH:mm:ss.sssZ
tags	Array of Tag objects	Tag information
description	String	Supplementary information about the VPC attachment
project_id	String	Project ID
vpc_project_id	String	ID of the project that the VPC belongs to
ipv6_enable	Boolean	The default value is false. If the value is true, IPv6 is enabled for the VPC attachment. This parameter is not supported for now. Default: false

**Table 5** Tag¶
Parameter	Type	Description
key	String	Tag key. The value contain up to 128 characters (36 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@). Minimum: 1 Maximum: 128
value	String	Tag value. The value contain up to 128 characters in API (43 characters on the console), including uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and at signs (@). Minimum: 0 Maximum: 128

**Table 6** PageInfo¶
Parameter	Type	Description
next_marker	String	Marker of the next page. The value is the resource UUID. If the value is empty, the resource is on the last page.
current_count	Integer	Number of resources in the list

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

{
  "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",
    "ipv6_enable" : false,
    "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",
    "ipv6_enable" : false,
    "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"
}

Status Codes¶

Status Code	Description
200	OK

Error Codes¶

See Error Codes.

last updated: 2024-12-11 13:42 UTC - commit: 90d111849278cea16b61ee705667632c811c4f30