文档首页> 云连接 CC> API参考> API> 中心网络的附件管理> 查询中心网络附件列表
更新时间:2024-05-13 GMT+08:00
分享

查询中心网络附件列表

功能介绍

查询中心网络附件列表,分页查询使用的参数为marker、limit。limit默认值为0,没有指定marker时返回第一条数据。

调用方法

请参见如何调用API

URI

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账户ID。

最小长度:10

最大长度:32

central_network_id

String

中心网络的ID。

最小长度:36

最大长度:36

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:1~1000。

最小值:1

最大值:1000

缺省值:1000

marker

String

翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向翻页。 翻页过程中,查询条件不能修改,包括过滤条件,排序条件,limit。

最小长度:1

最大长度:4096

sort_key

String

排序字段。

缺省值:updated_at

最小长度:1

最大长度:36

sort_dir

Object

指定排序是升序还是降序(asc为升序,desc为降序)。

id

Array

根据id查询,可查询多个id。

数组长度:1 - 20

name

Array

根据名字查询,可查询多个名字。

数组长度:1 - 20

attachment_instance_type

Array

根据附件类型查询,可查询多个附件类型。

数组长度:1 - 20

state

Array

根据状态查询,可查询多个状态。

数组长度:1 - 20

attachment_instance_id

Array

Attachment实例的ID。

数组长度:1 - 10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

最小长度:0

最大长度:2000000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

资源ID标识符。

最小长度:32

最大长度:36

page_info

PageInfo object

分页查询页的信息。

central_network_attachments

Array of CentralNetworkAttachment objects

接入网络实例连接列表。

数组长度:0 - 2000

表5 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

最小长度:1

最大长度:4096

previous_marker

String

向前分页标识符。

最小长度:1

最大长度:4096

current_count

Integer

当前列表中资源数量。

最小值:0

最大值:2000

表6 CentralNetworkAttachment

参数

参数类型

描述

id

String

资源ID标识符。

name

String

实例名字。

description

String

实例描述。不支持 <>。

最小长度:0

最大长度:255

domain_id

String

实例所属账号ID。

state

String

中心网络附件状态。

  • AVAILABLE (可用)

  • CREATING (创建中)

  • UPDATING (更新中)

  • DELETING (删除中)

  • FREEZING (冻结中)

  • UNFREEZING (解冻中)

  • RECOVERING (恢复中)

  • FAILED (失败)

  • DELETED (已刪除)

  • APPROVING (审批中)

  • APPROVED (已审批)

  • UNAPPROVED (审批未通过)

created_at

String

实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

central_network_id

String

中心网络ID。

central_network_plane_id

String

中心网络平面ID。

global_connection_bandwidth_id

String

全域互联带宽ID。

bandwidth_type

String

带宽类型包括:

  • BandwidthPackage (按带宽计费,需要绑定全域互联带宽,并指定分配带宽大小)

  • TestBandwidth (不收费的测试带宽,仅保留最小带宽,用于测试跨地域连通性)

bandwidth_size

Integer

带宽值定义,单位Mbps。

is_frozen

Boolean

是否冻结

enterprise_router_id

String

企业路由器的ID。

enterprise_router_project_id

String

企业路由器的项目ID。

enterprise_router_region_id

String

ER路由器的region ID。

enterprise_router_attachment_id

String

企业路由器的连接ID。

attachment_instance_type

String

接入网络实例类型,GDGW (专线)和ER_ROUTE_TABLE (路由表)。

attachment_instance_id

String

中心网络附件对端实例ID,企业路由器的路由表ID或者GDGW的ID。

attachment_id

String

中心网络附件对端实例的连接ID,企业路由器的连接ID或者GDGW的连接ID。

attachment_instance_project_id

String

中心网络附件对端实例的项目ID。

attachment_instance_region_id

String

中心网络附件对端实例的regionID。

attachment_instance_site_code

String

中心网络附件对端实例的站点编码。

enterprise_router_site_code

String

企业路由器的站点编码。

specification_value

CentralNetworkAttachmentSpecificationValueInfo object

附件的额外信息。

表7 CentralNetworkAttachmentSpecificationValueInfo

参数

参数类型

描述

enterprise_router_table_id

String

企业路由器的路由表ID。

attached_er_id

String

路由表附件的额外信息,附件的企业路由器ID。

approved_state

String

审批状态。

  • APPROVING (审批中)

  • APPROVED (已审批)

  • UNAPPROVED (审批未通过)

hosted_cloud

String

  • HWCloud (华为云)

  • Ireland (爱尔兰)

reason

String

审批拒绝创建附件的原因。

最小长度:0

最大长度:1024

请求示例

查询中心网络附件列表

GET /v3/{domain_id}/gcn/central-network/{central_network_id}/attachments

响应示例

状态码: 200

查询接入网络实例连接列表成功。

{
  "request_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
  "page_info" : {
    "next_marker" : "8EDF12u71N...",
    "previous_marker" : "8EDF12u71N...",
    "current_count" : 1
  },
  "central_network_attachments" : [ {
    "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "name" : "name",
    "description" : "description",
    "domain_id" : "XXX",
    "state" : "AVAILABLE",
    "created_at" : "2023-10-09T10:13:57.962Z",
    "updated_at" : "2023-10-09T10:13:57.962Z",
    "central_network_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "central_network_plane_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "global_connection_bandwidth_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "bandwidth_type" : "BandwidthPackage",
    "bandwidth_size" : 20,
    "is_frozen" : false,
    "enterprise_router_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "enterprise_router_project_id" : "XXX",
    "enterprise_router_region_id" : "cn-north-4",
    "enterprise_router_attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "attachment_instance_type" : "GDGW",
    "attachment_instance_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "attachment_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
    "attachment_instance_project_id" : "XXX",
    "attachment_instance_region_id" : "cn-north-4",
    "attachment_instance_site_code" : "cn-north-bj4",
    "enterprise_router_site_code" : "cn-north-bj4",
    "specification_value" : {
      "enterprise_router_table_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
      "attached_er_id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
      "approved_state" : "APPROVING",
      "hosted_cloud" : "HWCloud",
      "reason" : "string"
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

 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
49
50
51
52
53
54
55
56
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class ListCentralNetworkAttachmentsSolution {

    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 GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListCentralNetworkAttachmentsRequest request = new ListCentralNetworkAttachmentsRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withSortKey("<sort_key>");
        request.withSortDir();
        request.withId();
        request.withName();
        request.withAttachmentInstanceType();
        request.withState();
        request.withAttachmentInstanceId();
        try {
            ListCentralNetworkAttachmentsResponse response = client.listCentralNetworkAttachments(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());
        }
    }
}
 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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.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 = GlobalCredentials(ak, sk) \

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

    try:
        request = ListCentralNetworkAttachmentsRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.sort_key = "<sort_key>"
        request.sort_dir = 
        request.id = 
        request.name = 
        request.attachment_instance_type = 
        request.state = 
        request.attachment_instance_id = 
        response = client.list_central_network_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)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListCentralNetworkAttachmentsRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	response, err := client.ListCentralNetworkAttachments(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询接入网络实例连接列表成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品