文档首页/ 云专线 DC/ API参考/ API/ 物理连接/ 查询租户的托管专线列表
更新时间:2024-10-21 GMT+08:00

查询租户的托管专线列表

功能介绍

查询合作伙伴创建的托管专线连接列表.

调用方法

请参见如何调用API

URI

GET /v3/{project_id}/dcaas/hosted-connects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

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

最小值:1

最大值:2000

缺省值:2000

marker

String

上一页最后一条资源记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。

最小长度:0

最大长度:36

fields

Array

显示字段列表

数组长度:1 - 5

sort_dir

Array

返回结果按照升序(asc)或降序(desc)排列,默认为asc

sort_key

String

排序字段。

缺省值:id

最小长度:0

最大长度:36

hosting_id

Array

根椐运营专线ID过滤托管专线列表

数组长度:0 - 5

id

Array

根据资源ID过滤实例

数组长度:1 - 5

name

Array

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

数组长度:1 - 5

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

最小长度:0

最大长度:10240

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

本次操作的请求ID

hosted_connects

Array of HostedDirectConnect objects

托管专线对象信息

page_info

PageInfo object

分页查询页的信息

表5 HostedDirectConnect

参数

参数类型

描述

id

String

托管专线ID

最小长度:36

最大长度:36

tenant_id

String

实例所属项目ID。

name

String

物理专线名字

最小长度:0

最大长度:64

description

String

物理专线的描述信息

最小长度:0

最大长度:128

bandwidth

Integer

物理专线接入带宽,单位Mbps。

最小值:2

最大值:400000

location

String

专线的接入位置信息

最小长度:0

最大长度:255

peer_location

String

物理专线对端所在的物理位置,省/市/街道或IDC名字。

最小长度:0

最大长度:255

hosting_id

String

hosted物理专线对应的hosting物理专线的ID

provider

String

专线线路的提供商

admin_state_up

Boolean

管理状态:true或false

缺省值:true

vlan

Integer

hosted物理专线预分配的vlan。

最小值:0

最大值:3999

status

String

操作状态,合法值是: BUILD:已开通 ACTIVE:物理连接正常 DOWN:专线对应的端口处于down的状态,可能存在线路故障等异常。 ERROR:专线配置异常 PENDING_DELETE:删除中 PENDING_UPDATE:更新中 PENDING_CREATE:创建中

枚举值:

  • BUILD
  • ACTIVE
  • DOWN
  • ERROR
  • PENDING_DELETE
  • PENDING_UPDATE
  • PENDING_CREATE

apply_time

String

物理专线申请时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ

create_time

String

物理专线创建时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ

provider_status

String

物理专线的运营商操作状态,合法值是:ACTIVE, DOWN

枚举值:

  • ACTIVE
  • DOWN

port_type

String

物理专线接入接口的类型,支持1G 10G 40G 100G

枚举值:

  • 1G
  • 10G
  • 40G
  • 100G

type

String

物理专线的类型,类型为托管专线(hosted)。

缺省值:hosted

表6 PageInfo

参数

参数类型

描述

previous_marker

String

上一页的marker,值为资源的uuid

最小长度:0

最大长度:36

current_count

Integer

当前列表中资源数量

最小值:0

最大值:2000

next_marker

String

下一页的marker,值为资源的uuid,为空时表示最后一页

最小长度:0

最大长度:36

请求示例

查询合作伙伴创建的托管专线列表

POST https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/hosted-connects

响应示例

状态码: 200

OK

  • 成功查询托管专线连接列表
    {
      "request_id" : "a59a3776faa1d055f8124dc7b0977a90",
      "hosted_connects" : [ {
        "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
        "name" : "client-dc-faf1",
        "description" : "Hosted Connect",
        "tenant_id" : "0605768a3300d5762f82c01180692873",
        "hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836",
        "vlan" : 441,
        "bandwidth" : 10,
        "location" : "ExampleLocation",
        "peer_location" : "",
        "provider" : "ExampleProvider",
        "type" : "hosted",
        "port_type" : "10G",
        "provider_status" : "ACTIVE",
        "status" : "ACTIVE",
        "apply_time" : "2022-07-13T08:25:38.000Z",
        "admin_state_up" : true,
        "create_time" : "2022-07-13T08:25:38.000Z"
      } ]
    }

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
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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;

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

public class ListHostedDirectConnectsSolution {

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

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        ListHostedDirectConnectsRequest request = new ListHostedDirectConnectsRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withFields();
        request.withSortDir();
        request.withSortKey("<sort_key>");
        request.withHostingId();
        request.withId();
        request.withName();
        try {
            ListHostedDirectConnectsResponse response = client.listHostedDirectConnects(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
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = ListHostedDirectConnectsRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.fields = 
        request.sort_dir = 
        request.sort_key = "<sort_key>"
        request.hosting_id = 
        request.id = 
        request.name = 
        response = client.list_hosted_direct_connects(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/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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 := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

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

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

状态码

状态码

描述

200

OK

错误码

请参见错误码