功能介紹
查詢終端節(jié)點服務(wù)的詳細(xì)信息。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID。 最小長度：1 最大長度：64 |
|
vpc_endpoint_service_id |
是 |
String |
終端節(jié)點服務(wù)的ID。 最小長度：1 最大長度：64 |
請求參數(shù)
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點服務(wù)的ID，唯一標(biāo)識。 |
|
port_id |
String |
標(biāo)識終端節(jié)點服務(wù)后端資源的ID， 格式為通用唯一識別碼（Universally Unique Identifier，下文簡稱UUID）。取值為： ● LB類型： 負(fù)載均衡 器內(nèi)網(wǎng)IP對應(yīng)的端口ID。 ● VM類型：彈性 云服務(wù)器 IP地址對應(yīng)的網(wǎng)卡ID。 ● VIP類型：虛擬資源所在物理服務(wù)器對應(yīng)的網(wǎng)卡ID。（該字段已廢棄，請優(yōu)先使用LB類型） |
|
service_name |
String |
終端節(jié)點服務(wù)的名稱。 最小長度：0 最大長度：128 |
|
server_type |
String |
資源類型。 ● VM：云服務(wù)器。 ● VIP：虛擬IP。 ● LB：增強負(fù)載均衡型。 |
|
vpc_id |
String |
終端節(jié)點服務(wù)對應(yīng)后端資源所在的VPC的ID。 |
|
approval_enabled |
Boolean |
是否需要審批。 ● false：不需要審批，創(chuàng)建的終端節(jié)點連接直接為accepted狀態(tài)。 ● true：需要審批，創(chuàng)建的終端節(jié)點連接為pendingAcceptance狀態(tài)， 需要終端節(jié)點服務(wù)所屬用戶審核后方可使用。 |
|
status |
String |
終端節(jié)點服務(wù)的狀態(tài)。 ● creating：創(chuàng)建中 ● available：可連接 ● failed：失敗 ● deleting：刪除中 |
|
service_type |
String |
終端節(jié)點服務(wù)類型。 終端節(jié)點服務(wù)類型包括“網(wǎng)關(guān)（gataway）型”和“接口（interface）型”： ● gataway：由運維人員配置。用戶無需創(chuàng)建，可直接使用。 ● interface：包括運維人員配置的云服務(wù)和用戶自己創(chuàng)建的私有服務(wù)。 其中，運維人員配置的云服務(wù)無需創(chuàng)建，用戶可直接使用。 您可以通過創(chuàng)建終端節(jié)點創(chuàng)建訪問Gateway和Interface類型終端節(jié)點服務(wù)的終端節(jié)。 |
|
created_at |
String |
終端節(jié)點服務(wù)的創(chuàng)建時間。 采用UTC時間格式，格式為：YYYY-MMDDTHH:MM:SSZ |
|
updated_at |
String |
終端節(jié)點服務(wù)的更新時間。 采用UTC時間格式，格式為：YYYY-MMDDTHH:MM:SSZ |
|
project_id |
String |
項目ID，獲取方法請參見獲取項目ID。 |
|
cidr_type |
String |
網(wǎng)段類型。 public：公網(wǎng)網(wǎng)段 internal：內(nèi)網(wǎng)網(wǎng)段 默認(rèn)值為internal。 |
|
ports |
服務(wù)開放的端口映射列表，詳細(xì)內(nèi)容請參見表4-17 同一個終端節(jié)點服務(wù)下，不允許重復(fù)的端口映射。若多個終端節(jié)點服務(wù)共用一個port_id，則 終端節(jié)點服務(wù)之間的所有端口映射的server_port和protocol的組合不能重復(fù)。 |
|
|
tcp_proxy |
String |
用于控制將哪些信息（如客戶端的源IP、源端口、marker_id等）攜帶到服務(wù)端。 支持?jǐn)y帶的客戶端信息包括如下兩種類型： ● TCP TOA：表示將客戶端信息插入到tcp option字段中攜帶至服務(wù)端。 說明：僅當(dāng)后端資源為OBS時，支持TCP TOA類型信息攜帶方式。 ● Proxy Protocol：表示將客戶端信息插入到tcp payload字段中攜帶至服務(wù)端。 僅當(dāng)服務(wù)端支持解析上述字段時，該參數(shù)設(shè)置才有效。 該參數(shù)的取值包括： ● close：表示關(guān)閉代理協(xié)議。 ● toa_open：表示開啟代理協(xié)議“tcp_toa”。 ● proxy_open：表示開啟代理協(xié)議“proxy_protocol”。 ● open：表示同時開啟代理協(xié)議“tcp_toa”和“proxy_protocol”。 ● proxy_vni: 關(guān)閉toa，開啟proxy和vni。 默認(rèn)值為“close”。 |
|
tags |
資源標(biāo)簽列表 |
|
|
error |
提交任務(wù)異常時返回的異常信息 |
|
|
enable_policy |
Boolean |
是否開啟終端節(jié)點策略。 ● false：不支持設(shè)置終端節(jié)點策略 ● true：支持設(shè)置終端節(jié)點策略 默認(rèn)為false |
|
description |
String |
描述字段，支持中英文字母、數(shù)字等字符，不支持“<”或“>”字符。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
client_port |
Integer |
終端節(jié)點訪問的端口。 終端節(jié)點提供給用戶，作為訪問終端節(jié)點服務(wù)的端口，范圍1-65535。 最小長度：1 最大長度：65535 |
|
server_port |
Integer |
終端節(jié)點服務(wù)的端口。 終端節(jié)點服務(wù)綁定了后端資源，作為提供服務(wù)的端口，范圍1-65535。 最小長度：1 最大長度：65535 |
|
protocol |
String |
端口映射協(xié)議，支持TCP。 缺省值：TCP |
|
參數(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é)點服務(wù)詳情
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}
查詢ID為“4189d3c2-8882-4871-a3c2-d380272eed88”的終端節(jié)點服務(wù)詳情。 GET https://{endpoint}/v1/{project_id}/
vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88
響應(yīng)示例
狀態(tài)碼： 200
服務(wù)器已成功處理了請求
{
"id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
"status" : "available",
"approval_enabled" : false,
"service_name" : "test123",
"server_type" : "VM",
"service_type" : "interface",
"ports" : [ {
"client_port" : "8080",
"server_port" : "80",
"protocol" : "TCP"
}, {
"client_port" : "8081",
"server_port" : "80",
"protocol" : "TCP"
} ],
"project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
"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)超時 |
錯誤碼
請參見錯誤碼。
