功能介紹
查詢終端節(jié)點(diǎn)服務(wù)的概要信息， 此接口是供創(chuàng)建終端節(jié)點(diǎn)的用戶來查詢需要連接的終端節(jié)點(diǎn)服務(wù)信息。 此接口既可以方便其他用戶查詢到您的終端節(jié)點(diǎn)服務(wù)概要信息, 又可以避免您的終端節(jié)點(diǎn)服務(wù)的細(xì)節(jié)信息暴露給其他用戶。
調(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/describe
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID。 最小長度：1 最大長度：64 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
endpoint_service_name |
否 |
String |
終端節(jié)點(diǎn)服務(wù)的名稱。說明：該字段和id字段必須二選一，否則會(huì)出現(xiàn)錯(cuò)誤。 最小長度：1 最大長度：128 |
|
id |
否 |
String |
終端節(jié)點(diǎn)服務(wù)的ID，唯一標(biāo)識。 說明：該字段必須和endpoint_service_name字段二選一，否則會(huì)出現(xiàn)錯(cuò)誤。 最小長度：1 最大長度：64 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。 最小長度：1 最大長度：2048 |
|
Content-Type |
否 |
String |
發(fā)送的實(shí)體的MIME類型。推薦用戶默認(rèn)使用application/json， 如果API是對象、 鏡像 上傳等接口，媒體類型可按照流類型的不同進(jìn)行確定。 缺省值：application/json 最小長度：1 最大長度：64 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點(diǎn)服務(wù)的ID，唯一標(biāo)識。 |
|
service_name |
String |
終端節(jié)點(diǎn)服務(wù)的名稱。 |
|
service_type |
String |
終端節(jié)點(diǎn)服務(wù)類型。僅支持將用戶私有服務(wù)創(chuàng)建為interface類型的終端節(jié)點(diǎn)服務(wù)。 ● gataway：由運(yùn)維人員配置。用戶無需創(chuàng)建，可直接使用。 ● interface：包括運(yùn)維人員配置的云服務(wù)和用戶自己創(chuàng)建的私有服務(wù)。 其中，運(yùn)維人員配置的云服務(wù)無需創(chuàng)建，用戶可直接使用。 您可以通過創(chuàng)建終端節(jié)點(diǎn)創(chuàng)建訪問Gateway和Interface類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)。 |
|
created_at |
String |
終端節(jié)點(diǎn)服務(wù)的創(chuàng)建時(shí)間。 采用UTC時(shí)間格式，格式為：YYYY-MMDDTHH:MM:SSZ |
|
is_charge |
Boolean |
連接該終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)是否計(jì)費(fèi)。 ● true：計(jì)費(fèi) ● false：不計(jì)費(fèi) |
|
public_border_group |
String |
終端節(jié)點(diǎn)對應(yīng)Pool的Public Border Group信息 |
|
enable_policy |
Boolean |
是否開啟終端節(jié)點(diǎn)策略。 ● false：不支持設(shè)置終端節(jié)點(diǎn)策略 ● true：支持設(shè)置終端節(jié)點(diǎn)策略 默認(rèn)為false 是否開啟終端節(jié)點(diǎn)策略。 ● false：不支持設(shè)置終端節(jié)點(diǎn)策略 ● true：支持設(shè)置終端節(jié)點(diǎn)策略 默認(rèn)為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é)點(diǎn)服務(wù)概要
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/describe?id=4189d3c2-8882-4871-a3c2-d380272eed83
響應(yīng)示例
狀態(tài)碼： 200
服務(wù)器已成功處理了請求
{
"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 |
服務(wù)器已成功處理了請求 |
|
400 |
服務(wù)器未能處理請求 |
|
401 |
被請求的頁面需要用戶名和密碼 |
|
403 |
對被請求頁面的訪問被禁止 |
|
404 |
服務(wù)器無法找到被請求的頁面 |
|
405 |
請求中指定的方法不被允許 |
|
406 |
服務(wù)器生成的響應(yīng)無法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務(wù)器進(jìn)行驗(yàn)證，這樣請求才會(huì)被處理 |
|
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ò)誤碼。
最新文章
- 好用的VPCEP_終端節(jié)點(diǎn)服務(wù)管理_VPC終端節(jié)點(diǎn)是什么
- VPCEP終端節(jié)點(diǎn)產(chǎn)品功能_VPC終端節(jié)點(diǎn)免費(fèi)嗎_VPC終端節(jié)點(diǎn)優(yōu)勢
- 終端節(jié)點(diǎn)管理_如何使用VPC終端節(jié)點(diǎn)_VPC終端節(jié)點(diǎn)應(yīng)用場景
- 容器鏡像創(chuàng)建用戶并授權(quán)使用SWR_華為云SWR_容器鏡像創(chuàng)建授權(quán)
- VPC終端節(jié)點(diǎn)的作用是什么_VPC終端節(jié)點(diǎn)應(yīng)用場景_華為云VPC終端節(jié)點(diǎn)
- 代碼檢查工具_(dá)代碼檢查平臺(tái)_代碼檢查CodeArts Check-華為云