華為云計(jì)算 云知識(shí) 批量添加終端節(jié)點(diǎn)服務(wù)的白名單BatchAddEndpointServicePermissions
批量添加終端節(jié)點(diǎn)服務(wù)的白名單BatchAddEndpointServicePermissions

 

功能介紹

批量添加當(dāng)前用戶下終端節(jié)點(diǎn)服務(wù)的白名單,支持添加描述信息。 說明 本帳號(hào)默認(rèn)在自身用戶的終端節(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

POST /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions/batch-create

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID。

最小長(zhǎng)度:1

最大長(zhǎng)度:64

vpc_endpoint_service_id

String

終端節(jié)點(diǎn)服務(wù)的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)度:65

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

參數(shù)

是否必選

參數(shù)類型

描述

permissions

Array of EpsAddPermissionRequest objects

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

permission_type

String

終端節(jié)點(diǎn)服務(wù)白名單類型。 ● domainId:基于賬戶ID配置終端節(jié)點(diǎn)服務(wù)白名單。 ● orgPath:基于賬戶所在組織路徑配置終端節(jié)點(diǎn)服務(wù)白名單。

表4 EpsAddPermissionRequest

參數(shù)

是否必選

參數(shù)類型

描述

permission

String

權(quán)限格式為:iam:domain::domain_id或者organizations:orgPath::org_path其中, ● “iam:domain::”和“organizations:orgPath::”為固定格式。 ● “domain_id”為可連接用戶的帳號(hào)ID,org_path可連接用戶的組織路徑 domain_id類型支持輸入包括“a~z”、“A~Z”、“0~9”或者“,最大長(zhǎng)度可以傳64; org_path類型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”,最大長(zhǎng)度可以傳1024; 例如:iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/

description

String

終端節(jié)點(diǎn)服務(wù)白名單描述

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

permissions

Array of EpsPermission objects

終端節(jié)點(diǎn)服務(wù)白名單響應(yīng)體。

表6 EpsPermission

參數(shù)

參數(shù)類型

描述

id

String

白名單表主鍵ID

permission

String

權(quán)限格式為:iam:domain::domain_id或者organizations:orgPath::org_path其中, ● “iam:domain::”和“organizations:orgPath::”為固定格式。 ● “domain_id”為可連接用戶的帳號(hào)ID,org_path可連接用戶的組織路徑 domain_id類型支持輸入包括“a~z”、“A~Z”、“0~9”或者“”,org_path類型支持“a~z”、“A~Z”、“0~9”、“/-?”或者“”。 “”表示所有終端節(jié)點(diǎn)可連接。 例如:iam:domain::6e9dfd51d1124e8d8498dce894923a0dd或者organizations:orgPath::o-3j59d1231uprgk9yuvlidra7zbzfi578/r-rldbu1vmxdw5ahdkknxnvd5rgag77m2z/ou-7tuddd8nh99rebxltawsm6qct5z7rklv/*

最小長(zhǎng)度:1

最大長(zhǎng)度:1024

permission_type

String

終端節(jié)點(diǎn)服務(wù)白名單類型。 ● domainId:基于賬戶ID配置終端節(jié)點(diǎn)服務(wù)白名單。 ● orgPath:基于賬戶所在組織路徑配置終端節(jié)點(diǎn)服務(wù)白名單。

description

String

終端節(jié)點(diǎn)服務(wù)白名單描述

created_at

String

白名單創(chuàng)建時(shí)間

狀態(tài)碼: 400

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表8 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 401

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表10 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 403

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表12 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 404

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表14 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 405

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表16 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 406

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表18 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 407

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表20 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 408

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表22 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 409

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表24 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 500

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表26 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 501

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表28 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 502

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表30 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 503

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表32 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

狀態(tài)碼: 504

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

參數(shù)

參數(shù)類型

描述

error

Error object

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

表34 Error

參數(shù)

參數(shù)類型

描述

message

String

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

code

String

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

請(qǐng)求示例

批量添加終端節(jié)點(diǎn)服務(wù)的白名單

POST https://{endpoint}/v1/{project_id}/vpc-endpoint-services/c07132bf-4071-439a-9ff3-2068eb45092f/
permissions/batch-create { "permissions" : [ { "permission" : "*", "description" : "批量添加終端節(jié)點(diǎn)服務(wù)白名單接口" }, { "permission" : "iam:domain::4dbb0ce8766f44a9bfd08ccf8fc02397", "description" : "test" } ] }

響應(yīng)示例

狀態(tài)碼: 200

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

{
  "permissions" : [ {
    "id" : "ab42a58b-6f8e-43b3-9400-aaf0e393ee0d",
    "permission" : "iam:domain::4dbb0ce8766f44a9bfd08ccf8fc02397",
    "description" : "test",
    "created_at" : "2022-06-16T10:03:27Z"
  }, {
    "id" : "dfaaeff1-858d-4631-83c4-be3548a07935",
    "permission" : "*",
    "description" : "",
    "created_at" : "2022-06-16T10:03:27Z"
  } ]
}

狀態(tài)碼

狀態(tài)碼

描述

200

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

400

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

401

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

403

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

404

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

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ò)誤碼。