華為云計算 云知識 查詢租戶的托管專線列表ListHostedDirectConnects
查詢租戶的托管專線列表ListHostedDirectConnects

 

功能介紹

查詢合作伙伴創(chuàng)建的托管專線連接列表.

調試

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

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

最小長度:0

最大長度:10240

響應參數

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

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

缺省值:true

vlan

Integer

hosted物理專線預分配的vlan。

最小值:0

最大值:3999

status

String

操作狀態(tài),合法值是:ACTIVE, ERROR,PENDING_CREATE,PENDING_UPDATE。ACTIVE:虛擬網關正常ERROR: 虛擬網關異常PENDING_CREATE:創(chuàng)建中PENDING_UPDATE:更新中

枚舉值:

  • 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

表6 PageInfo

參數

參數類型

描述

previous_marker

String

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

最小長度:0

最大長度:36

current_count

Integer

當前列表中資源數量

最小值:0

最大值:2000

next_marker

String

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

最小長度:0

最大長度:36

請求示例

查詢合作伙伴創(chuàng)建的托管專線列表

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

響應示例

狀態(tài)碼: 200

OK

{
  "request_id" : "a59a3776faa1d055f8124dc7b0977a90",
  "hosted_connects" : [ {
    "id" : "0278b472-ffa5-4eb3-8c0d-979d479f8ef6",
    "name" : "client-dc-faf1",
    "description" : "connect to beijing",
    "tenant_id" : "0605768a3300d5762f82c01180692873",
    "hosting_id" : "2cfb53be-b05f-40d5-a2f8-3a59ac383836",
    "vlan" : 441,
    "bandwidth" : 10,
    "location" : "hangzhou",
    "peer_location" : "",
    "provider" : "client-dc-faf1%20\n\n",
    "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"
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。