GetAggregateConfigRule - - Alibaba Cloud ドキュメントセンター

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

操作説明

このトピックでは、アカウントグループ 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。詳細については、「ListAggregateConfigRules」をご参照ください。	cr-7f7d626622af0041****
AggregatorId	string	必須	アカウントグループの ID。詳細については、「ListAggregators」をご参照ください。	ca-7f00626622af0041****
Tag `deprecated`	array<object>	任意	タグ。このパラメーターは非推奨です。このパラメーターを指定しても、値は有効になりません。
	object	任意	リソースのタグ。このパラメーターは非推奨です。このパラメーターを指定しても、値は有効になりません。最大 20 個のタグを追加できます。
Key	string	任意	リソースのタグキー。最大 20 個のタグキーを追加できます。	key-1
Value	string	任意	リソースのタグ値。最大 20 個のタグ値を追加できます。	value-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	ルールの識別子。ルールがマネージドルールの場合、このパラメーターの値はマネージドルールの識別子です。ルールがカスタムルールの場合、このパラメーターの値は関数の Alibaba Cloud リソースネーム (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	ルールが最初にアクティブ化されたときのタイムスタンプ。	1624932221993
FirstEvaluationStarted	boolean	ルールが評価されたかどうかを示します。有効な値: true: ルールは評価済みです。 false: ルールは評価されていません。	true
LastSuccessfulInvocationTimestamp	integer	最後の成功した呼び出しのタイムスタンプ。単位: ミリ秒。	1624932227476
LastErrorMessage	string	ルールの最後の失敗した実行で返されたエラーメッセージ。	time out
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 はコンマ (,) で区切ります。	cn-hangzhou
RegionIdsScope	string	このルールは、指定されたリージョン内のリソースにのみ適用されます。	global
ExcludeResourceIdsScope	string	ルールによって評価されないリソースの ID。	23642660635687****
ResourceIdsScope	string	このルールは、指定されたリソースにのみ適用されます。複数のリソース ID はコンマ (,) で区切ります。	eip-8vbf3x310fn56ijfd****
ResourceGroupIdsScope	string	このルールは、指定されたリソースグループ内のリソースにのみ適用されます。	rg-aekzdibsjjc****
ExcludeResourceGroupIdsScope	string	このルールは、指定されたリソースグループ内のリソースには適用されません。システムはこれらのリソースグループ内のリソースを評価しません。複数のリソースグループ ID はコンマ (,) で区切ります。	rg-aekzdibsjjc****
TagKeyScope `deprecated`	string	このパラメーターは非推奨です。代わりに `TagsScope` パラメーターを使用してください。このルールは、指定されたタグキーを持つリソースにのみ適用されます。	RAM
TagValueScope `deprecated`	string	このパラメーターは非推奨です。代わりに `TagsScope` パラメーターを使用してください。このルールは、指定されたタグ値を持つリソースにのみ適用されます。	MFA
TagsScope	array<object>	タグの範囲。
	object
TagKey	string	タグキー。	key-1
TagValue	string	タグ値。	value-1
ExcludeTagsScope	array<object>	タグの除外範囲。
	object
TagKey	string	タグキー。	key-2
TagValue	string	タグ値。	value-2
ConfigRuleTriggerTypes	string	ルールのトリガータイプ。有効な値: ConfigurationItemChangeNotification: 構成の変更によってルールがトリガーされます。 ScheduledNotification: ルールは定期的にトリガーされます。	ConfigurationItemChangeNotification
TagKeyLogicScope	string	このパラメーターは、`TagsScope` パラメーターを使用して作成されたルールには返されません。このパラメーターは、非推奨の `TagKeyScope` パラメーターを使用して作成されたルールに対してのみ返されます。たとえば、`TagKeyScope` が `ECS,OSS` に設定され、このパラメーターが `AND` に設定されている場合、ルールは `ECS` と `OSS` の両方のタグを持つリソースに適用されます。有効な値: AND OR	AND
FolderIdsScope	string	このルールは、リソースディレクトリの指定されたフォルダー内のメンバーアカウント内のリソースにのみ適用されます。	fd-ZtHsRH****
ExcludeFolderIdsScope	string	このルールは、リソースディレクトリの指定されたフォルダー内のメンバーアカウント内のリソースには適用されません。システムはこれらのフォルダー内のリソースを評価しません。	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	タグ値。	value-1
AccountIdsScope	string	このルールは、指定されたメンバーアカウント内のリソースにのみ適用されます。複数のメンバーアカウント 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.

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

変更履歴

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