華為云計(jì)算 云知識 查詢連接終端節(jié)點(diǎn)服務(wù)的連接列表ListServiceConnections
查詢連接終端節(jié)點(diǎn)服務(wù)的連接列表ListServiceConnections

 

功能介紹

查詢連接當(dāng)前用戶下的某一個(gè)終端節(jié)點(diǎn)服務(wù)的連接列表。marker_id是連接的唯一標(biāo)識。

調(diào)試

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

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID。

最小長度:1

vpc_endpoint_service_id

String

終端節(jié)點(diǎn)服務(wù)的ID。

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

id

String

終端節(jié)點(diǎn)的ID,唯一標(biāo)識。

marker_id

String

終端節(jié)點(diǎn)的報(bào)文標(biāo)識。

status

String

終端節(jié)點(diǎn)的連接狀態(tài)。 ● pendingAcceptance:待接受 ● accepted:已接受 ● rejected:已拒絕 ● failed:失敗

sort_key

String

查詢結(jié)果中終端節(jié)點(diǎn)列表的排序字段,取值為: ● create_at:終端節(jié)點(diǎn)的創(chuàng)建時(shí)間 ● update_at:終端節(jié)點(diǎn)的更新時(shí)間 默認(rèn)值為create_at。

缺省值:create_at

sort_dir

String

查詢結(jié)果中終端節(jié)點(diǎn)列表的排序方式,取值為: ● desc:降序排序 ● asc:升序排序 默認(rèn)值為desc。

缺省值:desc

limit

Integer

查詢返回終端節(jié)點(diǎn)服務(wù)的連接列表限制每頁個(gè)數(shù),即每頁返回的個(gè)數(shù)。 取值范圍:0~1000,取值一般為10,20或者50,默認(rèn)為10。

最小值:1

最大值:1000

缺省值:10

offset

Integer

偏移量。 偏移量為一個(gè)大于0小于終端節(jié)點(diǎn)服務(wù)總個(gè)數(shù)的整數(shù), 表示從偏移量后面的終端節(jié)點(diǎn)服務(wù)開始查詢。

最小值:0

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。

Content-Type

String

發(fā)送的實(shí)體的MIME類型。推薦用戶默認(rèn)使用application/json, 如果API是對象、 鏡像 上傳等接口,媒體類型可按照流類型的不同進(jìn)行確定。

缺省值:application/json

響應(yīng)參數(shù)

狀態(tài)碼: 200

表4 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

connections

Array of ConnectionEndpoints objects

連接列表。

total_count

Integer

滿足查詢條件的終端節(jié)點(diǎn)總條數(shù),不受分頁(即limit、offset參數(shù))影響。

表5 ConnectionEndpoints

參數(shù)

參數(shù)類型

描述

id

String

終端節(jié)點(diǎn)的ID,唯一標(biāo)識。

marker_id

Integer

終端節(jié)點(diǎn)的報(bào)文標(biāo)識。

created_at

String

終端節(jié)點(diǎn)的創(chuàng)建時(shí)間。 采用UTC時(shí)間格式,格式為:YYYY-MMDDTHH:MM:SSZ

updated_at

String

終端節(jié)點(diǎn)的更新時(shí)間。 采用UTC時(shí)間格式,格式為:YYYY-MMDDTHH:MM:SSZ

domain_id

String

用戶的Domain ID。

error

Array of QueryError objects

錯(cuò)誤信息。

當(dāng)終端節(jié)點(diǎn)服務(wù)狀態(tài)異常,即“status”的值為“failed”時(shí),會返回該字段。

status

String

終端節(jié)點(diǎn)的連接狀態(tài)。 ● pendingAcceptance:待接受 ● creating:創(chuàng)建中 ● accepted:已接受 ● rejected:已拒絕 ● failed:失敗 ● deleting:刪除中

description

String

終端節(jié)點(diǎn)連接描述。

表6 QueryError

參數(shù)

參數(shù)類型

描述

error_code

String

錯(cuò)誤編碼。

error_message

String

錯(cuò)誤信息。

狀態(tài)碼: 400

表7 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表8 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 401

表9 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表10 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 403

表11 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表12 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 404

表13 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表14 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 405

表15 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表16 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 406

表17 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表18 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 407

表19 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表20 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 408

表21 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表22 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 409

表23 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表24 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 500

表25 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表26 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 501

表27 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表28 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 502

表29 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表30 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 503

表31 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表32 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

狀態(tài)碼: 504

表33 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時(shí)返回的異常信息

表34 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯(cuò)誤信息描述

code

String

任務(wù)異常錯(cuò)誤信息編碼

請求示例

查詢連接終端節(jié)點(diǎn)服務(wù)的連接列表

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections? 
id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key }&sort_dir={sort_dir}&limit={limit}&
offset={offset} 查詢連接ID為“4189d3c2-8882-4871-a3c2-d380272eed88”的終端節(jié)點(diǎn)服務(wù)連接列表。 GET https://{endpoint}/v1/{project_id}/
vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections

響應(yīng)示例

狀態(tài)碼: 200

服務(wù)器已成功處理了請求

{
  "connections" : [ {
    "id" : "adb7b229-bb11-4072-bcc0-3327cd784263",
    "status" : "accepted",
    "marker_id" : 16777510,
    "domain_id" : "5fc973eea581490997e82ea11a1df31f",
    "created_at" : "2018-09-17T11:10:11Z",
    "updated_at" : "2018-09-17T11:10:12Z"
  }, {
    "id" : "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea",
    "status" : "accepted",
    "marker_id" : 16777513,
    "domain_id" : "5fc973eea581490997e82ea11a1df31f",
    "created_at" : "2018-09-17T07:28:56Z",
    "updated_at" : "2018-09-17T07:28:58Z"
  } ],
  "total_count" : 2
}

狀態(tài)碼

狀態(tài)碼

描述

200

服務(wù)器已成功處理了請求

400

服務(wù)器未能處理請求

401

被請求的頁面需要用戶名和密碼

403

對被請求頁面的訪問被禁止

404

服務(wù)器無法找到被請求的頁面

405

請求中指定的方法不被允許

406

服務(wù)器生成的響應(yīng)無法被客戶端所接受

407

用戶必須首先使用代理服務(wù)器進(jìn)行驗(yàn)證,這樣請求才會被處理

408

請求超出了服務(wù)器的等待時(shí)間

409

由于沖突,請求無法被完成

500

請求未完成。服務(wù)異常

501

請求未完成。服務(wù)器不支持所請求的功能

502

請求未完成。服務(wù)器從上游服務(wù)器收到一個(gè)無效的響應(yīng)

503

請求未完成。系統(tǒng)暫時(shí)異常

504

網(wǎng)關(guān)超時(shí)

錯(cuò)誤碼

請參見錯(cuò)誤碼