功能介紹
查詢當(dāng)前用戶下的終端節(jié)點(diǎn)的列表。
調(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-endpoints
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
endpoint_service_name |
否 |
String |
終端節(jié)點(diǎn)服務(wù)的名稱，支持大小寫(xiě)，前后模糊匹配。 最小長(zhǎng)度：1 最大長(zhǎng)度：128 |
|
vpc_id |
否 |
String |
終端節(jié)點(diǎn)所在的VPC的ID。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
id |
否 |
String |
終端節(jié)點(diǎn)的ID，唯一標(biāo)識(shí)。 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
|
limit |
否 |
Integer |
查詢返回終端節(jié)點(diǎn)的數(shù)量限制，即每頁(yè)返回的資源個(gè)數(shù)。 取值范圍：0~1000，取值一般為10，20或者50，默認(rèn)為10。 最小值：1 最大值：1000 缺省值：10 |
|
offset |
否 |
Integer |
偏移量。 偏移量為一個(gè)大于0小于終端節(jié)點(diǎn)服務(wù)總個(gè)數(shù)的整數(shù)， 表示從偏移量后面的終端節(jié)點(diǎn)服務(wù)開(kāi)始查詢。 最小值：0 |
|
sort_key |
否 |
String |
查詢結(jié)果中終端節(jié)點(diǎn)列表的排序字段，取值為： ● create_at：終端節(jié)點(diǎn)的創(chuàng)建時(shí)間 ● update_at：終端節(jié)點(diǎn)的更新時(shí)間 默認(rèn)值為create_at。 |
|
sort_dir |
否 |
String |
查詢結(jié)果中終端節(jié)點(diǎn)列表的排序方式，取值為： ● desc：降序排序 ● asc：升序排序 默認(rèn)值為desc。 |
|
public_border_group |
否 |
String |
篩選結(jié)果中匹配邊緣屬性的EPS |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。 最小長(zhǎng)度：1 最大長(zhǎng)度：2048 |
|
Content-Type |
否 |
String |
發(fā)送的實(shí)體的MIME類型。推薦用戶默認(rèn)使用application/json， 如果API是對(duì)象、 鏡像 上傳等接口，媒體類型可按照流類型的不同進(jìn)行確定。 缺省值：application/json 最小長(zhǎng)度：1 最大長(zhǎng)度：64 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
endpoints |
終端節(jié)點(diǎn)列表。 |
|
|
total_count |
Integer |
滿足查詢條件的終端節(jié)點(diǎn)總條數(shù)，不受分頁(yè)（即limit、offset參數(shù)）影響。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
終端節(jié)點(diǎn)的ID，唯一標(biāo)識(shí)。 |
|
service_type |
String |
終端節(jié)點(diǎn)連接的終端節(jié)點(diǎn)服務(wù)類型。 ● gataway：由運(yùn)維人員配置。用戶無(wú)需創(chuàng)建，可直接使用。 ● interface：包括運(yùn)維人員配置的云服務(wù)和用戶自己創(chuàng)建的私有服務(wù)。 其中，運(yùn)維人員配置的云服務(wù)無(wú)需創(chuàng)建，用戶可直接使用。 您可以通過(guò)查詢公共終端節(jié)點(diǎn)服務(wù)列表， 查看由運(yùn)維人員配置的所有用戶可見(jiàn)且可連接的終端節(jié)點(diǎn)服務(wù)， 并通過(guò)創(chuàng)建終端節(jié)點(diǎn)服務(wù)創(chuàng)建Interface類型的終端節(jié)點(diǎn)服務(wù)。 |
|
status |
String |
終端節(jié)點(diǎn)的連接狀態(tài)。 ● pendingAcceptance：待接受 ● creating：創(chuàng)建中 ● accepted：已接受 ● failed：失敗 |
|
active_status |
Array of strings |
帳號(hào)狀態(tài)。 ● frozen：凍結(jié) ● active：解凍 |
|
endpoint_service_name |
String |
終端節(jié)點(diǎn)服務(wù)的名稱。 |
|
marker_id |
Integer |
終端節(jié)點(diǎn)的報(bào)文標(biāo)識(shí)。 |
|
endpoint_service_id |
String |
終端節(jié)點(diǎn)服務(wù)的ID。 |
|
enable_dns |
Boolean |
是否創(chuàng)建域名。 ● true：創(chuàng)建域名 ● false：不創(chuàng)建域名 說(shuō)明 當(dāng)創(chuàng)建連接gateway類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)時(shí)， “enable_dns”設(shè)置為true或者false，均不創(chuàng)建域名。 |
|
dns_names |
Array of strings |
訪問(wèn)所連接的終端節(jié)點(diǎn)服務(wù)的域名。 當(dāng)“enable_dns”為true時(shí)，該參數(shù)可見(jiàn)。 |
|
ip |
String |
訪問(wèn)所連接的終端節(jié)點(diǎn)服務(wù)的IP。 僅當(dāng)同時(shí)滿足如下條件時(shí)，返回該參數(shù)： 當(dāng)查詢連接interface類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)時(shí)。 終端節(jié)點(diǎn)服務(wù)啟用“連接審批”功能，且已經(jīng)“接受”連接審批。 “status”可以是“accepted”或者“rejected（僅支持“接受”連接審批后再“拒絕”的情況）”。 |
|
vpc_id |
String |
終端節(jié)點(diǎn)所在的VPC的ID。 |
|
subnet_id |
String |
vpc_id對(duì)應(yīng)VPC下已創(chuàng)建的網(wǎng)絡(luò)（network）的ID，UUID格式。 |
|
created_at |
String |
終端節(jié)點(diǎn)的創(chuàng)建時(shí)間。 采用UTC時(shí)間格式，格式為：YYYY-MM-DDTHH:MM:SSZ |
|
updated_at |
String |
終端節(jié)點(diǎn)的更新時(shí)間。 采用UTC時(shí)間格式，格式為：YYYY-MM-DDTHH:MM:SSZ |
|
project_id |
String |
項(xiàng)目ID，獲取方法請(qǐng)參見(jiàn)獲取項(xiàng)目ID。 |
|
tags |
標(biāo)簽列表，沒(méi)有標(biāo)簽?zāi)J(rèn)為空數(shù)組。 |
|
|
error |
錯(cuò)誤信息。 當(dāng)終端節(jié)點(diǎn)狀態(tài)異常，即“status”的值為“failed”時(shí)，會(huì)返回該字段。 |
|
|
whitelist |
Array of strings |
控制訪問(wèn)終端節(jié)點(diǎn)的白名單。 若未創(chuàng)建，則返回空列表。 創(chuàng)建連接Interface類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)時(shí)，顯示此參數(shù)。 |
|
enable_whitelist |
Boolean |
是否開(kāi)啟網(wǎng)絡(luò)ACL隔離。 ● true：開(kāi)啟網(wǎng)絡(luò)ACL隔離 ● false：不開(kāi)啟網(wǎng)絡(luò)ACL隔離 若未指定，則返回false。 創(chuàng)建連接Interface類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)時(shí)，顯示此參數(shù)。 |
|
routetables |
Array of strings |
路由表ID列表。 若未指定，返回默認(rèn)VPC下路由表ID。 創(chuàng)建連接Gateway類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)時(shí)，顯示此參數(shù)。 |
|
description |
String |
描述字段，支持中英文字母、數(shù)字等字符，不支持“<”或“>”字符。 |
|
policy_statement |
只涉及開(kāi)啟雙端固定的網(wǎng)關(guān)型終端節(jié)點(diǎn)，響應(yīng)體展示此字段 |
|
|
endpoint_pool_id |
String |
待廢棄，實(shí)例相關(guān)聯(lián)的集群ID |
|
public_border_group |
String |
終端節(jié)點(diǎn)關(guān)聯(lián)的Public Border Group信息，只有當(dāng)終端節(jié)點(diǎn)和邊緣Pool相關(guān)聯(lián)時(shí)才會(huì)返回改字段 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
鍵。 最大長(zhǎng)度36個(gè)unicode字符。 key不能為空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長(zhǎng)度：1 最大長(zhǎng)度：36 |
|
value |
String |
值。 每個(gè)值最大長(zhǎng)度43個(gè)unicode字符，可以為空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能為空格。 最小長(zhǎng)度：1 最大長(zhǎng)度：43 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
Effect |
String |
允許或拒絕，控制訪問(wèn)權(quán)限 |
|
Action |
Array of strings |
obs訪問(wèn)權(quán)限 |
|
Resource |
Array of strings |
obs對(duì)象 |
狀態(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
請(qǐng)求示例
查詢終端節(jié)點(diǎn)列表
GET https://{endpoint}/v1/{project_id}/vpc-endpoints?endpoint_service_name={endpoint_service_name}&vpc_id={vpc_id}&
limit={limit}&offset={offset}&id={id}&sort_key={sort_key}&sort_dir={sort_dir}
響應(yīng)示例
狀態(tài)碼： 200
服務(wù)器已成功處理了請(qǐng)求
{
"endpoints" : [ {
"id" : "03184a04-95d5-4555-86c4-e767a371ff99",
"status" : "accepted",
"ip" : "192.168.0.232",
"marker_id" : 16777337,
"active_status" : "active",
"vpc_id" : "84758cf5-9c62-43ae-a778-3dbd8370c0a4",
"service_type" : "interface",
"project_id" : "295dacf46a4842fcbf7844dc2dc2489d",
"subnet_id" : "68bfbcc1-dff2-47e4-a9d4-332b9bc1b8de",
"enable_dns" : "true",
"dns_names" : [ "test123" ],
"created_at" : "2018-10-18T06:49:46Z",
"updated_at" : "2018-10-18T06:49:50Z",
"endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78",
"endpoint_service_name" : "test123",
"endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde",
"public_border_group" : "br-abc-aaa1",
"whitelist" : [ "127.0.0.1" ],
"enable_whitelist" : true
}, {
"id" : "43b0e3b0-eec9-49da-866b-6687b75f9fe5",
"status" : "accepted",
"ip" : "192.168.0.115",
"marker_id" : 16777322,
"active_status" : "active",
"vpc_id" : "e251b400-2963-4131-b38a-da81e32026ee",
"service_type" : "interface",
"project_id" : "295dacf46a4842fcbf7844dc2dc2489d",
"subnet_id" : "65528a22-59a1-4972-ba64-88984b3207cd",
"enable_dns" : "true",
"dns_names" : [ "test123" ],
"created_at" : "2018-10-18T06:36:20Z",
"updated_at" : "2018-10-18T06:36:24Z",
"endpoint_service_id" : "5133655d-0e28-4090-b669-13f87b355c78",
"endpoint_service_name" : "test123",
"endpoint_pool_id" : "ee38223b-aacb-46f0-ba7e-94fa62e35dde",
"whitelist" : [ "127.0.0.1" ],
"enable_whitelist" : true
} ],
"total_count" : 2
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
服務(wù)器已成功處理了請(qǐng)求 |
|
400 |
服務(wù)器未能處理請(qǐng)求 |
|
401 |
被請(qǐng)求的頁(yè)面需要用戶名和密碼 |
|
403 |
對(duì)被請(qǐng)求頁(yè)面的訪問(wèn)被禁止 |
|
404 |
服務(wù)器無(wú)法找到被請(qǐng)求的頁(yè)面 |
|
405 |
請(qǐng)求中指定的方法不被允許 |
|
406 |
服務(wù)器生成的響應(yīng)無(wú)法被客戶端所接受 |
|
407 |
用戶必須首先使用代理服務(wù)器進(jìn)行驗(yàn)證，這樣請(qǐng)求才會(huì)被處理 |
|
408 |
請(qǐng)求超出了服務(wù)器的等待時(shí)間 |
|
409 |
由于沖突，請(qǐng)求無(wú)法被完成 |
|
500 |
請(qǐng)求未完成。服務(wù)異常 |
|
501 |
請(qǐng)求未完成。服務(wù)器不支持所請(qǐng)求的功能 |
|
502 |
請(qǐng)求未完成。服務(wù)器從上游服務(wù)器收到一個(gè)無(wú)效的響應(yīng) |
|
503 |
請(qǐng)求未完成。系統(tǒng)暫時(shí)異常 |
|
504 |
網(wǎng)關(guān)超時(shí) |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
最新文章
- VPCEP終端節(jié)點(diǎn)產(chǎn)品功能_VPC終端節(jié)點(diǎn)免費(fèi)嗎_VPC終端節(jié)點(diǎn)優(yōu)勢(shì)
- 終端節(jié)點(diǎn)管理_如何使用VPC終端節(jié)點(diǎn)_VPC終端節(jié)點(diǎn)應(yīng)用場(chǎng)景
- 好用的VPCEP_終端節(jié)點(diǎn)服務(wù)管理_VPC終端節(jié)點(diǎn)是什么
- VPC終端節(jié)點(diǎn)的作用是什么_VPC終端節(jié)點(diǎn)應(yīng)用場(chǎng)景_華為云VPC終端節(jié)點(diǎn)
- 快遞查詢API接口_快遞批量查詢_手機(jī)查詢快遞_位置查詢
- 手機(jī)查詢快遞_快遞物流查詢_快遞查詢API接口_快遞查詢