ListConfigRules API を使用したルールクエリ - Cloud Config

ルールのリストをクエリします。

操作説明

このトピックでは、現在のアカウントのルールリストをクエリする方法の例を示します。サンプルレスポンスは、ルールリストに 1 つのルールが含まれ、3 つのリソースが評価され、コンプライアンス結果が COMPLIANT であることを示しています。

今すぐお試しください

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

list

*Rule

acs:config:*:{#accountId}:rule/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceTypes	string	任意	ルールによって評価されるリソースタイプ。	ACS::ECS::Instance
PageSize	integer	任意	各ページで返されるエントリ数。有効な値: 1～100。デフォルト値: 10。	10
CompliancePackId	string	任意	コンプライアンスパッケージの ID。	cp-fe416457e0d90022****
ComplianceType	string	任意	ルールのコンプライアンス評価結果。有効な値: COMPLIANT: 準拠。 NON_COMPLIANT: 非準拠。 NOT_APPLICABLE: 適用外。 INSUFFICIENT_DATA: データ不足。	COMPLIANT
PageNumber	integer	任意	ページ番号。デフォルト値は 1 です。	1
Keyword	string	任意	あいまい検索のキーワード。ルール ID、ルール名、ルールの説明、またはルールテンプレート識別子によるあいまい検索をサポートします。	ecs
ConfigRuleState	string	任意	ルールの状態。有効な値: ACTIVE: ルールは有効です。 DELETING: ルールは削除中です。 EVALUATING: ルールは評価中です。 INACTIVE: ルールは無効です。	ACTIVE
ConfigRuleName	string	任意	ルール名。	The name of the rule.
RiskLevel	integer	任意	ルールのリスクレベル。有効な値: 1: 高リスク。 2: 中リスク。 3: 低リスク。	1
SortBy	string	任意	ソート方法。このパラメーターは必須ではありません。値を `CreateDate-Desc` に設定して、作成時間でルールを降順にソートします。	CreateDate-Desc
Tag	array<object>	任意	リソースのタグ。最大 20 個のタグをアタッチできます。
	object	任意	リソースのタグ。最大 20 個のタグをアタッチできます。
Key	string	任意	タグキー。	key-1
Value	string	任意	タグの値。	value-1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7
ConfigRules	object	ルールのリスト。
ConfigRuleList	array<object>	ルールの詳細。
	array<object>	ルールの詳細。
RiskLevel	integer	ルールのリスクレベル。有効な値: 1: 高リスク。 2: 中リスク。 3: 低リスク。	1
SourceOwner	string	ルールのオーナー。有効な値: CUSTOM_FC: Function Compute (FC) 関数を使用して作成されたカスタムルール。 ALIYUN: マネージドルール。	ALIYUN
AccountId	integer	ルールが属するアカウントの ID。	100931896542****
ConfigRuleState	string	ルールの状態。有効な値: ACTIVE: ルールは有効です。 DELETING: ルールは削除中です。 EVALUATING: ルールは評価中です。 INACTIVE: ルールは無効です。	ACTIVE
Compliance	object	ルールのコンプライアンス集約結果。
ComplianceType	string	コンプライアンス評価結果のまとめ。有効な値: COMPLIANT: 準拠。 NON_COMPLIANT: 非準拠。 NOT_APPLICABLE: 適用外。 INSUFFICIENT_DATA: データ不足。	COMPLIANT
Count	integer	コンプライアンスのまとめに対応する評価済みリソースの数。	2
SourceIdentifier	string	ルールの識別子。ルールがマネージドルールの場合、このパラメーターはマネージドルールの識別子を示します。ルールがカスタムルールの場合、このパラメーターは関数の Alibaba Cloud リソースネーム (ARN) を示します。	eip-bandwidth-limit
ConfigRuleArn	string	ルールの ARN。	acs:config::100931896542**:rule/cr-fdc8626622af00f9**
Description	string	ルールの説明。	The description of the rule.
CreateBy	object	ルールの作成者に関する情報。
CompliancePackId	string	コンプライアンスパッケージの ID。	cp-fdc8626622af00f9****
CompliancePackName	string	コンプライアンスパッケージの名前。	The name of the compliance package.
AutomationType	string	修復タイプ。Operation Orchestration Service (OOS) のみがサポートされています。	OOS
ConfigRuleName	string	ルール名。	The name of the rule.
ConfigRuleId	string	ルール ID。	cr-fdc8626622af00f9****
Tags	array<object>	ルールのタグ。
	object	ルールのタグ。
Key	string	ルールのタグキー。	env
Value	string	ルールのタグ値。	prod
ResourceTypesScope	string	ルールによって評価されるリソースのタイプ。複数のリソースタイプはカンマ (,) で区切られます。	ACS::EIP::EipAddress
CreateDate	string	ルールが作成された時刻。時刻は UTC + 08:00 で表示されます。	2025-09-19T15:51:00
PageSize	integer	ページごとに返されるエントリ数。	10
PageNumber	integer	ページ番号。	1
TotalCount	integer	ルールの総数。	1

例

成功レスポンス

JSONJSON

{
  "RequestId": "AC3A7E12-72E6-5CC9-A5C1-D8D8919829A7",
  "ConfigRules": {
    "ConfigRuleList": [
      {
        "RiskLevel": 1,
        "SourceOwner": "ALIYUN",
        "AccountId": 0,
        "ConfigRuleState": "ACTIVE",
        "Compliance": {
          "ComplianceType": "COMPLIANT",
          "Count": 2
        },
        "SourceIdentifier": "eip-bandwidth-limit",
        "ConfigRuleArn": "acs:config::100931896542****:rule/cr-fdc8626622af00f9****",
        "Description": "The description of the rule.",
        "CreateBy": {
          "CompliancePackId": "cp-fdc8626622af00f9****",
          "CompliancePackName": "The name of the compliance package."
        },
        "AutomationType": "OOS",
        "ConfigRuleName": "The name of the rule.",
        "ConfigRuleId": "cr-fdc8626622af00f9****",
        "Tags": [
          {
            "Key": "env",
            "Value": "prod"
          }
        ],
        "ResourceTypesScope": "ACS::EIP::EipAddress",
        "CreateDate": "2025-09-19T15:51:00"
      }
    ],
    "PageSize": 10,
    "PageNumber": 1,
    "TotalCount": 1
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NoPermission	You are not authorized to perform this operation.
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.

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

変更履歴

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