全部产品
Search
文档中心

配置审计:ListAggregators - 查询账号组列表

更新时间:Feb 04, 2024

查询当前账号管理或所在的账号组列表。

接口说明

本文将提供一个示例,查询账号组列表,单次最多返回 10 条数据。返回结果显示,账号组名称为Test_Group、账号组描述为测试组、账号组类型为CUSTOM(自定义账号组)、账号组内成员账号个数为 2 等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:ListAggregatorsRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
NextTokenstring

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0
MaxResultsinteger

单次请求返回结果的最大条数。取值范围:1~100。

10

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

RequestIdstring

请求 ID。

20C8526D-12C5-4336-BC72-EBD5D1BA732F
AggregatorsResultobject

账号组结果列表。

NextTokenstring

当请求的返回结果被截断时,您可以使用NextToken再次发起请求,获取从当前截断位置之后的内容。

TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0
Aggregatorsobject []

账号组列表。

AggregatorCreateTimestamplong

创建账号组的时间戳。

1623036305000
AggregatorAccountCountlong

账号组内的成员账号数量。

2
Descriptionstring

账号组描述。

测试组
AggregatorNamestring

账号组名称。

Test_Group
AggregatorStatusinteger

账号组状态。取值:

  • 0:创建中。
  • 1:创建完成。
1
AggregatorTypestring

账号组类型。取值:

  • RD:全局账号组。
  • FOLDER:资源夹账号组。
  • CUSTOM:自定义账号组。
CUSTOM
AccountIdlong

创建账号组的企业管理账号 ID。

100931896542****
AggregatorIdstring

账号组 ID。

ca-88ea626622af0055****

示例

正常返回示例

JSON格式

{
  "RequestId": "20C8526D-12C5-4336-BC72-EBD5D1BA732F",
  "AggregatorsResult": {
    "NextToken": "TGlzdFJlc291cmNlU2hhcmVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0",
    "Aggregators": [
      {
        "AggregatorCreateTimestamp": 1623036305000,
        "AggregatorAccountCount": 2,
        "Description": "测试组",
        "AggregatorName": "Test_Group",
        "AggregatorStatus": 1,
        "AggregatorType": "CUSTOM",
        "AccountId": 0,
        "AggregatorId": "ca-88ea626622af0055****",
        "FolderId": ""
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

访问错误中心查看更多错误码。