華為云計(jì)算 云知識(shí) 更新終端節(jié)點(diǎn)UpdateEndpointWhite
更新終端節(jié)點(diǎn)UpdateEndpointWhite

 

功能介紹

更新或刪除允許訪問終端節(jié)點(diǎn)的白名單。

調(diào)試

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

URI

PUT /v1/{project_id}/vpc-endpoints/{vpc_endpoint_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

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

最小長(zhǎng)度:1

最大長(zhǎng)度:64

vpc_endpoint_id

String

終端節(jié)點(diǎn)的ID。

最小長(zhǎng)度:1

最大長(zhǎng)度:64

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

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

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

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

最小長(zhǎng)度:1

最大長(zhǎng)度:2048

Content-Type

String

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

缺省值:application/json

最小長(zhǎng)度:1

最大長(zhǎng)度:64

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

參數(shù)

是否必選

參數(shù)類型

描述

whitelist

Array of strings

更新或刪除用于控制訪問終端節(jié)點(diǎn)的白名單。此參數(shù)可以添加IPv4或CIDR: ● 當(dāng)取值不為空時(shí),表示將白名單更新為取值所示內(nèi)容。 ● 當(dāng)取值為空時(shí),表示刪除所有白名單。 默認(rèn)為空列表。

enable_whitelist

Boolean

是否開啟網(wǎng)絡(luò)ACL隔離。 ● true:開啟網(wǎng)絡(luò)ACL隔離 ● false:不開啟網(wǎng)絡(luò)ACL隔離 默認(rèn)值為false。

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

id

String

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

service_type

String

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

status

String

終端節(jié)點(diǎn)的連接狀態(tài)。 ● pendingAcceptance:待接受 ● creating:創(chuàng)建中 ● accepted:已接受 ● failed:失敗

ip

String

訪問所連接的終端節(jié)點(diǎn)服務(wù)的IP。 僅當(dāng)同時(shí)滿足如下條件時(shí),返回該參數(shù): ● 當(dāng)查詢連接interface類型終端節(jié)點(diǎn)服務(wù)的終端節(jié)點(diǎn)時(shí)。 ● 終端節(jié)點(diǎn)服務(wù)啟用“連接審批”功能,且已經(jīng)“接受”連接審批。 “status”可以是“accepted”或者“rejected(僅支持“接受”連接審批后再“拒絕”的情況)”。

active_status

Array of strings

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

endpoint_service_name

String

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

marker_id

Integer

終端節(jié)點(diǎn)的報(bào)文標(biāo)識(shí)。

endpoint_service_id

String

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

enable_dns

Boolean

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

dns_names

Array of strings

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

subnet_id

String

vpc_id對(duì)應(yīng)VPC下已創(chuàng)建的網(wǎng)絡(luò)(network)的ID,UUID格式。

vpc_id

String

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

created_at

String

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

updated_at

String

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

project_id

String

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

tags

Array of TagList objects

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

whitelist

Array of strings

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

enable_whitelist

Boolean

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

表5 TagList

參數(shù)

參數(shù)類型

描述

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

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表7 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 401

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表9 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 403

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表11 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 404

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表13 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 405

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表15 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 406

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表17 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 407

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表19 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 408

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表21 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 409

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表23 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 500

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表25 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 501

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表27 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 502

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表29 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 503

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表31 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 504

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表33 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

請(qǐng)求示例

更新終端節(jié)點(diǎn),設(shè)置白名單信息為192.168.1.1、192.168.1.2,開啟網(wǎng)絡(luò)ACL隔離。

PUT https://{endpoint}/v1/{project_id}/vpc-endpoints/4189d3c2-8882-4871-a3c2- d380272eed83

{ 
  "whitelist":
             [
              "192.168.1.1",
              "192.168.1.2"
             ],
  "enable_whitelist":true,
}

響應(yīng)示例

狀態(tài)碼: 200

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

{
  "id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "service_type" : "interface",
  "status" : "accepted",
  "ip" : "10.32.xx.xx",
  "marker_id" : 322312312312,
  "vpc_id" : "4189d3c2-8882-4871-a3c2-d380272eed83",
  "enable_dns" : true,
  "endpoint_service_name" : "test123",
  "endpoint_service_id" : "test123",
  "project_id" : "6e9dfd51d1124e8d8498dce894923a0d",
  "whitelist" : [ "192.168.1.1", "192.168.1.2" ],
  "enable_whitelist" : true,
  "created_at" : "2022-04-14T09:35:47Z",
  "updated_at" : "2022-04-14T09:36:47Z",
  "tags" : [ {
    "key" : "test1",
    "value" : "test1"
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

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

400

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

401

被請(qǐng)求的頁面需要用戶名和密碼

403

對(duì)被請(qǐng)求頁面的訪問被禁止

404

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

405

請(qǐng)求中指定的方法不被允許

406

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

407

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

408

請(qǐng)求超出了服務(wù)器的等待時(shí)間

409

由于沖突,請(qǐng)求無法被完成

500

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

501

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

502

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

503

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

504

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

錯(cuò)誤碼

請(qǐng)參見錯(cuò)誤碼。