Querying Details About a VPC Attachment¶
Function¶
This API is used to query details about a VPC attachment.
URI¶
GET /v3/{project_id}/enterprise-router/{er_id}/vpc-attachments/{vpc_attachment_id}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID |
er_id | Yes | String | Enterprise router ID |
vpc_attachment_id | Yes | String | VPC attachment ID |
Request Parameters¶
None
Response Parameters¶
Status code: 200
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, 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 |
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 |
Example Requests¶
Querying details about a VPC attachment
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/vpc-attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
Example Responses¶
Status code: 200
OK
{
"vpc_attachment" : {
"id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8",
"name" : "vpc-attach",
"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"
},
"request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}
Status Codes¶
Status Code | Description |
|---|---|
200 | OK |
Error Codes¶
See Error Codes.