功能介紹
查詢連接當前用戶下的某一個終端節(jié)點服務的連接列表。marker_id是連接的唯一標識。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。 最小長度：1 |
|
vpc_endpoint_service_id |
是 |
String |
終端節(jié)點服務的ID。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
終端節(jié)點的ID，唯一標識。 |
|
marker_id |
否 |
String |
終端節(jié)點的報文標識。 |
|
status |
否 |
String |
終端節(jié)點的連接狀態(tài)。 ● pendingAcceptance：待接受 ● accepted：已接受 ● rejected：已拒絕 ● failed：失敗 |
|
sort_key |
否 |
String |
查詢結(jié)果中終端節(jié)點列表的排序字段，取值為： ● create_at：終端節(jié)點的創(chuàng)建時間 ● update_at：終端節(jié)點的更新時間 默認值為create_at。 缺省值：create_at |
|
sort_dir |
否 |
String |
查詢結(jié)果中終端節(jié)點列表的排序方式，取值為： ● desc：降序排序 ● asc：升序排序 默認值為desc。 缺省值：desc |
|
limit |
否 |
Integer |
查詢返回終端節(jié)點服務的連接列表限制每頁個數(shù)，即每頁返回的個數(shù)。 取值范圍：0~1000，取值一般為10，20或者50，默認為10。 最小值：1 最大值：1000 缺省值：10 |
|
offset |
否 |
Integer |
偏移量。 偏移量為一個大于0小于終端節(jié)點服務總個數(shù)的整數(shù)， 表示從偏移量后面的終端節(jié)點服務開始查詢。 最小值：0 |
請求參數(shù)
響應參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
connections |
連接列表。 |
|
|
total_count |
Integer |
滿足查詢條件的終端節(jié)點總條數(shù)，不受分頁（即limit、offset參數(shù)）影響。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點的ID，唯一標識。 |
|
marker_id |
Integer |
終端節(jié)點的報文標識。 |
|
created_at |
String |
終端節(jié)點的創(chuàng)建時間。 采用UTC時間格式，格式為：YYYY-MMDDTHH:MM:SSZ |
|
updated_at |
String |
終端節(jié)點的更新時間。 采用UTC時間格式，格式為：YYYY-MMDDTHH:MM:SSZ |
|
domain_id |
String |
用戶的Domain ID。 |
|
error |
錯誤信息。 當終端節(jié)點服務狀態(tài)異常，即“status”的值為“failed”時，會返回該字段。 |
|
|
status |
String |
終端節(jié)點的連接狀態(tài)。 ● pendingAcceptance：待接受 ● creating：創(chuàng)建中 ● accepted：已接受 ● rejected：已拒絕 ● failed：失敗 ● deleting：刪除中 |
|
description |
String |
終端節(jié)點連接描述。 |
狀態(tài)碼： 400
狀態(tài)碼： 401
狀態(tài)碼： 403
狀態(tài)碼： 404
狀態(tài)碼： 405
狀態(tài)碼： 406
狀態(tài)碼： 407
狀態(tài)碼： 408
狀態(tài)碼： 409
狀態(tài)碼： 500
狀態(tài)碼： 501
狀態(tài)碼： 502
狀態(tài)碼： 503
狀態(tài)碼： 504
請求示例
查詢連接終端節(jié)點服務的連接列表
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é)點服務連接列表。 GET https://{endpoint}/v1/{project_id}/
vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections
響應示例
狀態(tài)碼： 200
服務器已成功處理了請求
{
"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 |
服務器已成功處理了請求 |
|
400 |
服務器未能處理請求 |
|
401 |
被請求的頁面需要用戶名和密碼 |
|
403 |
對被請求頁面的訪問被禁止 |
|
404 |
服務器無法找到被請求的頁面 |
|
405 |
請求中指定的方法不被允許 |
|
406 |
服務器生成的響應無法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務器進行驗證，這樣請求才會被處理 |
|
408 |
請求超出了服務器的等待時間 |
|
409 |
由于沖突，請求無法被完成 |
|
500 |
請求未完成。服務異常 |
|
501 |
請求未完成。服務器不支持所請求的功能 |
|
502 |
請求未完成。服務器從上游服務器收到一個無效的響應 |
|
503 |
請求未完成。系統(tǒng)暫時異常 |
|
504 |
網(wǎng)關超時 |
錯誤碼
請參見錯誤碼。
