GetAggregator - 查询账号组详情

查询账号组的名称、创建时间、成员和账号组类型等。

接口说明

本文将提供一个示例,查询账号组ca-88ea626622af0055****的详情。返回结果显示,账号组名称为Test_Group、账号组描述为测试组、账号组类型为CUSTOM(自定义账号组)、账号组状态为1 (创建完成)等。

调试

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

授权信息

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

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

请求参数

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

账号组 ID。

ca-88ea626622af0055****

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

返回参数

名称类型描述示例值
object

RequestIdstring

请求 ID。

733DD93C-2277-4905-AE0C-0BA95C04B8BC
Aggregatorobject

账号组信息。

AggregatorCreateTimestampstring

创建账号组的时间戳。

单位:毫秒。

1623034091000
AggregatorAccountsarray<object>

账号组内的成员信息。

AggregatorAccountsobject

RecorderStatusstring

成员的资源监控状态。取值:

  • REGISTRABLE:未注册。
  • BUILDING:构建中。
  • REGISTERED:已注册。
  • REBUILDING:重新构建中。
REGISTERED
AccountIdlong

成员 ID。

171322098523****
AccountTypestring

成员归属。仅支持 ResourceDirectory(资源目录)。

ResourceDirectory
AccountNamestring

成员名称。

Alice
AggregatorAccountCountlong

账号组内成员的数量。

2
Descriptionstring

账号组描述。

测试组
AggregatorNamestring

账号组名称。

Test_Group
AggregatorStatusinteger

账号组状态。取值:

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

账号组类型。取值:

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

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

100931896542****
AggregatorIdstring

账号组 ID。

ca-88ea626622af0055****
FolderIdstring

资源夹账号组绑定的资源夹 ID。

fd-brHdgv****

示例

正常返回示例

JSON格式

{
  "RequestId": "733DD93C-2277-4905-AE0C-0BA95C04B8BC",
  "Aggregator": {
    "AggregatorCreateTimestamp": "1623034091000",
    "AggregatorAccounts": [
      {
        "RecorderStatus": "REGISTERED",
        "AccountId": 0,
        "AccountType": "ResourceDirectory",
        "AccountName": "Alice"
      }
    ],
    "AggregatorAccountCount": 2,
    "Description": "测试组",
    "AggregatorName": "Test_Group",
    "AggregatorStatus": 1,
    "AggregatorType": "CUSTOM",
    "AccountId": 0,
    "AggregatorId": "ca-88ea626622af0055****",
    "FolderId": "fd-brHdgv****"
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.AggregatorId.ValueThe specified AggregatorId is invalid.账号组ID不存在或无权限使用该账号组。
404AccountNotExistedYour account does not exist.-
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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