華為云計(jì)算 云知識(shí) 查詢(xún)終端節(jié)點(diǎn)服務(wù)列表ListEndpointService
查詢(xún)終端節(jié)點(diǎn)服務(wù)列表ListEndpointService

 

功能介紹

查詢(xún)當(dāng)前用戶下的終端節(jié)點(diǎn)服務(wù)的列表。

調(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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

project_id

String

項(xiàng)目ID

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

endpoint_service_name

String

終端節(jié)點(diǎn)服務(wù)的名稱(chēng),支持大小寫(xiě),前后模糊匹配。

最小長(zhǎng)度:1

最大長(zhǎng)度:128

id

String

終端節(jié)點(diǎn)服務(wù)的ID,唯一標(biāo)識(shí)。

status

String

終端節(jié)點(diǎn)服務(wù)的狀態(tài)。 ● creating:創(chuàng)建中 ● available:可連接 ● failed:失敗 ● deleting:刪除中

sort_key

String

查詢(xún)結(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

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

缺省值:desc

limit

Integer

查詢(xún)返回的終端節(jié)點(diǎn)服務(wù)數(shù)量限制,即每頁(yè)返回的終端節(jié)點(diǎn)服務(wù)的個(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)始查詢(xún)。

最小值:0

public_border_group

String

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

請(qǐng)求參數(shù)

表3 請(qǐng)求Header參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

X-Auth-Token

String

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

Content-Type

String

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

缺省值:application/json

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類(lèi)型

描述

endpoint_services

Array of ServiceList objects

終端節(jié)點(diǎn)服務(wù)列表

total_count

Integer

滿足查詢(xún)條件的終端節(jié)點(diǎn)服務(wù)總條數(shù),不受分頁(yè)(即limit、offset參數(shù))影響。

表5 ServiceList

參數(shù)

參數(shù)類(lèi)型

描述

id

String

終端節(jié)點(diǎn)服務(wù)的ID,唯一標(biāo)識(shí)。

port_id

String

標(biāo)識(shí)終端節(jié)點(diǎn)服務(wù)后端資源的ID, 格式為通用唯一識(shí)別碼(Universally Unique Identifier,下文簡(jiǎn)稱(chēng)UUID)。取值為: ● LB類(lèi)型: 負(fù)載均衡 器內(nèi)網(wǎng)IP對(duì)應(yīng)的端口ID。 ● VM類(lèi)型:彈性 云服務(wù)器 IP地址對(duì)應(yīng)的網(wǎng)卡ID。 ● VIP類(lèi)型:虛擬資源所在物理服務(wù)器對(duì)應(yīng)的網(wǎng)卡ID。(該字段已廢棄,請(qǐng)優(yōu)先使用LB類(lèi)型)

service_name

String

終端節(jié)點(diǎn)服務(wù)的名稱(chēng)。

最小長(zhǎng)度:0

最大長(zhǎng)度:16

server_type

String

資源類(lèi)型。 ● VM:云服務(wù)器。 ● VIP:虛擬IP。 ● LB:增強(qiáng)負(fù)載均衡型。

vpc_id

String

終端節(jié)點(diǎn)服務(wù)對(duì)應(yīng)后端資源所在的VPC的ID。

approval_enabled

Boolean

是否需要審批。 ● false:不需要審批,創(chuàng)建的終端節(jié)點(diǎn)連接直接為accepted狀態(tài)。 ● true:需要審批,創(chuàng)建的終端節(jié)點(diǎn)連接為pendingAcceptance狀態(tài), 需要終端節(jié)點(diǎn)服務(wù)所屬用戶審核后方可使用。

status

String

終端節(jié)點(diǎn)服務(wù)的狀態(tài)。 ● creating:創(chuàng)建中 ● available:可連接 ● failed:失敗 ● deleting:刪除中

service_type

String

終端節(jié)點(diǎn)服務(wù)類(lèi)型。 終端節(jié)點(diǎn)服務(wù)類(lèi)型包括“網(wǎng)關(guān)(gataway)型”和“接口(interface)型”: ● gataway:由運(yùn)維人員配置。用戶無(wú)需創(chuàng)建,可直接使用。 ● interface:包括運(yùn)維人員配置的云服務(wù)和用戶自己創(chuàng)建的私有服務(wù)。 其中,運(yùn)維人員配置的云服務(wù)無(wú)需創(chuàng)建,用戶可直接使用。 您可以通過(guò)創(chuàng)建終端節(jié)點(diǎn)創(chuàng)建訪問(wèn)Gateway和Interface類(lèi)型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)。

created_at

String

終端節(jié)點(diǎn)服務(wù)的創(chuàng)建時(shí)間。 采用UTC時(shí)間格式,格式為:YYYY-MMDDTHH:MM:SSZ

updated_at

String

終端節(jié)點(diǎn)服務(wù)的更新時(shí)間。 采用UTC時(shí)間格式,格式為:YYYY-MMDDTHH:MM:SSZ

project_id

String

項(xiàng)目ID,獲取方法請(qǐng)參見(jiàn)獲取項(xiàng)目ID。

domain_id

String

Domain ID

ports

Array of PortList objects

服務(wù)開(kāi)放的端口映射列表 同一個(gè)終端節(jié)點(diǎn)服務(wù)下,不允許重復(fù)的端口映射。 若多個(gè)終端節(jié)點(diǎn)服務(wù)共用一個(gè)port_id, 則終端節(jié)點(diǎn)服務(wù)之間的所有端口映射的server_port和protocol的組合不能重復(fù)。

tags

Array of TagList objects

資源標(biāo)簽列表

connection_count

Integer

終端節(jié)點(diǎn)服務(wù)下連接的狀態(tài)為“創(chuàng)建中”或“已接受”的終端節(jié)點(diǎn)的個(gè)數(shù)。

tcp_proxy

String

用于控制將哪些信息(如客戶端的源IP、源端口、marker_id等)攜帶到服務(wù)端。 支持?jǐn)y帶的客戶端信息包括如下兩種類(lèi)型: ● TCP TOA:表示將客戶端信息插入到tcp option字段中攜帶至服務(wù)端。 說(shuō)明:僅當(dāng)后端資源為OBS時(shí),支持TCP TOA類(lèi)型信息攜帶方式。 ● Proxy Protocol:表示將客戶端信息插入到tcp payload字段中攜帶至服務(wù)端。 僅當(dāng)服務(wù)端支持解析上述字段時(shí),該參數(shù)設(shè)置才有效。 該參數(shù)的取值包括: ● close:表示關(guān)閉代理協(xié)議。 ● toa_open:表示開(kāi)啟代理協(xié)議“tcp_toa”。 ● proxy_open:表示開(kāi)啟代理協(xié)議“proxy_protocol”。 ● open:表示同時(shí)開(kāi)啟代理協(xié)議“tcp_toa”和“proxy_protocol”。 ● proxy_vni: 關(guān)閉toa,開(kāi)啟proxy和vni。 默認(rèn)值為“close”。

error

Array of Error objects

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

description

String

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

public_border_group

String

終端節(jié)點(diǎn)服務(wù)對(duì)應(yīng)Pool的Public Border Group信息

enable_policy

Boolean

是否開(kāi)啟終端節(jié)點(diǎn)策略。 ● false:不支持設(shè)置終端節(jié)點(diǎn)策略 ● true:支持設(shè)置終端節(jié)點(diǎn)策略 默認(rèn)為false

表6 PortList

參數(shù)

參數(shù)類(lèi)型

描述

client_port

Integer

終端節(jié)點(diǎn)訪問(wèn)的端口。 終端節(jié)點(diǎn)提供給用戶,作為訪問(wèn)終端節(jié)點(diǎn)服務(wù)的端口,范圍1-65535。

最小長(zhǎng)度:1

最大長(zhǎng)度:65535

server_port

Integer

終端節(jié)點(diǎn)服務(wù)的端口。 終端節(jié)點(diǎn)服務(wù)綁定了后端資源,作為提供服務(wù)的端口,范圍1-65535。

最小長(zhǎng)度:1

最大長(zhǎng)度:65535

protocol

String

端口映射協(xié)議,支持TCP。

缺省值:TCP

表7 TagList

參數(shù)

參數(shù)類(lèi)型

描述

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

表8 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 400

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表10 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 401

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表12 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 403

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表14 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 404

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表16 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 405

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表18 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 406

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表20 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 407

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表22 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 408

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表24 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 409

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表26 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 500

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表28 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 501

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表30 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 502

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表32 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 503

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表34 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

狀態(tài)碼: 504

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

參數(shù)

參數(shù)類(lèi)型

描述

error

Error object

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

表36 Error

參數(shù)

參數(shù)類(lèi)型

描述

message

String

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

code

String

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

請(qǐng)求示例

查詢(xún)終端節(jié)點(diǎn)服務(wù)列表

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services?endpoint_service_name={endpoint_service_name}&
id={id}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&offset={offset}&status={status}

響應(yīng)示例

狀態(tài)碼: 200

服務(wù)器已成功處理了請(qǐng)求

{
  "endpoint_services" : [ {
    "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",
    "public_border_group" : "br-abc-aaa1"
  } ],
  "total_count" : 1
}

狀態(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ò)誤碼