DescribeCompliance - Cloud Config - 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:DescribeCompliance

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceType	string	任意	リソースのタイプ。リソースに基づいてコンプライアンス評価結果を照会する場合、`ResourceType` および `ResourceId` パラメーターを指定する必要があります。	ACS::ECS::Instance
ResourceId	string	任意	リソースの ID。リソースに基づいてコンプライアンス評価結果を照会する場合、`ResourceType` および `ResourceId` パラメーターを指定する必要があります。	i-bp151g9tpto890zr****
ComplianceType	string	任意	リソースのコンプライアンス評価結果。有効な値： COMPLIANT：リソースは準拠していると評価されます。 NON_COMPLIANT：リソースは非準拠であると評価されます。 NOT_APPLICABLE：ルールはリソースに適用されません。 INSUFFICIENT_DATA：リソースデータが不十分です。	COMPLIANT
ConfigRuleId	string	任意	ルールの ID。リソースに基づいてコンプライアンス評価結果を照会する場合、`ConfigRuleId`、`ResourceType`、および `ResourceId` パラメーターを指定する必要があります。それ以外の場合、`ConfigRuleId` パラメーターは無効になります。	cr-12b398b633820012****
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 に切り替えることを推奨します。詳細については、「アカウントグループ」をご参照ください。	1234567

レスポンスフィールド

フィールド	型	説明	例
	object
ComplianceResult	object	コンプライアンス評価の統計。
Compliances	array<object>	コンプライアンスタイプに基づいたコンプライアンス評価結果。
	object
ComplianceType	string	リソースのコンプライアンス評価結果。有効な値： COMPLIANT：リソースは準拠していると評価されます。 NON_COMPLIANT：リソースは非準拠であると評価されます。 NOT_APPLICABLE：ルールはリソースに適用されません。 INSUFFICIENT_DATA：リソースデータが不十分です。	COMPLIANT
Count	integer	対応する結果を持つコンプライアンス評価の数。リクエストで `ResourceId` パラメーターを設定した場合、このパラメーターは評価されたリソースの合計数を返します。リクエストで `ConfigRuleId` パラメーターを設定した場合、このパラメーターはトリガーされたルールの合計数を返します。	13
TotalCount	integer	コンプライアンス評価の合計数。リクエストで `ResourceId` パラメーターを設定した場合、このパラメーターは評価されたリソースの合計数を返します。リクエストで `ConfigRuleId` パラメーターを設定した場合、このパラメーターはトリガーされたルールの合計数を返します。	13
RequestId	string	リクエストの ID。	17306AB1-34E0-468F-BD7B-68D8AEAB754F

例

成功レスポンス

JSONJSON

{
  "ComplianceResult": {
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 13
      }
    ],
    "TotalCount": 13
  },
  "RequestId": "17306AB1-34E0-468F-BD7B-68D8AEAB754F"
}

エラーコード

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

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

変更履歴

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