華為云計算 云知識 查詢物理連接列表ListDirectConnects
查詢物理連接列表ListDirectConnects

 

功能介紹

查詢租戶創(chuàng)建的所有的direct connect對象.

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

租戶項目ID

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

limit

Integer

每頁返回的個數(shù)。 取值范圍:1~2000。

最小值:1

最大值:2000

缺省值:2000

marker

String

上一頁最后一條資源記錄的ID,為空時為查詢第一頁。 使用說明:必須與limit一起使用。

最小長度:0

最大長度:36

fields

Array

顯示字段列表

數(shù)組長度:1 - 5

sort_key

String

排序字段。

缺省值:id

最小長度:0

最大長度:36

sort_dir

Array

返回結(jié)果按照升序(asc)或降序(desc)排列,默認為asc

hosting_id

Array

根椐運營專線ID過濾托管專線列表

數(shù)組長度:0 - 5

enterprise_project_id

Array

根據(jù)企業(yè)項目ID過濾資源實例

數(shù)組長度:1 - 10

id

Array

根據(jù)資源ID過濾實例

數(shù)組長度:1 - 5

name

Array

根據(jù)名字過濾查詢,可查詢多個名字。

數(shù)組長度:1 - 5

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 獲取Token ,請參考《 統(tǒng)一身份認證 服務API參考》的“獲取用戶Token”章節(jié)。請求響應成功后在響應消息頭中包含的“X-Subject-Token”的值即為Token值。

最小長度:0

最大長度:10240

響應參數(shù)

狀態(tài)碼: 200

表4 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

request_id

String

操作請求ID

direct_connects

Array of DirectConnect objects

物理專線對象列表

page_info

PageInfo object

分頁查詢頁的信息

表5 DirectConnect

參數(shù)

參數(shù)類型

描述

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

物理專線連接的設(shè)備的標識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

物理專線連接的線路運營商如:中國電信 中國聯(lián)通 中國移動 中國其他 境外其他專線歸屬的運營商

admin_state_up

Boolean

管理狀態(tài):true或false

缺省值:true

vlan

Integer

為托管hosted物理專線分配的vlan。

最小值:0

最大值:3999

status

String

資源狀態(tài),合法值是: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

物理專線的創(chuàng)建時間

provider_status

String

物理專線的運營商操作狀態(tài),合法值是:ACTIVE, DOWN

枚舉值:

  • ACTIVE

  • DOWN

peer_port_type

String

連接對端的端口類型

peer_provider

String

專線連接對接的運營商

order_id

String

物理專線對應訂單號,用于支持包周期計費,識別用戶訂單

product_id

String

物理專線訂單對應產(chǎn)品標識,用于訂制包周期套餐等計費策略

spec_code

String

物理專線訂單對應產(chǎn)品規(guī)格,用于訂制包周期套餐等計費策略

period_type

Integer

物理專線對應訂單號對應包周期的類型

period_num

Integer

物理專線對應的包周期時間

vgw_type

String

專線要求的網(wǎng)關(guān)類型

缺省值:default

枚舉值:

  • default

lag_id

String

物理專線歸屬的鏈路聚合組(lag)的ID

signed_agreement_status

String

專線協(xié)議的簽暑狀態(tài)

枚舉值:

  • signed

enterprise_project_id

String

實例所屬企業(yè)項目ID

最小長度:36

最大長度:36

tags

Array of Tag objects

標簽信息

數(shù)組長度:0 - 10

表6 Tag

參數(shù)

參數(shù)類型

描述

key

String

標簽鍵,最大長度36個unicode字符,格式為大小寫字母,數(shù)字,中劃線“-”,下劃線“_”,中文。

最小長度:0

最大長度:36

value

String

標簽值,最大長度43個unicode字符,格式為大小寫字母,數(shù)字,中劃線“-”,下劃線“_”,點“.”,中文。

最小長度:0

最大長度:43

表7 PageInfo

參數(shù)

參數(shù)類型

描述

previous_marker

String

上一頁的marker,值為資源的uuid

最小長度:0

最大長度:36

current_count

Integer

當前列表中資源數(shù)量

最小值:0

最大值:2000

next_marker

String

下一頁的marker,值為資源的uuid,為空時表示最后一頁

最小長度:0

最大長度:36

請求示例

查詢物理連接列表

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

響應示例

狀態(tài)碼: 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" : ""
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。