功能介紹
查詢終端節(jié)點的詳細信息。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。 最小長度：1 最大長度：64 |
|
vpc_endpoint_id |
是 |
String |
終端節(jié)點的ID。 最小長度：1 最大長度：64 |
請求參數(shù)
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點的ID，唯一標識。 |
|
service_type |
String |
終端節(jié)點連接的終端節(jié)點服務(wù)類型。 ● gataway：由運維人員配置。用戶無需創(chuàng)建，可直接使用。 ● interface：包括運維人員配置的云服務(wù)和用戶自己創(chuàng)建的私有服務(wù)。 其中，運維人員配置的云服務(wù)無需創(chuàng)建，用戶可直接使用。 您可以通過查詢公共終端節(jié)點服務(wù)列表， 查看由運維人員配置的所有用戶可見且可連接的終端節(jié)點服務(wù)， 并通過創(chuàng)建終端節(jié)點服務(wù)創(chuàng)建Interface類型的終端節(jié)點服務(wù)。 |
|
status |
String |
終端節(jié)點的連接狀態(tài)。 ● pendingAcceptance：待接受 ● creating：創(chuàng)建中 ● accepted：已接受 ● failed：失敗 |
|
active_status |
Array of strings |
帳號狀態(tài)。 ● frozen：凍結(jié) ● active：解凍 |
|
enable_status |
String |
終端節(jié)點是否可用。 ● enable：啟用 ● disable：不啟用 |
|
specification_name |
String |
終端節(jié)點服務(wù)規(guī)格的名稱。 |
|
endpoint_service_name |
String |
終端節(jié)點服務(wù)的名稱。 |
|
marker_id |
Integer |
終端節(jié)點的報文標識。 |
|
endpoint_service_id |
String |
終端節(jié)點服務(wù)的ID。 |
|
enable_dns |
Boolean |
是否創(chuàng)建域名。 ● true：創(chuàng)建域名 ● false：不創(chuàng)建域名 說明 當創(chuàng)建連接gateway類型終端節(jié)點服務(wù)的終端節(jié)點時， “enable_dns”設(shè)置為true或者false，均不創(chuàng)建域名。 |
|
dns_names |
Array of strings |
訪問所連接的終端節(jié)點服務(wù)的域名。 當“enable_dns”為true時，該參數(shù)可見。 |
|
ip |
String |
訪問所連接的終端節(jié)點服務(wù)的IP。 僅當同時滿足如下條件時，返回該參數(shù)： ● 當查詢連接interface類型終端節(jié)點服務(wù)的終端節(jié)點時。 ● 終端節(jié)點服務(wù)啟用“連接審批”功能，且已經(jīng)“接受”連接審批。 “status”可以是“accepted”或者“rejected（僅支持“接受”連接審批后再“拒絕”的情況）”。 |
|
vpc_id |
String |
終端節(jié)點所在的VPC的ID。 |
|
subnet_id |
String |
vpc_id對應(yīng)VPC下已創(chuàng)建的網(wǎng)絡(luò)（network）的ID，UUID格式。 |
|
created_at |
String |
終端節(jié)點的創(chuàng)建時間。 采用UTC時間格式，格式為：YYYY-MM-DDTHH:MM:SSZ |
|
updated_at |
String |
終端節(jié)點的更新時間。 采用UTC時間格式，格式為：YYYY-MM-DDTHH:MM:SSZ |
|
project_id |
String |
項目ID，獲取方法請參見獲取項目ID。 |
|
tags |
標簽列表，沒有標簽?zāi)J為空數(shù)組。 |
|
|
error |
查詢資源返回的異常信息 |
|
|
whitelist |
Array of strings |
控制訪問終端節(jié)點的白名單。 若未創(chuàng)建，則返回空列表。 創(chuàng)建連接Interface類型終端節(jié)點服務(wù)的終端節(jié)點時，顯示此參數(shù)。 |
|
enable_whitelist |
Boolean |
是否開啟網(wǎng)絡(luò)ACL隔離。 ● true：開啟網(wǎng)絡(luò)ACL隔離 ● false：不開啟網(wǎng)絡(luò)ACL隔離 若未指定，則返回false。 創(chuàng)建連接Interface類型終端節(jié)點服務(wù)的終端節(jié)點時，顯示此參數(shù)。 |
|
routetables |
Array of strings |
路由表ID列表。 若未指定，返回默認VPC下路由表ID。 創(chuàng)建連接Gateway類型終端節(jié)點服務(wù)的終端節(jié)點時，顯示此參數(shù)。 |
|
description |
String |
描述字段，支持中英文字母、數(shù)字等字符，不支持“<”或“>”字符。 |
|
policy_statement |
Array of strings |
只涉及開啟雙端固定的網(wǎng)關(guān)型終端節(jié)點，響應(yīng)體展示此字段 |
|
endpoint_pool_id |
String |
待廢棄，實例相關(guān)聯(lián)的集群ID |
|
public_border_group |
String |
終端節(jié)點對應(yīng)Pool的Public Border Group信息 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
鍵。 最大長度36個unicode字符。 key不能為空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長度：1 最大長度：36 |
|
value |
String |
值。 每個值最大長度43個unicode字符，可以為空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長度：1 最大長度：43 |
狀態(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-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83
響應(yīng)示例
狀態(tài)碼： 200
服務(wù)器已成功處理了請求
{
"id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"service_type" : "interface",
"marker_id" : 16777337,
"status" : "accepted",
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"enable_dns" : false,
"endpoint_service_name" : "test123",
"endpoint_service_id" : "test123",
"project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
"whitelist" : [ "127.0.0.1" ],
"enable_whitelist" : true,
"created_at" : "2022-04-14T09:35:47Z",
"updated_at" : "2022-04-14T09:36:47Z"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
服務(wù)器已成功處理了請求 |
|
400 |
服務(wù)器未能處理請求 |
|
401 |
被請求的頁面需要用戶名和密碼 |
|
403 |
對被請求頁面的訪問被禁止 |
|
404 |
服務(wù)器無法找到被請求的頁面 |
|
405 |
請求中指定的方法不被允許 |
|
406 |
服務(wù)器生成的響應(yīng)無法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務(wù)器進行驗證，這樣請求才會被處理 |
|
408 |
請求超出了服務(wù)器的等待時間 |
|
409 |
由于沖突，請求無法被完成 |
|
500 |
請求未完成。服務(wù)異常 |
|
501 |
請求未完成。服務(wù)器不支持所請求的功能 |
|
502 |
請求未完成。服務(wù)器從上游服務(wù)器收到一個無效的響應(yīng) |
|
503 |
請求未完成。系統(tǒng)暫時異常 |
|
504 |
網(wǎng)關(guān)超時 |
錯誤碼
請參見錯誤碼。
