查询物理连接列表 - ListDirectConnects
功能介绍
查询租户创建的所有的物理连接。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
dcaas:directConnect:list
List
directConnect *
-
-
-
-
g:EnterpriseProjectId
URI
GET /v3/{project_id}/dcaas/direct-connects
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取 约束限制: 不涉及 取值范围: 32 位十六进制字符(0-9, a-f, A-F) 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页返回的个数。 约束限制: 不涉及 取值范围: 1~2000。 默认取值: 2000 |
| marker | 否 | String | 参数解释: 上一页最后一条资源记录的ID,为空时为查询第一页。 约束限制: 必须与limit一起使用。 取值范围: 长度不超过36个字符 默认取值: 不涉及 |
| fields | 否 | Array of strings | 参数解释: 显示字段列表,数组中每个字符串为虚拟接口对象的字段名(如 id、name、admin_state_up、bandwidth、status 等) 约束限制: 数组长度为1~5 取值范围: 不涉及 默认取值: 不涉及 |
| sort_key | 否 | String | 参数解释: 排序字段。 约束限制: 不涉及 取值范围: 只能由字母、数字及连字符组成,长度不超过36个字符 默认取值: id |
| sort_dir | 否 | Array of strings | 参数解释: 返回结果按照升序(asc)或降序(desc)排列,默认为asc 约束限制: 不涉及 |
| hosting_id | 否 | Array of strings | 参数解释: 根据运营专线ID过滤托管专线列表 约束限制: 数组长度为0~5 |
| enterprise_project_id | 否 | Array of strings | 参数解释: 根据企业项目ID过滤资源实例。获取方式:可通过企业项目管理服务查询获取 约束限制: 数组长度为1~10 |
| id | 否 | Array of strings | 参数解释: 根据资源ID过滤实例。获取方式:可通过查询虚拟接口列表(ListVirtualInterfaces)接口获取 约束限制: 数组长度为1~5 |
| name | 否 | Array of strings | 参数解释: 根据名称过滤查询,可查询多个名称。 约束限制: 数组长度为1~5 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释: 操作请求ID 取值范围: 不涉及 |
| direct_connects | Array of DirectConnect objects | 参数解释: 物理专线对象列表 |
| page_info | PageInfo object | 参数解释: 分页查询页的信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 参数解释: 物理专线标识符ID 取值范围: 不涉及 |
| tenant_id | String | 参数解释: 实例所属项目ID。 取值范围: 不涉及 |
| name | String | 参数解释: 物理专线名称 取值范围: 长度不超过64个字符 |
| description | String | 参数解释: 物理专线描述信息 取值范围: 长度不超过128个字符 |
| port_type | String | 参数解释: 物理专线接入接口的类型,支持1G、10G、40G、100G。 取值范围: |
| bandwidth | Integer | 参数解释: 物理专线接入带宽,单位Mbps。 取值范围: 不涉及 |
| location | String | 参数解释: 专线的接入位置信息 取值范围: 长度不超过255个字符 |
| peer_location | String | 参数解释: 物理专线对端所在的物理位置,省/市/街道或IDC名称。 取值范围: 长度不超过255个字符 |
| device_id | String | 参数解释: 物理专线连接的设备的标识ID 取值范围: 长度不超过36个字符 |
| type | String | 参数解释: 物理专线的类型,类型包括标准(standard),运营专线(hosting),托管专线(hosted),一站式标准(onestop_standard),一站式托管(onestop_hosted)。 取值范围: |
| hosting_id | String | 参数解释: hosted物理专线对应的hosting物理专线的ID 取值范围: UUID 格式,以连字符(-)连接 |
| charge_mode | String | 参数解释: 计费模式 取值范围: |
| provider | String | 参数解释: 提供物理专线连接的线路运营商。 取值范围: |
| admin_state_up | Boolean | 参数解释: 管理状态 取值范围: true、false |
| vlan | Integer | 参数解释: 为托管hosted物理专线分配的vlan。 取值范围: 0~3999 |
| status | String | 参数解释: 资源状态,合法值是: 取值范围: |
| apply_time | String | 参数解释: 物理专线的申请时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ |
| create_time | String | 参数解释: 物理专线的创建时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ |
| provider_status | String | 参数解释: 物理专线的运营商操作状态。 取值范围: |
| peer_port_type | String | 参数解释: 连接对端的端口类型, 取值范围: 1G、10G、40G、100G |
| peer_provider | String | 参数解释: 专线连接对接的运营商 取值范围: 不涉及 |
| order_id | String | 参数解释: 物理专线对应订单号,用于支持包周期计费,识别用户订单 取值范围: 不涉及 |
| product_id | String | 参数解释: 物理专线订单对应产品标识,用于订制包周期套餐等计费策略 取值范围: 不涉及 |
| spec_code | String | 参数解释: 物理专线订单对应产品规格,用于订制包周期套餐等计费策略 取值范围: 不涉及 |
| period_type | Integer | 参数解释: 物理专线对应订单号对应包周期的类型。 取值范围: |
| period_num | Integer | 参数解释: 物理专线对应的包周期时间 取值范围: 不涉及 |
| vgw_type | String | 参数解释: 专线要求的网关类型 取值范围: |
| lag_id | String | 参数解释: 物理专线归属的链路聚合组(lag)的ID 取值范围: UUID 格式,以连字符(-)连接 |
| signed_agreement_status | String | 参数解释: 专线协议的签署状态。 取值范围: |
| signed_agreement_time | String | 参数解释: 专线协议的签署时间。采用UTC时间格式,格式为:yyyy-MM-ddTHH:mm:ss.SSSZ |
| enterprise_project_id | String | 参数解释: 实例所属企业项目ID。 取值范围: 最大长度36字节,带"-"连字符的UUID格式,或者是字符串"0","0"表示默认企业项目。 |
| tags | Array of Tag objects | 参数解释: 标签信息 |
| locales | LocalesBody object | 参数解释: Locale地址描述信息。 |
| support_feature | Array of strings | 参数解释: 用户专线可支持的特性列表 |
| ies_id | String | 参数解释: 归属的CloudPond站点的ID 取值范围: 不涉及 |
| reason | String | 参数解释: 如果专线资源的状态是Error的情况下,该参数会显示相关错误信息。 取值范围: 不涉及 |
| | String | 参数解释: 客户邮箱信息 取值范围: 邮箱格式,由中文字符、数字(0~9)、小写字母(a~z)、大写字母(A~Z)、下划线(_)、点(.)、中划线(-)组成,以 @ 符号分隔用户名与域名,域名中至少包含一个点(.) |
| onestop_product_id | String | 参数解释: 该参数用于销售线路场景,标识一站式专线产品ID 取值范围: 不涉及 |
| building_line_product_id | String | 参数解释: 该参数用于销售线路场景,标识机房内部线路资源产品ID 取值范围: 不涉及 |
| last_onestop_product_id | String | 参数解释: 该参数用于销售线路场景,标识变更前的一站式专线产品ID,用于在做线路带宽变更时保存上一次的记录。 取值范围: 不涉及 |
| last_building_line_product_id | String | 参数解释: 该参数用于销售线路场景,标识变更前机房内部线路资源产品ID,用于在做线路带宽变更时保存上一次的记录。 取值范围: 不涉及 |
| modified_bandwidth | Integer | 参数解释: 线路带宽变更后的带宽值 取值范围: 不涉及 |
| change_mode | Integer | 参数解释: 标识续费变更的一种状态 取值范围: 不涉及 |
| onestopdc_status | String | 参数解释: 一站式专线状态。 取值范围: |
| public_border_group | String | 参数解释: 归属的可用区对应的边界组(public border group),标识是否homezone局点。 取值范围: 不涉及 |
| auto_renew | Integer | 参数解释: 用于标识包周期产品是否自动续订 取值范围: 不涉及 |
| ratio_95peak | Integer | 参数解释: 95计费保底带宽率 取值范围: 0~100 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| key | String | 参数解释: 标签键 取值范围: 取值可以包含任意语种字母、数字、空格,以及_.:=+-@特殊字符,但首尾不能含有空格,不能以_sys_开头;长度为1~128个字符 |
| value | String | 参数解释: 标签值 取值范围: 可以包含任意语种字母、数字、空格,以及_.:/=+-@特殊字符;长度不超过255个字符 |
请求示例
查询物理连接列表
GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects 响应示例
状态码:200
-
{ "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535", "direct_connects" : [ { "bandwidth" : 100, "create_time" : "2018-10-19T07:08:11.000Z", "port_type" : "10G", "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "apply_time" : "2018-10-19T07:08:11.000Z", "peer_location" : "", "peer_port_type" : null, "peer_provider" : null, "location" : "ExampleLocation", "provider" : "others", "type" : "standard", "status" : "BUILD", "description" : "", "provider_status" : "ACTIVE", "order_id" : "", "vlan" : null, "device_id" : "172.16.40.2", "name" : "direct connect1", "admin_state_up" : true, "tenant_id" : "6fbe9263116a4b68818cf1edce16bc4f", "hosting_id" : null, "product_id" : "", "vgw_type" : "default", "spec_code" : "100ge", "charge_mode" : null, "support_feature" : [ ], "ies_id" : null, "reason" : null, "email" : "cloud@example.com", "onestop_product_id" : null, "building_line_product_id" : null, "last_building_line_product_id" : null, "last_onestop_product_id" : null, "modified_bandwidth" : null, "change_mode" : null, "onestopdc_status" : null, "public_border_group" : "center", "auto_renew" : 0, "ratio_95peak" : null } ], "page_info" : { "previous_marker" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "current_count" : 1 } }
SDK代码示例
SDK代码示例如下。
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 | 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.*; public class ListDirectConnectsSolution { 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); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); ListDirectConnectsRequest request = new ListDirectConnectsRequest(); try { ListDirectConnectsResponse response = client.listDirectConnects(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 | # coding: utf-8 import os 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.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListDirectConnectsRequest() response = client.list_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) |
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 39 40 41 42 43 44 45 46 47 48 49 | 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") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dc.DcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dc.NewDcClient(hcClient) request := &model.ListDirectConnectsRequest{} response, err := client.ListDirectConnects(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。