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

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

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
MultiAccount	boolean	任意	このパラメーターは、2021 年 6 月 30 日 00:00:00 までに削除される予定です。アカウントグループ関連の API は、2021 年 5 月 30 日 00:00:00 までに代替として提供されます。このパラメーターを使用している場合は、2021 年 5 月 30 日 00:00:00 以降にアカウントグループ関連の API に切り替えることを推奨します。詳細については、「アカウントグループ」をご参照ください。	false
MemberId	integer	任意	このパラメーターは、2021 年 6 月 30 日 00:00:00 までに削除される予定です。アカウントグループ関連の API は、2021 年 5 月 30 日 00:00:00 までに代替として提供されます。このパラメーターを使用している場合は、2021 年 5 月 30 日 00:00:00 以降にアカウントグループ関連の API に切り替えることを推奨します。詳細については、「アカウントグループ」をご参照ください。	123456789

レスポンスフィールド

フィールド	型	説明	例
	object
ComplianceSummary	object	コンプライアンス評価の概要。
ComplianceSummaryByConfigRule	object	ルールディメンションからのコンプライアンス評価の概要。
ComplianceSummaryTimestamp	integer	概要が記録されたときのタイムスタンプ。	1589853712165
CompliantCount	integer	評価結果が準拠しているルールの数。	111
NonCompliantCount	integer	評価結果が非準拠であるルールの数。	12
TotalCount	integer	ルールの総数。	123
ComplianceSummaryByResource	object	リソースディメンションからのコンプライアンス評価の概要。
ComplianceSummaryTimestamp	integer	概要が記録されたときのタイムスタンプ。	1589853712165
CompliantCount	integer	準拠と評価されたリソースの数。	1
NonCompliantCount	integer	非準拠と評価されたリソースの数。	12
TotalCount	integer	リソースの総数。	13
RequestId	string	リクエストの ID。	CAEE6F34-DEDC-4AAA-AA8C-946D5D008735

例

成功レスポンス

JSONJSON

{
  "ComplianceSummary": {
    "ComplianceSummaryByConfigRule": {
      "ComplianceSummaryTimestamp": 1589853712165,
      "CompliantCount": 111,
      "NonCompliantCount": 12,
      "TotalCount": 123
    },
    "ComplianceSummaryByResource": {
      "ComplianceSummaryTimestamp": 1589853712165,
      "CompliantCount": 1,
      "NonCompliantCount": 12,
      "TotalCount": 13
    }
  },
  "RequestId": "CAEE6F34-DEDC-4AAA-AA8C-946D5D008735"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	You are not authorized to perform this operation.
404	AccountNotExisted	Your account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

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

変更履歴

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