華為云計算 云知識 查詢終端節(jié)點列表ListEndpoints
查詢終端節(jié)點列表ListEndpoints

 

功能介紹

查詢當(dāng)前用戶下的終端節(jié)點的列表。

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

GET /v1/{project_id}/vpc-endpoints

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID。

最小長度:1

最大長度:64

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

endpoint_service_name

String

終端節(jié)點服務(wù)的名稱,支持大小寫,前后模糊匹配。

最小長度:1

最大長度:128

vpc_id

String

終端節(jié)點所在的VPC的ID。

最小長度:1

最大長度:64

id

String

終端節(jié)點的ID,唯一標(biāo)識。

最小長度:1

最大長度:64

limit

Integer

查詢返回終端節(jié)點的數(shù)量限制,即每頁返回的資源個數(shù)。 取值范圍:0~1000,取值一般為10,20或者50,默認(rèn)為10。

最小值:1

最大值:1000

缺省值:10

offset

Integer

偏移量。 偏移量為一個大于0小于終端節(jié)點服務(wù)總個數(shù)的整數(shù), 表示從偏移量后面的終端節(jié)點服務(wù)開始查詢。

最小值:0

sort_key

String

查詢結(jié)果中終端節(jié)點列表的排序字段,取值為: ● create_at:終端節(jié)點的創(chuàng)建時間 ● update_at:終端節(jié)點的更新時間 默認(rèn)值為create_at。

sort_dir

String

查詢結(jié)果中終端節(jié)點列表的排序方式,取值為: ● desc:降序排序 ● asc:升序排序 默認(rèn)值為desc。

public_border_group

String

篩選結(jié)果中匹配邊緣屬性的EPS

請求參數(shù)

表3 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。

最小長度:1

最大長度:2048

Content-Type

String

發(fā)送的實體的MIME類型。推薦用戶默認(rèn)使用application/json, 如果API是對象、 鏡像 上傳等接口,媒體類型可按照流類型的不同進(jìn)行確定。

缺省值:application/json

最小長度:1

最大長度:64

響應(yīng)參數(shù)

狀態(tài)碼: 200

表4 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

endpoints

Array of EndpointResp objects

終端節(jié)點列表。

total_count

Integer

滿足查詢條件的終端節(jié)點總條數(shù),不受分頁(即limit、offset參數(shù))影響。

表5 EndpointResp

參數(shù)

參數(shù)類型

描述

id

String

終端節(jié)點的ID,唯一標(biāo)識。

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:解凍

endpoint_service_name

String

終端節(jié)點服務(wù)的名稱。

marker_id

Integer

終端節(jié)點的報文標(biāo)識。

endpoint_service_id

String

終端節(jié)點服務(wù)的ID。

enable_dns

Boolean

是否創(chuàng)建域名。 ● true:創(chuàng)建域名 ● false:不創(chuàng)建域名 說明 當(dāng)創(chuàng)建連接gateway類型終端節(jié)點服務(wù)的終端節(jié)點時, “enable_dns”設(shè)置為true或者false,均不創(chuàng)建域名。

dns_names

Array of strings

訪問所連接的終端節(jié)點服務(wù)的域名。 當(dāng)“enable_dns”為true時,該參數(shù)可見。

ip

String

訪問所連接的終端節(jié)點服務(wù)的IP。 僅當(dāng)同時滿足如下條件時,返回該參數(shù): 當(dāng)查詢連接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

Array of TagList objects

標(biāo)簽列表,沒有標(biāo)簽?zāi)J(rèn)為空數(shù)組。

error

Array of QueryError objects

錯誤信息。 當(dāng)終端節(jié)點狀態(tài)異常,即“status”的值為“failed”時,會返回該字段。

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列表。 若未指定,返回默認(rèn)VPC下路由表ID。 創(chuàng)建連接Gateway類型終端節(jié)點服務(wù)的終端節(jié)點時,顯示此參數(shù)。

description

String

描述字段,支持中英文字母、數(shù)字等字符,不支持“<”或“>”字符。

policy_statement

Array of PolicyStatement objects

只涉及開啟雙端固定的網(wǎng)關(guān)型終端節(jié)點,響應(yīng)體展示此字段

endpoint_pool_id

String

待廢棄,實例相關(guān)聯(lián)的集群ID

public_border_group

String

終端節(jié)點關(guān)聯(lián)的Public Border Group信息,只有當(dāng)終端節(jié)點和邊緣Pool相關(guān)聯(lián)時才會返回改字段

表6 TagList

參數(shù)

參數(shù)類型

描述

key

String

鍵。 最大長度36個unicode字符。 key不能為空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”,且首尾字符不能為空格。

最小長度:1

最大長度:36

value

String

值。 每個值最大長度43個unicode字符,可以為空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”,且首尾字符不能為空格。

最小長度:1

最大長度:43

表7 QueryError

參數(shù)

參數(shù)類型

描述

error_code

String

錯誤編碼。

error_message

String

錯誤信息。

表8 PolicyStatement

參數(shù)

參數(shù)類型

描述

Effect

String

允許或拒絕,控制訪問權(quán)限

Action

Array of strings

obs訪問權(quán)限

Resource

Array of strings

obs對象

狀態(tài)碼: 400

表9 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表10 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 401

表11 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表12 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 403

表13 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表14 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 404

表15 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表16 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 405

表17 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表18 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 406

表19 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表20 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 407

表21 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表22 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 408

表23 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表24 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 409

表25 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表26 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 500

表27 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表28 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 501

表29 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表30 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 502

表31 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表32 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 503

表33 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表34 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

狀態(tài)碼: 504

表35 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務(wù)異常時返回的異常信息

表36 Error

參數(shù)

參數(shù)類型

描述

message

String

任務(wù)異常錯誤信息描述

code

String

任務(wù)異常錯誤信息編碼

請求示例

查詢終端節(jié)點列表

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ù)器已成功處理了請求

{
  "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ù)器已成功處理了請求

400

服務(wù)器未能處理請求

401

被請求的頁面需要用戶名和密碼

403

對被請求頁面的訪問被禁止

404

服務(wù)器無法找到被請求的頁面

405

請求中指定的方法不被允許

406

服務(wù)器生成的響應(yīng)無法被客戶端所接受

407

用戶必須首先使用代理服務(wù)器進(jìn)行驗證,這樣請求才會被處理

408

請求超出了服務(wù)器的等待時間

409

由于沖突,請求無法被完成

500

請求未完成。服務(wù)異常

501

請求未完成。服務(wù)器不支持所請求的功能

502

請求未完成。服務(wù)器從上游服務(wù)器收到一個無效的響應(yīng)

503

請求未完成。系統(tǒng)暫時異常

504

網(wǎng)關(guān)超時

錯誤碼

請參見錯誤碼。