GetAggregator を使用してアカウントグループの詳細をクエリする - Cloud Config

アカウントグループの名前、作成時間、メンバー、タイプを照会します。

操作説明

このトピックでは、アカウントグループ ca-88ea626622af0055**** の詳細を照会する方法の例を示します。応答は、アカウントグループ名が Test_Group、説明が Test Group、タイプが CUSTOM (カスタムアカウントグループ)、ステータスが 1 (作成済み) であることを示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

config:GetAggregator

get

*Aggregator

acs:config:*:{#accountId}:aggregator/{#AggregatorId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AggregatorId	string	必須	アカウントグループの ID。	ca-88ea626622af0055****
Tag `deprecated`	array<object>	任意	リソースのタグ。このパラメーターは非推奨であり、使用されていません。最大 20 個のタグをアタッチできます。
	object	任意	リソースのタグ。最大 20 個のタグをアタッチできます。
Key	string	任意	リソースのタグキー。最大 20 個のタグキーをアタッチできます。	key-1
Value	string	任意	リソースのタグ値。最大 20 個のタグ値をアタッチできます。	value-1

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド	型	説明	例
	object	なし
RequestId	string	リクエスト ID。	733DD93C-2277-4905-AE0C-0BA95C04B8BC
Aggregator	object	アカウントグループに関する情報。
AggregatorCreateTimestamp	string	アカウントグループが作成されたときのタイムスタンプ。単位: ミリ秒。	1623034091000
AggregatorAccounts	array<object>	アカウントグループ内のメンバーに関する情報。
	object	なし
RecorderStatus	string	メンバーのリソース監視のステータス。有効な値: REGISTRABLE: 未登録。 BUILDING: ビルド中。 REGISTERED: 登録済み。 REBUILDING: 再ビルド中。	REGISTERED
AccountId	integer	メンバー ID。	171322098523****
AccountType	string	アカウントのタイプ。 ResourceDirectory のみがサポートされています。	ResourceDirectory
AccountName	string	メンバー名。	Alice
AggregatorAccountCount	integer	アカウントグループ内のメンバー数。	2
Description	string	アカウントグループの説明。	The description of the aggregator.
AggregatorName	string	アカウントグループの名前。	Test_Group
AggregatorStatus	integer	アカウントグループのステータス。有効な値: 0: アカウントグループは作成中です。 1: アカウントグループは作成済みです。	1
AggregatorType	string	アカウントグループのタイプ。有効な値: RD: グローバルアカウントグループ。 FOLDER: フォルダアカウントグループ。 CUSTOM: カスタムアカウントグループ。	CUSTOM
AccountId	integer	アカウントグループの作成に使用される管理アカウントの ID。	100931896542****
AggregatorId	string	アカウントグループの ID。	ca-88ea626622af0055****
FolderName	string	フォルダアカウントグループがアタッチされているフォルダの名前。複数の名前はコンマ (,) で区切られます。	Example-name
Tags	array<object>	リソースタグ。
	object	リソースタグ。
TagKey	string	タグキー。	key-1
TagValue	string	タグ値。	value-1
FolderId	string	フォルダアカウントグループがアタッチされているフォルダの ID。	fd-brHdgv****

例

成功レスポンス

JSONJSON

{
  "RequestId": "733DD93C-2277-4905-AE0C-0BA95C04B8BC",
  "Aggregator": {
    "AggregatorCreateTimestamp": "1623034091000",
    "AggregatorAccounts": [
      {
        "RecorderStatus": "REGISTERED",
        "AccountId": 0,
        "AccountType": "ResourceDirectory",
        "AccountName": "Alice"
      }
    ],
    "AggregatorAccountCount": 2,
    "Description": "The description of the aggregator.",
    "AggregatorName": "Test_Group",
    "AggregatorStatus": 1,
    "AggregatorType": "CUSTOM",
    "AccountId": 0,
    "AggregatorId": "ca-88ea626622af0055****",
    "FolderName": "Example-name",
    "Tags": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "FolderId": "fd-brHdgv****"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.AggregatorId.Value	The specified AggregatorId is invalid.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。