文档首页/ 流水线 CodeArts Pipeline/ API参考/ API/ 流水线管理/ 白名单查询 - QueryWhitelist
更新时间:2026-09-18 GMT+08:00

白名单查询 - QueryWhitelist

功能介绍

根据白名单类型查询租户对应资源的白名单开关。

调用方法

请参见如何调用API。

URI

GET /v5/{tenant_id}/api/whitelist/query

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

是

String

参数解释:

租户ID,用户的domainId。

约束限制:

不涉及。

取值范围:

32位字符,仅由数字和字母组成。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

domain_id

是

String

参数解释:

租户ID,用户的domainId。

约束限制:

不涉及。

取值范围:

32位字符,仅由数字和字母组成。

默认取值:

不涉及。

region

是

String

参数解释:

局点信息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

是

String

参数解释:

CodeArts项目的32位UUID,项目唯一标识。

约束限制:

不涉及。

取值范围:

32位字符。

默认取值:

不涉及。

type

是

Array of strings

参数解释:

白名单类型。

约束限制:

不涉及。

取值范围:

任意白名单类型。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

error

ErrorInfo object

参数解释:

错误信息,接口正常无报错时不返回error字段。

取值范围:

不涉及。

result

Object

参数解释:

返回结果。

取值范围:

不涉及。

status

String

参数解释:

状态值。

取值范围:

不涉及。

表4 ErrorInfo

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误信息。

取值范围:

不涉及。

请求示例

GET https://{endpoint}/v5/ce8df55870164338a72d7e828a966a2a/api/whitelist/query?domain_id=ce8df55870164338a72d7e828a966a2a&region=xxx-7&type=open_source_policy,gitops_genai&project_id=&_=1763884406958

响应示例

状态码:200

[ {
  "type" : "open_source_policy",
  "enable" : false
}, {
  "type" : "gitops_genai",
  "enable" : false
} ]

状态码

状态码

描述

200

OK

错误码

请参见错误码。