Querying Attachments¶

Function¶

This API is used to query the attachments of the enterprise router.

Constraints¶

Filtering query is supported. The filtering criteria include state, resource_type, and resource_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}/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	Attachment status. Value options: pending, available, modifying, deleting, deleted, failed, pending_acceptance, rejected, and initiating_request
resource_type	No	Array	Attachment type. vpc: VPC attachments vgw: virtual gateway attachments
resource_id	No	Array	Attachment resource IDs
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.

Request Parameters¶

None

Response Parameters¶

Status code: 200

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

**Table 4** AttachmentDetails¶
Parameter	Type	Description
id	String	Attachment ID
name	String	Attachment name
description	String	Attachment 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 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	Enterprise router tags
project_id	String	Project ID
er_id	String	er id
resource_id	String	Attached resource ID on its own service console
resource_type	String	Attachment type. vgw: virtual gateway attachments vpc: VPC attachments
resource_project_id	String	ID of the project that the resource belongs to
associated	Boolean	Whether the attachment is associated.
route_table_id	String	Association route table ID

**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 attachments

GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/attachments

Example Responses¶

Status code: 200

{
  "attachments" : [ {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686402",
    "name" : "vpc-001",
    "description" : "vpc attachment",
    "resource_id" : "b715e131-3371-4e17-a2de-4f669e24439a",
    "resource_type" : "vpc",
    "project_id" : "0605767a9980d5762fbcc00b3537e757",
    "state" : "available",
    "created_at" : "2020-03-11T15:13:31Z",
    "updated_at" : "2020-03-11T15:13:31Z"
  }, {
    "id" : "6f83b848-8331-4271-ac0c-ef94b7686403",
    "name" : "vpc-002",
    "description" : "for test",
    "resource_id" : "4b8567f6-358f-4a7f-8cd3-3cbb82c0b25f",
    "resource_type" : "vpc",
    "project_id" : "0605767a9980d5762fbcc00b3537e757",
    "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" : "b715e131-3371-4e17-a2de-4f669e24439a"
}

Status Codes¶

Status Code	Description
200	OK

Error Codes¶

See Error Codes.

last updated: 2024-07-04 01:07