文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 安装配置/ 查询多账号列表 - ListAccounts
更新时间:2025-10-31 GMT+08:00
分享

查询多账号列表 - ListAccounts

功能介绍

查询多账号列表

授权信息

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

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

URI

GET /v5/setting/account/accounts

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页显示数量

offset

Integer

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

enterprise_project_id

String

主机所属的企业项目ID。

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

企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

region

String

Region ID

响应参数

状态码:200

表3 响应Header参数

参数

参数类型

描述

X-request-id

String

用于任务跟踪的请求ID号。格式为request_uuid-timestamp-hostname。

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

参数解释:

总数

取值范围:

最小值0,最大值2147483647

data_list

Array of AccountResponseInfo objects

事件列表详情

表5 AccountResponseInfo

参数

参数类型

描述

account_name

String

账号名称

account_id

String

账号Id

organization_id

String

组织Id

project_id

String

项目Id

project_name

String

项目名称

host_num

Integer

主机数量

vulnerability_num

Integer

漏洞风险数量

baseline_num

Integer

基线检测风险数量

intrusion_num

Integer

安全告警风险数量

请求示例

查询所有账号

GET https://{endpoint}/v5/setting/account/accounts?offset=0&limit=200&enterprise_project_id=all_granted_eps

响应示例

状态码:200

请求已成功

{
  "data_list" : [ {
    "account_name" : "scc_cnfw",
    "account_id" : "6a321faa6e6c4a18b5bf19dd954377b5",
    "organization_id" : "o-jbg8sokerqszi0zdo6vvaulwdsenonxz",
    "project_id" : "2349ba469daf4b7daf268bb0261d18b0",
    "project_name" : "cn-north-7",
    "host_num" : 11,
    "vulnerability_num" : 0,
    "baseline_num" : 77,
    "intrusion_num" : 0
  } ],
  "total_num" : 1
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档