Querying Details About an Attachment
Function
This API is used to query details about an attachment.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/enterprise-router/{er_id}/attachments/{attachment_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
er_id |
Yes |
String |
Enterprise router ID |
attachment_id |
Yes |
String |
Attachment ID |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
attachment |
AttachmentResponse object |
Attachment basic information |
request_id |
String |
Request ID |
Parameter |
Type |
Description |
---|---|---|
name |
String |
Attachment name |
id |
String |
Attachment ID |
description |
String |
Description |
state |
String |
Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request |
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 |
Enterprise router tags |
project_id |
String |
Project ID |
resource_id |
String |
Attached resource ID on its own service console |
resource_type |
String |
Attachment type.
|
resource_project_id |
String |
ID of the project that the resource 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 details about an attachment
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/212d3f0b-8496-472d-bc99-05a7c96d6655/attachments/b70aee08-c671-4cad-9fd5-7381d163bcc8
Example Responses
Status code: 200
OK
{ "attachment" : { "id" : "b70aee08-c671-4cad-9fd5-7381d163bcc8", "name" : "vpc attachment", "description" : "vpc prod", "state" : "avaliable", "created_at" : "2020-03-11T15:13:31Z", "updated_at" : "2020-03-11T15:13:31Z", "project_id" : "08d5a9564a704afda6039ae2babbef3c", "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a", "resource_type" : "vpc" }, "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9" }
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.