功能介紹
查詢公共終端節(jié)點(diǎn)服務(wù)的列表，公共終端節(jié)點(diǎn)服務(wù)是所有用戶可見且可連接的終端節(jié)點(diǎn)服務(wù)， 由運(yùn)維人員創(chuàng)建，用戶可直接使用，但無權(quán)創(chuàng)建。
調(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/public
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID。 最小長度：1 最大長度：64 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
查詢返回公共的終端節(jié)點(diǎn)服務(wù)數(shù)量限制，即每頁返回的個(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ù)開始查詢。 最小值：0 |
|
endpoint_service_name |
否 |
String |
公共終端節(jié)點(diǎn)服務(wù)的名稱，支持大小寫以及模糊匹配。 最小長度：1 最大長度：128 |
|
id |
否 |
String |
公共終端節(jié)點(diǎn)服務(wù)的ID，唯一標(biāo)識(shí)。 最小長度：1 最大長度：64 |
|
sort_key |
否 |
String |
查詢結(jié)果中終端節(jié)點(diǎn)服務(wù)列表的排序字段，取值為： ● create_at：終端節(jié)點(diǎn)服務(wù)的創(chuàng)建時(shí)間 ● update_at：終端節(jié)點(diǎn)服務(wù)的更新時(shí)間 默認(rèn)值為create_at。 缺省值：create_at |
|
sort_dir |
否 |
String |
查詢結(jié)果中終端節(jié)點(diǎn)服務(wù)列表的排序方式，取值為： ● desc：降序排序 ● asc：升序排序 默認(rèn)值為desc。 缺省值：desc |
請求參數(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ù)類型 |
描述 |
|---|---|---|
|
endpoint_services |
終端節(jié)點(diǎn)服務(wù)列表。 |
|
|
total_count |
Integer |
滿足查詢條件的公共終端節(jié)點(diǎn)服務(wù)總條數(shù)，不受分頁（即limit、offset參數(shù)）影響。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
公共終端節(jié)點(diǎn)服務(wù)的ID，唯一標(biāo)識(shí)。 |
|
owner |
String |
終端節(jié)點(diǎn)服務(wù)的所有者。 |
|
service_name |
String |
公共終端節(jié)點(diǎn)服務(wù)的名稱。 |
|
service_type |
String |
終端節(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í)間格式，格式為：YYYYMM-DDTHH:MM:SSZ |
|
is_charge |
Boolean |
連接該終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)是否計(jì)費(fèi)。 ● true：計(jì)費(fèi) ● false：不計(jì)費(fèi) |
|
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/public?limit={limit}&offset={offset}&
endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}&sort_key={sort_key}&sort_dir={sort_dir}
響應(yīng)示例
狀態(tài)碼： 200
服務(wù)器已成功處理了請求
{
"endpoint_services" : [ {
"id" : "b0e22f6f-26f4-461c-b140-d873464d4fa0",
"owner" : "example",
"service_name" : "test123",
"service_type" : "interface",
"created_at" : "2018-09-10T13:13:23Z",
"is_charge" : "true"
}, {
"id" : "26391a76-546b-42a9-b2fc-496ec68c0e4d",
"owner" : "example",
"service_name" : "OBS",
"service_type" : "gateway",
"created_at" : "2019-03-28T09:30:27Z",
"is_charge" : "true"
} ],
"total_count" : 2
}
狀態(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ò)誤碼。
最新文章
- 華為云CodeArts API_API設(shè)計(jì)支持公共模型
- 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)用場景
- 云儲(chǔ)存服務(wù)器_云服務(wù)器配置_云桌面服務(wù)器_免費(fèi)一年的云服務(wù)器
- 好用的VPCEP_終端節(jié)點(diǎn)服務(wù)管理_VPC終端節(jié)點(diǎn)是什么
- VPC終端節(jié)點(diǎn)的作用是什么_VPC終端節(jié)點(diǎn)應(yīng)用場景_華為云VPC終端節(jié)點(diǎn)