功能介紹
創(chuàng)建終端節(jié)點(diǎn)服務(wù),允許其他用戶創(chuàng)建終端節(jié)點(diǎn)連接您創(chuàng)建的終端節(jié)點(diǎn)服務(wù), 使用您所提供的服務(wù)。 說(shuō)明 該接口為異步接口,調(diào)用成功會(huì)返回200狀態(tài)碼,說(shuō)明請(qǐng)求已正常下發(fā)。 通常創(chuàng)建終端節(jié)點(diǎn)服務(wù)需要1~2分鐘,可以通過(guò)查詢終端節(jié)點(diǎn)服務(wù)詳情查看創(chuàng)建結(jié)果。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
POST /v1/{project_id}/vpc-endpoint-services
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID,獲取方法請(qǐng)參見(jiàn)獲取項(xiàng)目ID。 最小長(zhǎng)度:1 最大長(zhǎng)度:64 |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。用戶Token也就是調(diào)用獲取用戶Token接口的響應(yīng)值, 該接口是唯一不需要認(rèn)證的接口。 請(qǐng)求響應(yīng)成功后在響應(yīng)消息頭(Headers)中包含的“X-Subject-Token”的值即為T(mén)oken值。 最小長(zhǎng)度:1 最大長(zhǎng)度:2048 |
|
Content-Type |
否 |
String |
發(fā)送的實(shí)體的MIME類(lèi)型。推薦用戶默認(rèn)使用application/json, 如果API是對(duì)象、 鏡像 上傳等接口,媒體類(lèi)型可按照流類(lèi)型的不同進(jìn)行確定。 缺省值:application/json |
|
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|---|
|
port_id |
是 |
String |
標(biāo)識(shí)終端節(jié)點(diǎn)服務(wù)后端資源的ID, 格式為通用唯一識(shí)別碼(Universally Unique Identifier,下文簡(jiǎn)稱UUID)。 取值為:
|
|
service_name |
否 |
String |
終端節(jié)點(diǎn)服務(wù)的名稱,長(zhǎng)度不大于16,允許傳入大小寫(xiě)字母、數(shù)字、下劃線、中劃線。
|
|
vpc_id |
是 |
String |
終端節(jié)點(diǎn)服務(wù)對(duì)應(yīng)后端資源所在的VPC的ID。 詳細(xì)內(nèi)容請(qǐng)參考《 虛擬私有云 API參考》中的“查詢VPC”,詳見(jiàn)響應(yīng)消息中的“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ù)所屬用戶審核后方可使用。 默認(rèn)為true,需要審批。 缺省值:true |
|
service_type |
否 |
String |
終端節(jié)點(diǎn)服務(wù)類(lèi)型。 僅支持將用戶私有服務(wù)創(chuàng)建為interface類(lèi)型的終端節(jié)點(diǎn)服務(wù)。 終端節(jié)點(diǎn)服務(wù)類(lèi)型包括“網(wǎng)關(guān)(gateway)型”和“接口(interface)型”: ● gateway:由運(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)創(chuàng)建訪問(wèn)Gateway和Interface類(lèi)型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)。 缺省值:interface |
|
server_type |
是 |
String |
資源類(lèi)型。 ● VM:云服務(wù)器,適用于作為服務(wù)器使用。 ● VIP:虛擬IP,適用于作為虛IP場(chǎng)景使用。(該字段已廢棄,請(qǐng)優(yōu)先使用LB類(lèi)型) ● LB:負(fù)載均衡,適用于高訪問(wèn)量業(yè)務(wù)和對(duì)可靠性和容災(zāi)性要求較高的業(yè)務(wù)。 |
|
ports |
是 |
服務(wù)開(kāi)放的端口映射列表,詳細(xì)內(nèi)容請(qǐng)參見(jiàn)表4-10。 同一個(gè)終端節(jié)點(diǎn)服務(wù)下,不允許重復(fù)的端口映射。若多個(gè)終端節(jié)點(diǎn)服務(wù)共用一個(gè)port_id, 則終端節(jié)點(diǎn)服務(wù)之間的所有端口映射的server_port和protocol的組合不能重復(fù), 單次最多添加200個(gè)。 |
|
|
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”。 缺省值:close |
|
tags |
否 |
資源標(biāo)簽列表。同一個(gè)終端節(jié)點(diǎn)服務(wù)最多可添加10個(gè)標(biāo)簽。 |
|
|
description |
否 |
String |
描述字段,支持中英文字母、數(shù)字等字符,不支持“<”或“>”字符。 描述字段,支持中英文字母、數(shù)字等字符,不支持“<”或“>”字符。 |
|
enable_policy |
否 |
Boolean |
是否開(kāi)啟終端節(jié)點(diǎn)策略。 ● false:不支持設(shè)置終端節(jié)點(diǎn)策略 ● true:支持設(shè)置終端節(jié)點(diǎn)策略 默認(rèn)為false 缺省值:false |
|
參數(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 |
|
參數(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 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(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)稱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ù)的名稱。 最小長(zhǎng)度:0 最大長(zhǎng)度:128 |
|
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。 |
|
pool_id |
String |
終端節(jié)點(diǎn)服務(wù)對(duì)應(yīng)的集群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:失敗 |
|
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 |
|
ports |
服務(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ù)。 |
|
|
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”。 |
|
tags |
資源標(biāo)簽列表 |
|
|
description |
String |
描述字段,支持中英文字母、數(shù)字等字符,不支持“<”或“>”字符。 |
|
enable_policy |
Boolean |
是否開(kāi)啟終端節(jié)點(diǎn)策略。 ● false:不支持設(shè)置終端節(jié)點(diǎn)策略 ● true:支持設(shè)置終端節(jié)點(diǎn)策略 默認(rèn)為false |
|
參數(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 |
|
參數(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 |
狀態(tài)碼: 400
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 401
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 403
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 404
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 405
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 406
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 407
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 408
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 409
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 500
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 501
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 502
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 503
|
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
|---|---|---|
|
message |
String |
任務(wù)異常錯(cuò)誤信息描述 |
|
code |
String |
任務(wù)異常錯(cuò)誤信息編碼 |
狀態(tài)碼: 504
請(qǐng)求示例
創(chuàng)建接口型終端節(jié)點(diǎn)服務(wù),資源類(lèi)型為VM,訪問(wèn)端口為8080和8081,服務(wù)端口為90和80,端口映射協(xié)議為T(mén)CP,無(wú)需審批。
POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services
{
"port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
"approval_enabled" : false,
"service_type" : "interface",
"server_type" : "VM",
"ports" : [ {
"client_port" : 8080,
"server_port" : 90,
"protocol" : "TCP"
}, {
"client_port" : 8081,
"server_port" : 80,
"protocol" : "TCP"
} ]
}
響應(yīng)示例
狀態(tài)碼: 200
服務(wù)器已成功處理了請(qǐng)求
{
"id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
"port_id" : "4189d3c2-8882-4871-a3c2-d380272eed88",
"vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed80",
"pool_id" : "5289d3c2-8882-4871-a3c2-d380272eed80",
"status" : "available",
"approval_enabled" : false,
"service_name" : "test123",
"service_type" : "interface",
"server_type" : "VM",
"project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
"created_at" : "2022-04-14T09:35:47Z",
"ports" : [ {
"client_port" : 8080,
"server_port" : 90,
"protocol" : "TCP"
}, {
"client_port" : 8081,
"server_port" : 80,
"protocol" : "TCP"
} ]
}
狀態(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)服務(wù)管理_VPC終端節(jié)點(diǎn)是什么
- 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)景
- VPC終端節(jié)點(diǎn)的作用是什么_VPC終端節(jié)點(diǎn)應(yīng)用場(chǎng)景_華為云VPC終端節(jié)點(diǎn)
- 如何創(chuàng)建用戶并授權(quán)使用應(yīng)用運(yùn)維管理服務(wù)_AOM_用戶權(quán)限_創(chuàng)建用戶_權(quán)限
- 如何在代碼托管服務(wù)中創(chuàng)建云端倉(cāng)庫(kù)?
