華為云計算 云知識 查詢終端節(jié)點服務的白名單列表listservicepermissionsdetails
查詢終端節(jié)點服務的白名單列表listservicepermissionsdetails

 

功能介紹

查詢當前用戶下終端節(jié)點服務的白名單列表。 說明 本帳號默認在當前用戶下終端節(jié)點服務的白名單中。

調試

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

URI

GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions

表1 路徑參數

參數

是否必選

參數類型

描述

project_id

String

項目ID。

最小長度:1

最大長度:64

vpc_endpoint_service_id

String

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

最小長度:1

最大長度:64

表2 Query參數

參數

是否必選

參數類型

描述

permission

String

權限帳號ID,格式為“iam:domain::domain_id”。 其中“domain_id”為授權用戶的帳號ID, 例如“iam:domain::6e9dfd51d1124e8d8498dce894923a0d”,支持模糊搜索。

最小長度:1

最大長度:1000

limit

Integer

查詢返回終端節(jié)點服務的白名單數量限制,即每頁返回的個數。 取值范圍:0~500,取值一般為10,20或者50,默認為10。

最小值:1

最大值:500

缺省值:10

offset

Integer

偏移量。 偏移量為一個大于0小于終端節(jié)點服務總個數的整數, 表示從偏移量后面的終端節(jié)點服務開始查詢。

最小值:0

sort_key

String

查詢結果中白名單列表的排序字段,取值為create_at,表示白名單的添加時間。

缺省值:create_at

sort_dir

String

查詢結果中白名單列表的排序方式,取值為: ● desc:降序排序 ● asc:升序排序 默認值為desc。

缺省值:desc

請求參數

表3 請求Header參數

參數

是否必選

參數類型

描述

X-Auth-Token

String

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

最小長度:1

最大長度:2048

Content-Type

String

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

缺省值:application/json

最小長度:1

最大長度:64

響應參數

狀態(tài)碼: 200

表4 響應Body參數

參數

參數類型

描述

permissions

Array of PermissionObject objects

permission列表。

total_count

Integer

滿足查詢條件的終端節(jié)點服務的白名單總條數,不受分頁(即limit、offset參數)影響。

表5 PermissionObject

參數

參數類型

描述

id

String

permission的ID,唯一標識。

permission

String

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

permission_type

String

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

created_at

String

白名單的添加時間。 采用UTC時間格式,格式為:YYYY-MMDDTHH:MM:SSZ

狀態(tài)碼: 400

表6 響應Body參數

參數

參數類型

描述

error

Error object

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

表7 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 401

表8 響應Body參數

參數

參數類型

描述

error

Error object

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

表9 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 403

表10 響應Body參數

參數

參數類型

描述

error

Error object

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

表11 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 404

表12 響應Body參數

參數

參數類型

描述

error

Error object

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

表13 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 405

表14 響應Body參數

參數

參數類型

描述

error

Error object

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

表15 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 406

表16 響應Body參數

參數

參數類型

描述

error

Error object

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

表17 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 407

表18 響應Body參數

參數

參數類型

描述

error

Error object

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

表19 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 408

表20 響應Body參數

參數

參數類型

描述

error

Error object

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

表21 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 409

表22 響應Body參數

參數

參數類型

描述

error

Error object

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

表23 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 500

表24 響應Body參數

參數

參數類型

描述

error

Error object

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

表25 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 501

表26 響應Body參數

參數

參數類型

描述

error

Error object

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

表27 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 502

表28 響應Body參數

參數

參數類型

描述

error

Error object

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

表29 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 503

表30 響應Body參數

參數

參數類型

描述

error

Error object

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

表31 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

狀態(tài)碼: 504

表32 響應Body參數

參數

參數類型

描述

error

Error object

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

表33 Error

參數

參數類型

描述

message

String

任務異常錯誤信息描述

code

String

任務異常錯誤信息編碼

請求示例

查詢終端節(jié)點服務的白名單列表

GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions?
permission={permission}&sort_dir={sort_dir}&limit={limit}&offset={offset} 查詢終端節(jié)點服務ID為“4189d3c2-8882-4871-a3c2-d380272eed88”的白名單列表。 GET https://{endpoint}/v1/{project_id}/
vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/permissions

響應示例

狀態(tài)碼: 200

服務器已成功處理了請求

{
  "permissions" : [ {
    "id" : "f2659906-c622-480a-83e9-ef42bdb67b90",
    "permission" : "*",
    "created_at" : "2018-10-18T13:26:40Z"
  } ],
  "total_count" : 1
}

狀態(tài)碼

狀態(tài)碼

描述

200

服務器已成功處理了請求

400

服務器未能處理請求

401

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

500

請求未完成。服務異常

501

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

502

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

503

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

504

網關超時

錯誤碼

請參見錯誤碼。