GetResourceComplianceByConfigRule API 概要 - Cloud Config

操作説明

このトピックでは、ルール cr-d369626622af008e**** を例として使用します。返された結果は、ルールによって合計 10 個のリソースが評価され、そのうち 5 個が準拠と評価されたことを示します。

今すぐお試しください

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

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ComplianceType	string	任意	コンプライアンス評価結果。有効な値： COMPLIANT：リソースが準拠と評価されたことを示します。 NON_COMPLIANT：リソースが非準拠と評価されたことを示します。 NOT_APPLICABLE：ルールがリソースに適用されないことを示します。 INSUFFICIENT_DATA：利用可能なデータがないことを示します。	COMPLIANT
ConfigRuleId	string	必須	ルール ID。	cr-d369626622af008e****

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

レスポンスフィールド

フィールド	型	説明	例
	object
ComplianceResult	object	コンプライアンス結果。
TotalCount	integer	評価されたリソースの総数。	10
Compliances	array<object>	コンプライアンスタイプに基づくコンプライアンス評価結果。
	object	N/A。
ComplianceType	string	リソースのコンプライアンス評価結果。有効な値： COMPLIANT：リソースが準拠と評価されたことを示します。 NON_COMPLIANT：リソースが非準拠と評価されたことを示します。 NOT_APPLICABLE：ルールがご利用のリソースに適用されなかったことを示します。 INSUFFICIENT_DATA：リソースデータが利用できなかったことを示します。	COMPLIANT
Count	integer	コンプライアンス評価結果を持つリソースの数。たとえば、`ComplianceType` パラメーターの値が `COMPLIANT` の場合、このパラメーターの値は準拠リソースの数を示します。	5
RequestId	string	リクエスト ID。	23306AB1-34E0-468F-BD7B-68D8AEAB753d

例

成功レスポンス

JSONJSON

{
  "ComplianceResult": {
    "TotalCount": 10,
    "Compliances": [
      {
        "ComplianceType": "COMPLIANT",
        "Count": 5
      }
    ]
  },
  "RequestId": "23306AB1-34E0-468F-BD7B-68D8AEAB753d"
}

エラーコード

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

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

変更履歴

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