GetComplianceSummary を使用してコンプライアンスサマリーをクエリ - Cloud Config

現在のアカウントのコンプライアンスの概要を照会します。

操作説明

このトピックでは、アカウントグループのリソースとルールごとのコンプライアンスの概要を照会する方法の例を示します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	CAEE6F34-DEDC-4BAA-AA8C-946D5D008737
ComplianceSummary	object	コンプライアンスの概要。
ComplianceSummaryByResource	object	リソースごとのコンプライアンスの概要。
LowRiskRuleNonCompliantResourceCount	integer	低リスクルールによって検出された非準拠リソースの数。説明注: この値は、アカウント内のリソースの総数より大きくなる場合があります。リソースは各ルールに基づいてカウントされます。たとえば、あるリソースが 2 つの低リスクルールによって非準拠と評価された場合、このパラメーターの値は 2 増加します。	2
NonCompliantCount	integer	非準拠リソースの数。	12
ComplianceSummaryTimestamp	integer	コンプライアンスの概要が生成されたときのタイムスタンプ。単位: ミリ秒。	1589853712165
TotalCount	integer	リソースの総数。	13
CompliantCount	integer	準拠リソースの数。	1
HighRiskRuleNonCompliantResourceCount	integer	高リスクルールによって検出された非準拠リソースの数。説明注: この値は、アカウント内のリソースの総数より大きくなる場合があります。リソースは各ルールに基づいてカウントされます。たとえば、あるリソースが 2 つのルールによって非準拠と評価された場合、このパラメーターの値は 2 増加します。	2
MediumRiskRuleNonCompliantResourceCount	integer	中リスクルールによって検出された非準拠リソースの数。説明注: この値は、アカウント内のリソースの総数より大きくなる場合があります。リソースは各ルールに基づいてカウントされます。たとえば、あるリソースが 2 つのルールによって非準拠と評価された場合、このパラメーターの値は 2 増加します。	6
ComplianceSummaryByConfigRule	object	ルールごとのコンプライアンスの概要。
CompliantCount	integer	準拠ルールの数。	5
NonCompliantCount	integer	非準拠ルールの数。	11
ComplianceSummaryTimestamp	integer	コンプライアンスの概要が生成されたときのタイムスタンプ。単位: ミリ秒。	1589853712165
TotalCount	integer	ルールの総数。	16

例

成功レスポンス

JSONJSON

{
  "RequestId": "CAEE6F34-DEDC-4BAA-AA8C-946D5D008737",
  "ComplianceSummary": {
    "ComplianceSummaryByResource": {
      "LowRiskRuleNonCompliantResourceCount": 2,
      "NonCompliantCount": 12,
      "ComplianceSummaryTimestamp": 1589853712165,
      "TotalCount": 13,
      "CompliantCount": 1,
      "HighRiskRuleNonCompliantResourceCount": 2,
      "MediumRiskRuleNonCompliantResourceCount": 6
    },
    "ComplianceSummaryByConfigRule": {
      "CompliantCount": 5,
      "NonCompliantCount": 11,
      "ComplianceSummaryTimestamp": 1589853712165,
      "TotalCount": 16
    }
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

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

変更履歴

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