文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 主机安装与配置/ 查询系统配置内容列表 - ListSystemConfigs
更新时间:2025-10-31 GMT+08:00
分享

查询系统配置内容列表 - ListSystemConfigs

功能介绍

查询系统配置内容列表

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/setting/system-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

offset

Integer

参数解释:

偏移量:指定返回记录的开始位置

约束限制:

不涉及

取值范围:

最小值0,最大值2000000

默认取值:

默认为0

limit

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

type

String

系统配置的类型,取值如下:

  • vul_label_color:漏洞标签颜色配置

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of strings

系统配置信息列表

请求示例

响应示例

状态码:200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ "{\"label_name_cn\":\"在野利用\",\"label_name_en\":\"Exploited In The Wild\",\"background_color\":\"#FCF2E9\",\"text_color\":\"#FF8800\"}" ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档