文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 安装配置/ 批量添加账号 - BatchAddAccounts
更新时间:2025-10-31 GMT+08:00
分享

批量添加账号 - BatchAddAccounts

功能介绍

批量添加账号

授权信息

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

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

URI

POST /v5/setting/account/accounts

表1 Query参数

参数

是否必选

参数类型

描述

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

表3 请求Body参数

参数

是否必选

参数类型

描述

data_list

Array of AddAccountsRequestInfo objects

账号列表详情

表4 AddAccountsRequestInfo

参数

是否必选

参数类型

描述

organization_id

String

组织Id

account_id

String

账号ID

account_name

String

账号名称

响应参数

状态码:200

表5 响应Header参数

参数

参数类型

描述

X-request-id

String

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

表6 响应Body参数

参数

参数类型

描述

is_all_legal_count

Boolean

批量添加账号结果

  • true :成功

  • false :失败

请求示例

添加account_name为test_name、organization_id为o-jbg8sokerqszi0zdo6vvaulwdsenonxz,account_id为 6a321faa6e6c4a18b5bf19dd954377b5的账号

POST https://{endpoint}/v5/setting/account/accounts?enterprise_project_id=all_granted_eps

{
  "account_id" : "6a321faa6e6c4a18b5bf19dd954377b5",
  "organization_id" : "o-jbg8sokerqszi0zdo6vvaulwdsenonxz",
  "account_name" : "test_name"
}

响应示例

状态码:200

请求已成功

{
  "is_all_legal_count" : true
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档