Querying Attachments
Function
This API is used to query the attachments of the enterprise router.
Constraints
There are some constraints:
-
Filtering query is supported. The supported 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.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.
|
Action |
Access Level |
Resource Type (*: required) |
Condition Key |
Alias |
Dependencies |
|---|---|---|---|---|---|
|
er:commonAttachments:list |
List |
attachments * |
- |
|
- |
URI
GET /v3/{project_id}/enterprise-router/{er_id}/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 returned on each page. The value ranges from 1 to 2000. Minimum: 1 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 |
|
|
resource_type |
No |
Array of strings |
|
|
resource_id |
No |
Array of strings |
Attachment resource IDs |
|
sort_key |
No |
Array of strings |
|
|
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. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
attachments |
Array of AttachmentDetails objects |
Attachments |
|
page_info |
PageInfo object |
Pagination query information |
|
request_id |
String |
Request ID |
|
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, initiating_request, and freezed |
|
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.sssZ |
|
tags |
Array of Tag objects |
Attachment tags. |
|
project_id |
String |
Project ID |
|
er_id |
String |
Enterprise router ID |
|
resource_id |
String |
Attached resource ID on its own service console |
|
resource_type |
String |
|
|
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 |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
Tag key.
Minimum: 1 Maximum: 128 |
|
value |
String |
Tag value.
Minimum: 0 Maximum: 255 |
Example Requests
Querying attachments
GET https://{erouter_endpoint}/v3/08d5a9564a704afda6039ae2babbef3c/enterprise-router/4ab54142-7c92-48ad-8288-77727a231052/attachments
Example Responses
Status code: 200
OK
{
"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"
}
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 |
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.*; public class ListAttachmentsSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ErClient client = ErClient.newBuilder() .withCredential(auth) .withRegion(ErRegion.valueOf("<YOUR REGION>")) .build(); ListAttachmentsRequest request = new ListAttachmentsRequest(); request.withErId("{er_id}"); try { ListAttachmentsResponse response = client.listAttachments(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 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ErClient.new_builder() \ .with_credentials(credentials) \ .with_region(ErRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAttachmentsRequest() request.er_id = "{er_id}" response = client.list_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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := er.NewErClient( er.ErClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAttachmentsRequest{} request.ErId = "{er_id}" response, err := client.ListAttachments(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