华为云计算 云知识 查询物理连接列表ListDirectConnects
查询物理连接列表ListDirectConnects

 

功能介绍

查询租户创建的所有的direct connect对象.

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v3/{project_id}/dcaas/direct-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_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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:10240

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

操作请求ID

direct_connects

Array of DirectConnect objects

物理专线对象列表

page_info

PageInfo object

分页查询页的信息

表5 DirectConnect

参数

参数类型

描述

id

String

物理专线标识符ID

tenant_id

String

实例所属项目ID。

name

String

物理专线名字

最小长度:0

最大长度:64

description

String

物理专线描述信息

最小长度:0

最大长度:128

port_type

String

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

枚举值:

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

缺省值:standard

枚举值:

  • standard

  • hosting

  • hosted

hosting_id

String

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

charge_mode

String

计费模式:prepayment/bandwidth/traffic

枚举值:

  • prepayment

  • bandwidth

  • traffic

provider

String

物理专线连接的线路运营商如:中国电信 中国联通 中国移动 中国其他 境外其他专线归属的运营商

admin_state_up

Boolean

管理状态:true或false

缺省值:true

vlan

Integer

为托管hosted物理专线分配的vlan。

最小值:0

最大值:3999

status

String

资源状态,合法值是:ACTIVE,DOWN,BUILD,ERROR,PENDING_DELETE,DELETED,APPLY,DENY,PENDING_PAY,PAID,ORDERING,ACCEPT,REJECTED

枚举值:

  • BUILD

  • PAID

  • APPLY

  • PENDING_SURVEY

  • ACTIVE

  • DOWN

  • ERROR

  • PENDING_DELETE

  • DELETED

  • DENY

  • PENDING_PAY

  • ORDERING

  • ACCEPT

  • REJECTED

apply_time

String

物理专线的申请时间

create_time

String

物理专线的创建时间

provider_status

String

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

枚举值:

  • 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

枚举值:

  • default

lag_id

String

物理专线归属的链路聚合组(lag)的ID

signed_agreement_status

String

专线协议的签暑状态

枚举值:

  • signed

enterprise_project_id

String

实例所属企业项目ID

最小长度:36

最大长度:36

tags

Array of Tag objects

标签信息

数组长度:0 - 10

表6 Tag

参数

参数类型

描述

key

String

标签键,最大长度36个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,中文。

最小长度:0

最大长度:36

value

String

标签值,最大长度43个unicode字符,格式为大小写字母,数字,中划线“-”,下划线“_”,点“.”,中文。

最小长度:0

最大长度:43

表7 PageInfo

参数

参数类型

描述

previous_marker

String

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

最小长度:0

最大长度:36

current_count

Integer

当前列表中资源数量

最小值:0

最大值:2000

next_marker

String

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

最小长度:0

最大长度:36

请求示例

查询物理连接列表

GET https://{dc_endpoint}/v3/6fbe9263116a4b68818cf1edce16bc4f/dcaas/direct-connects

响应示例

状态码: 200

OK

{
  "request_id" : "9a4f4dfc4fb2fc101e65bba07d908535",
  "direct_connects" : [ {
    "bandwidth" : 100,
    "create_time" : "2018-10-19 09:53:26.389556",
    "port_type" : "10G",
    "id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
    "apply_time" : "2018-10-19 09:53:26.389556",
    "peer_location" : "",
    "location" : "Biere",
    "provider" : "OTC",
    "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" : "",
    "charge_mode" : ""
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

 

上一篇:华为云CDN全站加速使能企业服务体验升级 下一篇:好会计功能介绍-税务