文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 主机安装与配置/ 获取字典列表 - ListDictionaries
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

获取字典列表 - ListDictionaries

功能介绍

获取字典列表

授权信息

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

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

URI

GET /v5/{project_id}/setting/dictionaries

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

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

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

是

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值0，最大值2000000

默认取值:

不涉及

limit

是

Integer

参数解释:

每页显示个数

约束限制:

不涉及

取值范围:

取值10-200

默认取值:

10

scene

否

String

参数解释:

使用场景（如果没有区分可以忽略）

约束限制:

不涉及

取值范围:

  • hws： 国内站。

  • hec-hk：国际站。

默认取值:

不涉及

group_code

是

String

参数解释:

字典分组

约束限制:

不涉及

取值范围:

  • featureSwitch： 页面特性开关。

默认取值:

不涉及

code

否

String

参数解释:

字典项编码，group_code下字典项编码不重复

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of Dictionary objects

字典项数量
表5 Dictionary

参数

参数类型

描述

code

String

参数解释：

字典编码

取值范围：

字符长度1-256位

value

String

参数解释：

字典值（单个值）

取值范围：

字符长度1-65535位

values

Array of strings

参数解释：

字典值（多个值）

取值范围：

请求示例

无

响应示例

状态码：200

请求已成功

{
  "total_num" : 1,
  "data_list" : [ {
    "code" : "cmw-zookeeper-ndr-02",
    "value" : "[{ccc}]",
    "values" : [ "47D7D20274DB309495ADFBC7A74FA8AB", "47D7D20274DB309495ADFBC7A74FA8AB" ]
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 主机安装与配置

相关文档