Help Center/ Enterprise Router/ API Reference/ APIs/ Other Types of Attachments/ Querying Details About an Attachment
Updated on 2024-04-19 GMT+08:00

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}

Table 1 Path Parameters

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

Table 2 Response body parameters

Parameter

Type

Description

attachment

AttachmentResponse object

Attachment basic information

request_id

String

Request ID

Table 3 AttachmentResponse

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.

  • vpc: VPC attachment

  • vpn: VPN gateway attachment

  • vgw: virtual gateway attachment

  • peering: peering connection attachments. A cloud connection is used to connect two enterprise routers from different regions.

  • ecn: ECN attachment

  • cfw: CFW instance attachment

resource_project_id

String

ID of the project that the resource belongs to

Table 4 Tag

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.

  • Tag values consist of letters, digits, spaces, and special characters _.:=+-@

  • Tag values can contain 0 to 255 characters.

  • Tag values can be left blank or set to null.

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"
}

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
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 ShowAttachmentSolution {

    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");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ErClient client = ErClient.newBuilder()
                .withCredential(auth)
                .withRegion(ErRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowAttachmentRequest request = new ShowAttachmentRequest();
        try {
            ShowAttachmentResponse response = client.showAttachment(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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = ErClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ErRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowAttachmentRequest()
        response = client.show_attachment(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
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")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := er.NewErClient(
        er.ErClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ShowAttachmentRequest{}
	response, err := client.ShowAttachment(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.