華為云計算 云知識 創(chuàng)建終端節(jié)點CreateEndpoint
創(chuàng)建終端節(jié)點CreateEndpoint

 

功能介紹

創(chuàng)建終端節(jié)點,以便訪問終端節(jié)點服務。

調試

您可以在API Explorer中調試該接口,支持自動認證鑒權。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調試功能。

URI

POST /v1/{project_id}/vpc-endpoints

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID。

最小長度:1

最大長度:64

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。通過調用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)。

最小長度:1

最大長度:2048

Content-Type

String

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

缺省值:application/json

最小長度:1

最大長度:64

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

subnet_id

String

說明: 創(chuàng)建Interface類型Client必選。 需要指定vpc_id對應VPC下已創(chuàng)建的網絡(network)的ID,UUID格式。 詳細內容請參考《 虛擬私有云 API參考》中的“查詢子網”,詳見響應消息中的“id”字段。 創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時,此參數(shù)必選。 說明 ● VPC的子網網段不能與198.19.128.0/17重疊 ● VPC路由表中自定義路由的目的地址不能與198.19.128.0/17重疊

最小長度:1

最大長度:64

endpoint_service_id

String

終端節(jié)點服務的ID。 可以通過查詢終端節(jié)點服務概 要獲取要連接的終端節(jié)點服務 ID。

最小長度:1

最大長度:64

vpc_id

String

終端節(jié)點所在的VPC的ID。 詳細內容請參考《虛擬 私有云 API參考》中的“查詢VPC”, 詳見響應消息中的“id”字段。

最小長度:1

最大長度:64

enable_dns

Boolean

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

缺省值:false

tags

Array of TagList objects

標簽列表,沒有標簽默認為空數(shù)組。

routetables

Array of strings

路由表ID列表。詳細內容請參考《虛擬私有云API參考》中的“查詢VPC路由”, 詳見響應消息中的“id”字段。 創(chuàng)建連接gateway類型終端節(jié)點服務的終節(jié)點時,此參數(shù)必選。 說明 不設置此參數(shù)時,選擇默認路由表。

port_ip

String

訪問所連接的終端節(jié)點服務的IP。 創(chuàng)建終端節(jié)點時,可以指定訪問所連接的終端節(jié)點服務的IP,目前只支持IPv4類型 。 創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時,此參數(shù)必選。

最小長度:1

最大長度:128

whitelist

Array of strings

添加用于控制訪問終端節(jié)點的白名單。 創(chuàng)建終端節(jié)點時,支持訪問控制,使用此參數(shù)可以添加IPv4或CIDR,默認空列表。 僅當創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時,支持設置此參數(shù)。

enable_whitelist

Boolean

是否開啟網絡ACL隔離。

description

String

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

表4 TagList

參數(shù)

是否必選

參數(shù)類型

描述

key

String

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

最小長度:1

最大長度:36

value

String

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

最小長度:1

最大長度:43

響應參數(shù)

狀態(tài)碼: 200

表5 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

id

String

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

service_type

String

終端節(jié)點連接的終端節(jié)點服務類型。 ● gataway:由運維人員配置。用戶無需創(chuàng)建,可直接使用。 ● interface:包括運維人員配置的云服務和用戶自己創(chuàng)建的私有服務。 其中,運維人員配置的云服務無需創(chuàng)建,用戶可直接使用。 您可以通過查詢公共終端節(jié)點服務列表, 查看由運維人員配置的所有用戶可見且可連接的終端節(jié)點服務, 并通過創(chuàng)建終端節(jié)點服務創(chuàng)建Interface類型的終端節(jié)點服務。

status

String

終端節(jié)點的狀態(tài)。 ● pendingAcceptance:待接受 ● creating:創(chuàng)建中 ● accepted:已接受 ● rejected:已拒絕 ● failed:失敗 ● deleting:刪除中

ip

String

終端節(jié)點ip

active_status

Array of strings

帳號狀態(tài)。 ● frozen:凍結 ● active:解凍

endpoint_service_name

String

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

marker_id

Integer

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

endpoint_service_id

String

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

enable_dns

Boolean

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

dns_names

Array of strings

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

subnet_id

String

vpc_id對應VPC下已創(chuàng)建的網絡(network)的ID,UUID格式。

vpc_id

String

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

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

標簽列表,沒有標簽默認為空數(shù)組。

whitelist

Array of strings

控制訪問終端節(jié)點的白名單。 若未創(chuàng)建,則返回空列表。 創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時,顯示此參數(shù)。

enable_whitelist

Boolean

是否開啟網絡ACL隔離。 ● true:開啟網絡ACL隔離 ● false:不開啟網絡ACL隔離 若未指定,則返回false。 創(chuàng)建連接Interface類型終端節(jié)點服務的終端節(jié)點時,顯示此參數(shù)。

routetables

Array of strings

路由表ID列表。 若未指定,返回默認VPC下路由表ID。 創(chuàng)建連接Gateway類型終端節(jié)點服務的終端節(jié)點時,顯示此參數(shù)。

specification_name

String

規(guī)格名稱

description

String

描述

policy_statement

Array of strings

只涉及開啟雙端固定的網關型終端節(jié)點,響應體展示此字段

enable_status

String

終端節(jié)點是否已停用,取值【enable/disable】

endpoint_pool_id

String

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

public_border_group

String

終端節(jié)點對應Pool的Public Border Group信息

表6 TagList

參數(shù)

參數(shù)類型

描述

key

String

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

最小長度:1

最大長度:36

value

String

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

最小長度:1

最大長度:43

狀態(tài)碼: 400

表7 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表8 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 401

表9 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表10 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 403

表11 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表12 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 404

表13 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表14 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 405

表15 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表16 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 406

表17 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表18 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 407

表19 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表20 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 408

表21 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表22 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 409

表23 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表24 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 500

表25 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表26 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 501

表27 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表28 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 502

表29 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表30 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 503

表31 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表32 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 504

表33 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error

Error object

提交任務異常時返回的異常信息

表34 Error

參數(shù)

參數(shù)類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

請求示例

創(chuàng)建一個終端節(jié)點,不創(chuàng)建域名。

POST https://{endpoint}/v1/{project_id}/vpc-endpoints

{
  "subnet_id" : "5d1c1d71-2613-4274-b34e-d82af550f967",
  "vpc_id" : "4e65f8b1-306d-4522-8ecd-aa374000e2a4",
  "endpoint_service_id" : "813d9300-8473-405b-bfcd-f711117bad65",
  "enable_dns" : "false"
}

響應示例

狀態(tài)碼: 200

服務器已成功處理了請求

{
  "id" : "492c776f-2cb9-40a2-9735-d7279ab2bbb6",
  "status" : "accepted",
  "ip" : "172.16.0.154",
  "tags" : [ ],
  "whitelist" : [ ],
  "marker_id" : 302010104,
  "active_status" : [ "active" ],
  "vpc_id" : "0da03835-1dcf-4361-9b87-34139d58dd59",
  "service_type" : "interface",
  "project_id" : "0605767a3300d5762fb7c0186d9e1779",
  "subnet_id" : "fb1b8b7e-f34c-4ff1-b3a7-221acef3b3aa",
  "enable_dns" : false,
  "created_at" : "2022-04-28T02:44:50Z",
  "updated_at" : "2022-04-28T02:56:15Z",
  "endpoint_service_id" : "8843fac2-bc01-445a-a822-c8124ff3968c",
  "endpoint_service_name" : "br-abc-aaa1.vm_test.8843fac2-bc01-445a-a822-c8124ff3968c",
  "enable_whitelist" : false,
  "specification_name" : "default",
  "endpoint_pool_id" : "501f4a3b-6f96-4309-97d1-e291b8ca5b96",
  "enable_status" : "enable",
  "public_border_group" : "center"
}

狀態(tài)碼

狀態(tài)碼

描述

200

服務器已成功處理了請求

400

服務器未能處理請求

401

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

403

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

404

服務器無法找到被請求的頁面

405

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

406

服務器生成的響應無法被客戶端所接受

407

用戶必須首先使用代理服務器進行驗證,這樣請求才會被處理

408

請求超出了服務器的等待時間

409

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

500

請求未完成。服務異常

501

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

502

請求未完成。服務器從上游服務器收到一個無效的響應

503

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

504

網關超時

錯誤碼

請參見錯誤碼