文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 查询系统配置 - ShowTenantSystemConfigs
更新时间：2026-06-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询系统配置 - ShowTenantSystemConfigs

功能介绍

查询系统配置

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

GET /v2/system-configs

表1 Query参数

参数

是否必选

参数类型

描述

search

否

String

参数解释：

关键字检索（前缀匹配）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

data

Array of SystemConfigItem objects

参数解释：

系统配置列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

total

Integer

参数解释：

系统配置条数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 SystemConfigItem

参数

参数类型

描述

id

String

参数解释：

系统配置ID，每个系统配置都有唯一的ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

key

String

参数解释：

系统配置的key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

String

参数解释：

系统配置的value。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

description

String

参数解释：

系统配置的描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

create_time

String

参数解释：

系统配置的创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

creator

String

参数解释：

系统配置的创建者。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

last_reviser

String

参数解释：

系统配置的最后修改人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

domain_id

String

参数解释:

租户ID，值来源于IAM的租户ID。

取值范围:

32位uuid。

has_default_config

Boolean

参数解释：

是否具有默认配置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

last_update_time

String

参数解释：

系统配置最后一次修改时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

查询错误码为CC.10010263.500的系统配置详情。

GET https://{endpoint}/v2/system-configs?search=errorCode_CC.10010263.500

响应示例

状态码：200

系统配置列表

{
  "data" : [ {
    "id" : "ce73d793f81511ef8c02fa163eed4919",
    "key" : "errorCode_CC.00030009.400",
    "value" : "codeartscheck_02_0157",
    "description" : "CC.00030009.400，规则集信息不存在",
    "create_time" : "2025-03-03 17:18:37.0",
    "creator" : "SYSTEM",
    "last_reviser" : "SYSTEM",
    "domain_id" : null,
    "has_default_config" : null,
    "last_update_time" : "2025-03-03 17:18:37.0"
  } ],
  "total" : 1
}

状态码：400

请求异常。

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

权限不足。

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

系统配置列表

400

请求异常。

401

权限不足。

错误码

请参见错误码。

父主题： 任务管理

相关文档