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

指定されたアカウントグループ内の指定されたルールの詳細を照会します。

操作説明

この Topic では、アカウントグループ ca-7f00626622af0041**** 内のルール cr-7f7d626622af0041**** の詳細をクエリする方法の例を示します。

今すぐお試しください

この 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:GetAggregateConfigRule

get

*AggregateConfigRule。

acs:config:*:{#accountId}:aggregateconfigrule/{#ConfigRuleId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConfigRuleId	string	必須	ルールの ID。ルール ID の取得方法については、「 ListAggregateConfigRules 」をご参照ください。	cr-7f7d626622af0041****
AggregatorId	string	必須	アカウントグループの ID。アカウントグループ ID の取得方法については、「 ListAggregators 」をご参照ください。	ca-7f00626622af0041****
Tag `deprecated`	array<object>	任意	タグ。このパラメーターは非推奨であり、効果はありません。
	object	任意	リソースのタグ。このパラメーターは非推奨であり、効果はありません。最大値は 20 タグです。
Key	string	任意	リソースのタグキー。最大値は 20 タグキーです。	key-1
Value	string	任意	リソースのタグ値。最大値は 20 タグ値です。	値-1

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

レスポンスフィールド

フィールド	型	説明	例
	object	なし。
RequestId	string	リクエスト ID。	811234F4-C3AB-4D15-B90B-F55016D1B5AA
ConfigRule	object	ルールのリスト。
RiskLevel	integer	ルールのリスクレベル。有効な値: 1: 高リスク。 2: 中間リスク。 3: 低リスク。	1
InputParameters	object	ルールのパラメーター情報。	{"tag1Key":"ECS","tag1Value":"test"}
Source	object	ルールのソース情報。
SourceDetails	array<object>	ルールのソースの詳細。
	object	なし。
MessageType	string	ルールのトリガーメカニズム。有効な値: ConfigurationItemChangeNotification: 構成変更。 ScheduledNotification: 定期実行。	ConfigurationItemChangeNotification
EventSource	string	イベントソース。説明現在、Cloud Config イベントのみがサポートされています: aliyun.config。	aliyun.config
MaximumExecutionFrequency	string	ルールの実行周波数。有効な値: One_Hour: 1 時間。 Three_Hours: 3 時間。 Six_Hours: 6 時間。 Twelve_Hours: 12 時間。 TwentyFour_Hours: 24 時間。	One_Hour
Owner	string	ルールソースのオーナー。有効な値: CUSTOM_FC: カスタムルール。 ALIYUN: ルールテンプレート。	ALIYUN
Identifier	string	ルール識別子。ルールがルールテンプレートに基づいている場合、このパラメーターはルールテンプレート識別子を指定します。ルールがカスタムルールである場合、このパラメーターは関数の ARN を指定します。	acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
ConfigRuleState	string	ルールの実行中ステータス。有効な値: ACTIVE: アクティブな。 DELETING: 削除中。 EVALUATING: 評価中。 INACTIVE: 無効。	ACTIVE
MaximumExecutionFrequency	string	ルールの実行周波数。有効な値: One_Hour: 1 時間。 Three_Hours: 3 時間。 Six_Hours: 6 時間。 Twelve_Hours: 12 時間。 TwentyFour_Hours: 24 時間。	One_Hour
ManagedRule	object	ルールテンプレートの詳細。
SourceDetails	array<object>	ルールテンプレートのソースの詳細。
	object	ルールのソースの詳細。
MessageType	string	ルールのトリガーメカニズム。有効な値: ConfigurationItemChangeNotification: 構成変更。 ScheduledNotification: 定期実行。	ConfigurationItemChangeNotification
EventSource	string	イベントソース。説明現在、Cloud Config イベントのみがサポートされています: aliyun.config。	aliyun.config
MaximumExecutionFrequency	string	ルールの実行周波数。有効な値: One_Hour: 1 時間。 Three_Hours: 3 時間。 Six_Hours: 6 時間。 Twelve_Hours: 12 時間。 TwentyFour_Hours: 24 時間。	One_Hour
Description	string	ルールテンプレートの説明。	支払い遅延またはセキュリティ上の理由でロックされていない ECS ディスクは「準拠」とみなされます
Labels	array	ルールテンプレートのタグリスト。
	string	ルールテンプレートのタグ。	["RAM","USer"]
Identifier	string	ルールテンプレートの識別子。	ram-user-mfa-check
OptionalInputParameterDetails	object	ルールテンプレートの任意のパラメーターの詳細。	{}
ManagedRuleName	string	ルールテンプレートの名前。	RAM ユーザーの MFA が有効
CompulsoryInputParameterDetails	object	ルールテンプレートの必須パラメーターの詳細。	{}
ConfigRuleArn	string	ルールテンプレートの ARN。	acs:config::100931896542**:rule/cr-7f7d626622af0041**
Description	string	ルールテンプレートの説明。	RAM ユーザーの MFA が有効な場合、リソースは「準拠」とみなされます
CreateBy	object	ルール作成者の情報。
CompliancePackId	string	コンプライアンスパッケージの ID。	cp-541e626622af008****
AggregatorName	string	アカウントグループ名。	Test_Group
CompliancePackName	string	コンプライアンスパッケージ名。	OSS コンプライアンスベースライン
CreatorName	string	ルール作成者の名前。	Alice
CreatorType	string	ルール作成者のタイプ。`AGGREGATOR` (アカウントグループ) のみがサポートされています。	AGGREGATOR
CreatorId	string	ルール作成者のアカウント ID。	100931896542****
AggregatorId	string	アカウントグループの ID。	ca-04b3fd170e340007****
ConfigRuleName	string	ルール名。	RAM ユーザーの MFA が有効
ConfigRuleEvaluationStatus	object	ルールの実行ステータス。
LastErrorCode	string	直近のルール実行時のエラーコード。	TimeOut
LastSuccessfulEvaluationTimestamp	integer	直近の成功したルール呼び出しの終了タイムスタンプ。単位: ミリ秒時間。	1624932227486
FirstActivatedTimestamp	integer	ルールが最初に有効化されたタイムスタンプ。この値はミリ秒単位の UNIX タイムスタンプ時間です。	1624932221993
FirstEvaluationStarted	boolean	ルールが評価されたかどうかを示します。有効な値: true: ルールは評価済みです。 false: ルールは未評価です。	true
LastSuccessfulInvocationTimestamp	integer	直近の成功したルール呼び出しの開始タイムスタンプ。単位: ミリ秒時間。	1624932227476
LastErrorMessage	string	直近のルール実行時のエラーメッセージ。	時間切れ
LastFailedEvaluationTimestamp	integer	直近の失敗したルール呼び出しの終了タイムスタンプ。単位: ミリ秒時間。	1614687022000
LastFailedInvocationTimestamp	integer	直近の失敗したルール呼び出しの開始タイムスタンプ。単位: ミリ秒時間。	1614687022000
ConfigRuleId	string	ルールの ID。	cr-7f7d626622af0041****
ModifiedTimestamp	integer	ルールが最後に更新されたタイムスタンプ。単位: ミリ秒時間。	1614687022000
CreateTimestamp	integer	ルールが作成されたタイムスタンプ。単位: ミリ秒時間。	1604684022000
ResourceTypesScope	string	ルールによって評価されるリソースタイプ。	ACS::RAM::User
ExcludeRegionIdsScope	string	ルール評価から除外されるリージョン ID。ルールは指定されたリージョンのリソースを評価しません。複数のリージョン ID はカンマ (,) で区切ります。	cn-hangzhou
RegionIdsScope	string	ルールが評価するリソースのリージョン ID。	global
ExcludeResourceIdsScope	string	ルール評価から除外されるリソース ID。	23642660635687****
ResourceIdsScope	string	ルールが適用されるリソース ID。複数のリソース ID はカンマ (,) で区切ります。	eip-8vbf3x310fn56ijfd****
ResourceGroupIdsScope	string	ルールが評価するリソースのリソースグループ ID。	rg-aekzdibsjjc****
ExcludeResourceGroupIdsScope	string	ルール評価から除外されるリソースグループ ID。ルールは指定されたリソースグループ内のリソースを評価しません。複数のリソースグループ ID はカンマ (,) で区切ります。	rg-aekzdibsjjc****
TagKeyScope `deprecated`	string	[非推奨] 代わりに `TagsScope` フィールドを使用してください。ルールが評価するリソースのタグキー。	RAM
TagValueScope `deprecated`	string	[非推奨] 代わりに `TagsScope` フィールドを使用してください。ルールが評価するリソースのタグ値。	MFA
TagsScope	array<object>	タグの範囲。
	object
TagKey	string	タグキー。	key-1
TagValue	string	タグ値。	値-1
ExcludeTagsScope	array<object>	除外されるタグの範囲。
	object
TagKey	string	タグキー。	key-2
TagValue	string	タグ値。	値-2
ConfigRuleTriggerTypes	string	ルールのトリガーメカニズム。有効な値: ConfigurationItemChangeNotification: 構成変更。 ScheduledNotification: 定期実行。	ConfigurationItemChangeNotification
TagKeyLogicScope	string	このフィールドは、`TagsScope` パラメーターを使用して作成されたルールでは返されません。このフィールドは、非推奨の `TagKeyScope` フィールドを使用して作成されたルールを取得するために使用されます (推奨されません)。たとえば、`TagKeyScope` パラメーターが `ECS,OSS` に設定され、このパラメーターが `AND` に設定されている場合、ルールは `ECS` タグと `OSS` タグの両方にバインドされているリソースにのみ適用されます。有効な値: AND: 論理積。 OR: 論理和。	AND
FolderIdsScope	string	リソースディレクトリのフォルダ ID。ルールは、指定されたフォルダ配下のメンバーアカウント内のリソースにのみ適用されます。	fd-ZtHsRH****
ExcludeFolderIdsScope	string	ルール評価から除外されるリソースディレクトリのフォルダ ID。ルールは、指定されたフォルダ配下のメンバーアカウント内のリソースを評価しません。	fd-pWmkqZ****
ExcludeAccountIdsScope	string	ルール評価から除外されるメンバーアカウント。ルールは、指定されたアカウント内のリソースに対して評価を実行しません。	120886317861****
ResourceNameScope	string	ルールが適用されるリソース名。	i-xxx
Compliance	object	ルールのコンプライアンス統計。
ComplianceType	string	コンプライアンス結果。有効な値: COMPLIANT: 準拠。 NON_COMPLIANT: 非準拠。 NOT_APPLICABLE: 該当なし。 INSUFFICIENT_DATA: データ不足。	NON_COMPLIANT
Count	integer	コンプライアンス結果に対応する評価済みリソースのリソース数。	3
AccountId	integer	ルールが属する Alibaba Cloud アカウントの ID。	120886317861****
ExtendContent	string	拡張コンテンツ。現在、このパラメーターは 24 時間の定期トリガーのトリガー時間を設定するためにのみ使用されます。	{"fixedHour":"12"}
Tags	array<object>	リソースタグ。
	object	リソースタグ。
TagKey	string	タグキー。	key-1
TagValue	string	タグ値。	値-1
AccountIdsScope	string	ルールが適用されるメンバーアカウントの ID。ルールは、指定されたメンバーアカウント内のリソースに対してのみ効果があります。複数のメンバーアカウント ID はカンマ (,) で区切ります。	120886317861****

例

成功レスポンス

JSONJSON

{
  "RequestId": "811234F4-C3AB-4D15-B90B-F55016D1B5AA",
  "ConfigRule": {
    "RiskLevel": 1,
    "InputParameters": {
      "tag1Key": "ECS",
      "tag1Value": "test"
    },
    "Source": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Owner": "ALIYUN",
      "Identifier": "acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config"
    },
    "ConfigRuleState": "ACTIVE",
    "MaximumExecutionFrequency": "One_Hour",
    "ManagedRule": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Description": "ECS磁盘未因欠费或安全等原因而被锁定，视为“合规”。",
      "Labels": [
        "[\"RAM\",\"USer\"]"
      ],
      "Identifier": "ram-user-mfa-check",
      "OptionalInputParameterDetails": {},
      "ManagedRuleName": "RAM用户开启MFA",
      "CompulsoryInputParameterDetails": {}
    },
    "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "Description": "RAM用户开启MFA，视为“合规”。",
    "CreateBy": {
      "CompliancePackId": "cp-541e626622af008****",
      "AggregatorName": "Test_Group",
      "CompliancePackName": "OSS合规基线",
      "CreatorName": "Alice",
      "CreatorType": "AGGREGATOR",
      "CreatorId": "100931896542****",
      "AggregatorId": "ca-04b3fd170e340007****"
    },
    "ConfigRuleName": "RAM用户开启MFA",
    "ConfigRuleEvaluationStatus": {
      "LastErrorCode": "TimeOut",
      "LastSuccessfulEvaluationTimestamp": 1624932227486,
      "FirstActivatedTimestamp": 1624932221993,
      "FirstEvaluationStarted": true,
      "LastSuccessfulInvocationTimestamp": 1624932227476,
      "LastErrorMessage": "time out",
      "LastFailedEvaluationTimestamp": 1614687022000,
      "LastFailedInvocationTimestamp": 1614687022000
    },
    "ConfigRuleId": "cr-7f7d626622af0041****",
    "ModifiedTimestamp": 1614687022000,
    "CreateTimestamp": 1604684022000,
    "ResourceTypesScope": "ACS::RAM::User",
    "ExcludeRegionIdsScope": "cn-hangzhou",
    "RegionIdsScope": "global",
    "ExcludeResourceIdsScope": "23642660635687****",
    "ResourceIdsScope": "eip-8vbf3x310fn56ijfd****\n",
    "ResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "ExcludeResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "TagKeyScope": "RAM",
    "TagValueScope": "MFA",
    "TagsScope": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "ExcludeTagsScope": [
      {
        "TagKey": "key-2",
        "TagValue": "value-2"
      }
    ],
    "ConfigRuleTriggerTypes": "ConfigurationItemChangeNotification",
    "TagKeyLogicScope": "AND",
    "FolderIdsScope": "fd-ZtHsRH****",
    "ExcludeFolderIdsScope": "fd-pWmkqZ****",
    "ExcludeAccountIdsScope": "120886317861****",
    "ResourceNameScope": "i-xxx",
    "Compliance": {
      "ComplianceType": "NON_COMPLIANT",
      "Count": 3
    },
    "AccountId": 0,
    "ExtendContent": "{\"fixedHour\":\"12\"}",
    "Tags": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "AccountIdsScope": "120886317861****\n"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConfigRuleNotExists	The ConfigRule does not exist.
400	NoPermission	You are not authorized to perform this operation.
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.

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

変更履歴

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