GetAggregateConfigRuleComplianceByPack を使用してコンプライアンスパックのコンプライアンス結果をクエリする - Cloud Config

指定されたアカウントグループ内の指定されたコンプライアンスパック内のルールのコンプライアンス結果をクエリします。

操作説明

このトピックでは、アカウントグループ ca-04b3fd170e340007**** のコンプライアンスパック cp-541e626622af0087**** 内のルールのコンプライアンス結果をクエリする方法の例を示します。応答では、合計 1 個のルールと 0 個の非準拠ルールが返されます。

今すぐお試しください

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

get

*AggregateCompliancePack

acs:config:*:{#accountId}:aggregatecompliancepack/{#AggregatorCompliancePackId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
CompliancePackId	string	必須	コンプライアンスパックの ID。コンプライアンスパックの ID の取得方法の詳細については、「ListAggregateCompliancePacks」をご参照ください。	cp-541e626622af0087****
AggregatorId	string	必須	アカウントグループの ID。アカウントグループの ID の取得方法の詳細については、「ListAggregators」をご参照ください。	ca-04b3fd170e340007****

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

レスポンスフィールド

フィールド	型	説明	例
	object	データは返されません。
RequestId	string	リクエスト ID。	C6B0C0A8-3245-48F1-AEAB-BC1A446E99D0
ConfigRuleComplianceResult	object	コンプライアンスパック内のルールのコンプライアンス結果。
CompliancePackId	string	コンプライアンスパックの ID。	cp-541e626622af0087****
NotApplicableCount	integer	評価結果に Not Applicable が含まれるルールの総数。	1
ConfigRuleCompliances	array<object>	ルールコンプライアンス結果のリスト。
	object	説明はありません。
ComplianceType	string	コンプライアンス結果。有効な値: COMPLIANT: ルールは準拠しています。 NON_COMPLIANT: ルールは非準拠です。 NOT_APPLICABLE: ルールは適用されません。 INSUFFICIENT_DATA: 利用可能なデータがありません。	COMPLIANT
ConfigRuleName	string	コンプライアンスパック内のルールの名前。	The bandwidth of the Elastic IP instance meets the minimum requirements.
ConfigRuleId	string	コンプライアンスパック内のルールの ID。	cr-fdc8626622af00f9****
TotalCount	integer	ルールの総数。	2
NonCompliantCount	integer	非準拠ルールの数。	1
CompliantCount	integer	すべての評価結果が Compliant であるルールの総数。	0
InsufficientDataCount	integer	評価結果に Insufficient Data が含まれるルールの総数。	1
IgnoredCount	integer	評価結果に Ignored が含まれるルールの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "C6B0C0A8-3245-48F1-AEAB-BC1A446E99D0",
  "ConfigRuleComplianceResult": {
    "CompliancePackId": "cp-541e626622af0087****",
    "NotApplicableCount": 1,
    "ConfigRuleCompliances": [
      {
        "ComplianceType": "COMPLIANT",
        "ConfigRuleName": "The bandwidth of the Elastic IP instance meets the minimum requirements.",
        "ConfigRuleId": "cr-fdc8626622af00f9****"
      }
    ],
    "TotalCount": 2,
    "NonCompliantCount": 1,
    "CompliantCount": 0,
    "InsufficientDataCount": 1,
    "IgnoredCount": 1
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.CompliancePackId.Value	The specified CompliancePackId does not exist.
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.

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

変更履歴

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