更新时间:2025-08-12 GMT+08:00

查询账号列表

功能介绍

查询账号列表

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/system/multi-account/accounts

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

limit

Integer

参数解释

查询返回记录的数量限制

约束限制

不涉及

取值范围

1-1024

默认取值

不涉及

offset

Integer

参数解释

偏移量,表示查询该偏移量后面的记录

约束限制

不涉及

取值范围

0 - 1024

默认取值

不涉及

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

PageDataAccountVO object

表4 PageDataAccountVO

参数

参数类型

描述

limit

Integer

参数解释

数量限制

取值范围

不涉及

offset

Integer

参数解释

偏移量

取值范围

不涉及

records

Array of AccountVO objects

参数解释

账号列表

取值范围

不涉及

total

Long

参数解释

总数

取值范围

不涉及

表5 AccountVO

参数

参数类型

描述

account_id

String

参数解释

账号ID

取值范围

不涉及

account_name

String

参数解释

账号名称

取值范围

不涉及

eip_count_protected

Integer

参数解释

防护的EIP数量

取值范围

不涉及

eip_count_total

Integer

参数解释

EIP总数

取值范围

不涉及

eip_count_unprotected

Integer

参数解释

未开启防护的EIP数量

取值范围

不涉及

organization_id

String

参数解释

组织ID

取值范围

不涉及

project_id

String

参数解释

项目ID

取值范围

不涉及

project_name

String

参数解释

项目名称

取值范围

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询账号列表,项目ID为176d761dc156471c9c9b227376594160,防火墙ID为ea0e700f-7ae6-47c1-a8d0-ed4b1acd8e8e,数量限制为50,偏移量为0

https://{Endpoint}/v1/176d761dc156471c9c9b227376594160/system/multi-account/accounts?limit=50&offset=0&fw_instance_id=ea0e700f-7ae6-47c1-a8d0-ed4b1acd8e8e

响应示例

状态码:200

OK

{
  "data" : {
    "limit" : 50,
    "offset" : 0,
    "records" : [ {
      "account_id" : "09bb24e6f280d23d0f9fc0104b901480",
      "account_name" : "SCC_CNFW_c00617156",
      "eip_count_protected" : 0,
      "eip_count_total" : 36,
      "eip_count_unprotected" : 36,
      "organization_id" : "o-r0b4bh2jcr1ke7yn70uhwlp5d0ktwisb",
      "project_id" : "09bb24e6fe80d23d2fa2c010b53b418c",
      "project_name" : "cn-north-7"
    } ],
    "total" : 1
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "参数错误"
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码