功能介紹
查詢終端節(jié)點服務的概要信息， 此接口是供創(chuàng)建終端節(jié)點的用戶來查詢需要連接的終端節(jié)點服務信息。 此接口既可以方便其他用戶查詢到您的終端節(jié)點服務概要信息, 又可以避免您的終端節(jié)點服務的細節(jié)信息暴露給其他用戶。
調試
您可以在API Explorer中調試該接口，支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調試功能。
URI
GET /v1/{project_id}/vpc-endpoint-services/describe
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。 最小長度：1 最大長度：64 |
|
參數 |
是否必選 |
參數類型 |
描述 |
|---|---|---|---|
|
endpoint_service_name |
否 |
String |
終端節(jié)點服務的名稱。說明：該字段和id字段必須二選一，否則會出現錯誤。 最小長度：1 最大長度：128 |
|
id |
否 |
String |
終端節(jié)點服務的ID，唯一標識。 說明：該字段必須和endpoint_service_name字段二選一，否則會出現錯誤。 最小長度：1 最大長度：64 |
請求參數
響應參數
狀態(tài)碼： 200
|
參數 |
參數類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點服務的ID，唯一標識。 |
|
service_name |
String |
終端節(jié)點服務的名稱。 |
|
service_type |
String |
終端節(jié)點服務類型。僅支持將用戶私有服務創(chuàng)建為interface類型的終端節(jié)點服務。 ● gataway：由運維人員配置。用戶無需創(chuàng)建，可直接使用。 ● interface：包括運維人員配置的云服務和用戶自己創(chuàng)建的私有服務。 其中，運維人員配置的云服務無需創(chuàng)建，用戶可直接使用。 您可以通過創(chuàng)建終端節(jié)點創(chuàng)建訪問Gateway和Interface類型終端節(jié)點服務的終端節(jié)點。 |
|
created_at |
String |
終端節(jié)點服務的創(chuàng)建時間。 采用UTC時間格式，格式為：YYYY-MMDDTHH:MM:SSZ |
|
is_charge |
Boolean |
連接該終端節(jié)點服務的終端節(jié)點是否計費。 ● true：計費 ● false：不計費 |
|
public_border_group |
String |
終端節(jié)點對應Pool的Public Border Group信息 |
|
enable_policy |
Boolean |
是否開啟終端節(jié)點策略。 ● false：不支持設置終端節(jié)點策略 ● true：支持設置終端節(jié)點策略 默認為false 是否開啟終端節(jié)點策略。 ● false：不支持設置終端節(jié)點策略 ● true：支持設置終端節(jié)點策略 默認為false |
狀態(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/describe?id=4189d3c2-8882-4871-a3c2-d380272eed83
響應示例
狀態(tài)碼： 200
服務器已成功處理了請求
{
"id" : "9d4c1028-1336-4556-9881-b5d807c1b8a8",
"service_name" : "test123",
"service_type" : "interface",
"created_at" : "2018-09-17T07:28:31Z",
"is_charge" : "true"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
服務器已成功處理了請求 |
|
400 |
服務器未能處理請求 |
|
401 |
被請求的頁面需要用戶名和密碼 |
|
403 |
對被請求頁面的訪問被禁止 |
|
404 |
服務器無法找到被請求的頁面 |
|
405 |
請求中指定的方法不被允許 |
|
406 |
服務器生成的響應無法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務器進行驗證，這樣請求才會被處理 |
|
408 |
請求超出了服務器的等待時間 |
|
409 |
由于沖突，請求無法被完成 |
|
500 |
請求未完成。服務異常 |
|
501 |
請求未完成。服務器不支持所請求的功能 |
|
502 |
請求未完成。服務器從上游服務器收到一個無效的響應 |
|
503 |
請求未完成。系統暫時異常 |
|
504 |
網關超時 |
錯誤碼
請參見錯誤碼。
