查询物理连接列表
功能介绍
查询租户创建的所有的direct connect对象.
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/dcaas/direct-connects
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
租户项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~2000。 最小值:1 最大值:2000 缺省值:2000 |
marker |
否 |
String |
上一页最后一条资源记录的ID,为空时为查询第一页。 使用说明:必须与limit一起使用。 最小长度:0 最大长度:36 |
fields |
否 |
Array |
显示字段列表 数组长度:1 - 5 |
sort_key |
否 |
String |
排序字段。 缺省值:id 最小长度:0 最大长度:36 |
sort_dir |
否 |
Array |
返回结果按照升序(asc)或降序(desc)排列,默认为asc |
hosting_id |
否 |
Array |
根椐运营专线ID过滤托管专线列表 数组长度:0 - 5 |
enterprise_project_id |
否 |
Array |
根据企业项目ID过滤资源实例 数组长度:1 - 10 |
id |
否 |
Array |
根据资源ID过滤实例 数组长度:1 - 5 |
name |
否 |
Array |
根据名字过滤查询,可查询多个名字。 数组长度:1 - 5 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 获取Token,请参考《统一身份认证服务API参考》的“获取用户Token”章节。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 最小长度:0 最大长度:10240 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
操作请求ID |
direct_connects |
Array of DirectConnect objects |
物理专线对象列表 |
page_info |
PageInfo object |
分页查询页的信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
物理专线标识符ID |
tenant_id |
String |
实例所属项目ID。 |
name |
String |
物理专线名字 最小长度:0 最大长度:64 |
description |
String |
物理专线描述信息 最小长度:0 最大长度:128 |
port_type |
String |
物理专线接入接口的类型,支持1G 10G 40G 100G 枚举值:
|
bandwidth |
Integer |
物理专线接入带宽,单位Mbps。 最小值:2 最大值:100000 |
location |
String |
专线的接入位置信息 最小长度:0 最大长度:255 |
peer_location |
String |
物理专线对端所在的物理位置,省/市/街道或IDC名字。 最小长度:0 最大长度:255 |
device_id |
String |
物理专线连接的设备的标识ID 最小长度:0 最大长度:36 |
type |
String |
物理专线的类型,类型包括标准(standard),运营专线(hosting),托管专线(hosted),一站式标准(onestop_standard),一站式托管(onestop_hosted)。 缺省值:standard 枚举值:
|
hosting_id |
String |
hosted物理专线对应的hosting物理专线的ID |
charge_mode |
String |
计费模式:prepayment/bandwidth/traffic 枚举值:
|
provider |
String |
物理专线连接的线路运营商 如:中国电信 中国联通 中国移动 中国其他 境外其他专线归属的运营商 |
admin_state_up |
Boolean |
管理状态:true或false 缺省值:true |
vlan |
Integer |
为托管hosted物理专线分配的vlan。 最小值:0 最大值:3999 |
status |
String |
资源状态,合法值是: ACTIVE:专线已经开通完成且线路处于正常状态 DOWN:专线对应的端口处于down的状态,可能存在线路故障等异常。 BUILD:申请专线正在施工建设中 ERROR:专线配置异常,请联系客服解决相关问题。 PENDING_DELETE:正在删除 DELETED:已删除 APPLY:申请开通 DENY:客户需求无法满足,拒绝工勘。 PENDING_PAY:待支付 PAID:已支付。PENDING_SURVEY:待工勘。LEASED_LINE_DELIVERY:运营商施工。 枚举值:
|
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 枚举值:
|
peer_port_type |
String |
连接对端的端口类型 |
peer_provider |
String |
专线连接对接的运营商 |
order_id |
String |
物理专线对应订单号,用于支持包周期计费,识别用户订单 |
product_id |
String |
物理专线订单对应产品标识,用于订制包周期套餐等计费策略 |
spec_code |
String |
物理专线订单对应产品规格,用于订制包周期套餐等计费策略 |
period_type |
Integer |
物理专线对应订单号对应包周期的类型 |
period_num |
Integer |
物理专线对应的包周期时间 |
vgw_type |
String |
专线要求的网关类型 缺省值:default 枚举值:
|
lag_id |
String |
物理专线归属的链路聚合组(lag)的ID |
signed_agreement_status |
String |
专线协议的签署状态 枚举值:
|
signed_agreement_time |
String |
专线协议的签署时间 |
enterprise_project_id |
String |
实例所属企业项目ID 最小长度:36 最大长度:36 |
tags |
Array of Tag objects |
标签信息 数组长度:0 - 10 |
locales |
LocalesBody object |
物理专线的区域信息 |
support_feature |
Array of strings |
用户专线可支持的特性列表 |
ies_id |
String |
归属的IES站点的ID |
reason |
String |
如果专线资源的状态是Error的情况下,该参数会显示相关错误信息。 |
|
String |
客户邮箱信息 |
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 |
请求示例
查询物理连接列表
GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects
响应示例
状态码: 200
OK
- 成功查询物理连接列表
{ "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535", "direct_connects" : [ { "bandwidth" : 100, "create_time" : "2018-10-19T09:53:26.000Z", "port_type" : "10G", "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a", "apply_time" : "2018-10-19T09:53:26.000Z", "peer_location" : "", "peer_port_type" : null, "peer_provider" : null, "location" : "ExampleLocation", "provider" : "ExampleProvider", "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 } ] }
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.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 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DcClient client = DcClient.newBuilder() .withCredential(auth) .withRegion(DcRegion.valueOf("<YOUR REGION>")) .build(); ListDirectConnectsRequest request = new ListDirectConnectsRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); request.withFields(); request.withSortKey("<sort_key>"); request.withSortDir(); request.withHostingId(); request.withEnterpriseProjectId(); request.withId(); request.withName(); 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()); } } } |
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 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 = ListDirectConnectsRequest() request.limit = <limit> request.marker = "<marker>" request.fields = request.sort_key = "<sort_key>" request.sort_dir = request.hosting_id = request.enterprise_project_id = request.id = request.name = 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) |
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.ListDirectConnectsRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest response, err := client.ListDirectConnects(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。