DescribeConfigRule - 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:DescribeConfigRule

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ConfigRuleId	string	必須	ルールの ID。 ListConfigRules 操作を呼び出して、ルール ID を取得できます。	cr-7bc06457e0d90041****
MultiAccount	boolean	任意	このパラメーターは、2021 年 6 月 30 日 00:00:00 以降は利用できません。アカウントグループ関連の操作は、2021 年 5 月 30 日 00:00:00 以降に代替として提供されます。このパラメーターを使用している場合は、2021 年 5 月 30 日 00:00:00 以降にアカウントグループ関連の操作に切り替えることを推奨します。アカウントグループの詳細については、「概要」をご参照ください。	false
MemberId	integer	任意	このパラメーターは、2021 年 6 月 30 日 00:00:00 以降は利用できません。アカウントグループ関連の操作は、2021 年 5 月 30 日 00:00:00 以降に代替として提供されます。このパラメーターを使用している場合は、2021 年 5 月 30 日 00:00:00 以降にアカウントグループ関連の操作に切り替えることを推奨します。アカウントグループの詳細については、「概要」をご参照ください。	123456789

レスポンスフィールド

フィールド	型	説明	例
	object
ConfigRule	object	ルールの詳細。
ConfigRuleArn	string	ルールの Alibaba Cloud リソースネーム (ARN)。	acs:config::120886317861**:rule/cr-7bc06457e0d90041**
ConfigRuleEvaluationStatus	object	ルールによって実行されたコンプライアンス評価に関する情報。
FirstActivatedTimestamp	integer	ルールが最初にトリガーされたときのタイムスタンプ。	1618901952341
FirstEvaluationStarted	boolean	リソースがルールに基づいて評価されたかどうかを示します。有効な値： true false	true
LastErrorCode	string	最後に失敗したコンプライアンス評価で返されたエラーコード。	FunctionNotFound
LastErrorMessage	string	最後に失敗したコンプライアンス評価で返されたエラーメッセージ。	function 'funtionName' does not exist in service 'serviceName'
LastFailedEvaluationTimestamp	integer	ルールの最後に失敗したコンプライアンス評価が終了したときのタイムスタンプ。	1602819143913
LastFailedInvocationTimestamp	integer	ルールの最後に失敗したコンプライアンス評価が開始されたときのタイムスタンプ。	1602819143910
LastSuccessfulEvaluationTimestamp	integer	ルールの最後に成功したコンプライアンス評価が終了したときのタイムスタンプ。	1618901957876
LastSuccessfulInvocationTimestamp	integer	ルールの最後に成功したコンプライアンス評価が開始されたときのタイムスタンプ。	1618901957395
ConfigRuleId	string	ルールの ID。	cr-7bc06457e0d90041****
ConfigRuleName	string	評価ルールの名前。	governance-guardrail-rds-public-access-check
ConfigRuleState	string	ルールのステータス。有効な値： ACTIVE：ルールは有効です。 EVALUATING：ルールがトリガーされ、リソース設定の監視に使用されています。 INACTIVE：ルールは無効化されました。	ACTIVE
CreateTimestamp	integer	ルールが作成されたときのタイムスタンプ。	1602818964884
Description	string	ルールの説明。	The number of CPU cores of the RDS instance is greater than or equal to the set threshold, which is considered as compliance.
InputParameters	object	ルールの入力パラメーター。	{"cpuCount": "2" }
ManagedRule	object	マネージドルールの詳細。
CompulsoryInputParameterDetails	object	マネージドルールに必要な入力パラメーターの設定。	{"cpuCount": {"defaultValue": "2","type": "integer"}
Description	string	マネージドルールの説明。	The number of CPU cores of the RDS instance is greater than or equal to the set threshold, which is considered as compliance.
Identifier	string	マネージドルールの識別子。	rds-cpu-min-count-limit
Labels	array	ラベル。
	string	マネージドルールのラベル。	["RDS","CPU"]
ManagedRuleName	string	マネージドルールの名前。	rds-cpu-min-count-limit
OptionalInputParameterDetails	object	マネージドルールのオプションの入力パラメーターの設定。	{"tag1Value":{"type":"string","defaultValue":""},"tag2Key":{"type":"string","defaultValue":""}}
SourceDetails	array<object>	ルールがトリガーされる間隔。有効な値： One_Hour：1 時間 Three_Hours：3 時間 Six_Hours：6 時間 Twelve_Hours：12 時間 TwentyFour_Hours：24 時間
	object
EventSource	string	マネージドルールのイベントソース。説明 Cloud Config に関連するイベントのみがサポートされます。値は aliyun.config に固定されます。	aliyun.config
MaximumExecutionFrequency	string	マネージドルールがトリガーされる間隔。有効な値： One_Hour：1 時間。 Three_Hours：3 時間。 Six_Hours：6 時間。 Twelve_Hours：12 時間。 TwentyFour_Hours：24 時間。	Six_Hours
MessageType	string	マネージドルールのトリガータイプ。有効な値： ConfigurationItemChangeNotification：マネージドルールは設定変更によってトリガーされます。 ScheduledNotification：マネージドルールはスケジュールに従ってトリガーされます。	ConfigurationItemChangeNotification
MaximumExecutionFrequency	string	ルールがトリガーされる間隔。有効な値： One_Hour：1 時間 Three_Hours：3 時間 Six_Hours：6 時間 Twelve_Hours：12 時間。 TwentyFour_Hours：24 時間。	Six_Hours
ModifiedTimestamp	integer	ルールが最後に変更されたときのタイムスタンプ。	1602992721000
RiskLevel	integer	ルールに準拠していないリソースのリスクレベル。有効な値： 1：高 2：中 3：低	3
Scope	object	ルールの監視範囲。
ComplianceResourceId	string	評価対象リソースの ID。	vpc-6weoy5flv41pj4wvr****
ComplianceResourceTypes	array	評価対象リソースのタイプ。
	string	ルールに対して評価されるリソースのタイプ。	["ACS::RDS::DBInstance"]
Source	object	ルールのトリガーに関する情報。
Identifier	string	ルールの識別子。ルールがマネージドルールに基づいて作成された場合、このパラメーターの値はマネージドルールの名前です。ルールがカスタムルールの場合、このパラメーターの値は Function Compute の関連する関数の Alibaba Cloud リソースネーム (ARN) です。	rds-cpu-min-count-limit
Owner	string	ルールの作成方法。有効な値： CUSTOM_FC：ルールはカスタムルールです。 ALIYUN：ルールは Alibaba Cloud のマネージドルールに基づいて作成されました。	ALIYUN
SourceConditions	array<object>	ルールの入力パラメーターの名前です。
	object
DesiredValue	string	入力パラメーターの期待値。	2
Name	string	ルールの入力パラメーターの名前。	cpuCount
Operator	string	入力パラメーターの実際の値と期待値を比較するために使用されるオペレーター。オペレーターは、SelectPath パラメーターで返されるデータの型によって異なります。 String データ型の有効な値： StringEquals：実際の値が期待値と等しい。 NotStringEquals：実際の値が期待値と等しくない。 StringIn：実際の値が期待値に存在する。 NotStringIn：実際の値が期待値に存在しない。 StringContains：実際の値に期待値が含まれる。 NotStringContains：実際の値に期待値が含まれない。 Number データ型の有効な値： Equals：実際の値が期待値と等しい。 NotEquals：実際の値が期待値と等しくない。 Less：実際の値が期待値より小さい。 LessOrEquals：実際の値が期待値以下である。 Greater：実際の値が期待値より大きい。 GreaterOrEquals：実際の値が期待値以上である。 Base64 エンコードされた文字列を示す Base64String データ型の有効な値： Base64Contains：実際の値に期待値が含まれる。 NotBase64Contains：実際の値に期待値が含まれない。 Base64ContainsAll：実際の値に期待値のすべての文字が含まれる。 Base64ExcludeAll：実際の値に期待値の文字が一切含まれない。 Array データ型の有効な値： Contains：実際の値に期待値が含まれる。 NotContains：実際の値に期待値が含まれない。 In：実際の値が期待値に存在する。 NotIn：実際の値が期待値に存在しない。 ContainsAll：実際の値に期待値のすべての要素が含まれる。 ExcludeAll：実際の値に期待値の要素が一切含まれない。 IsEmpty：実際の値が null である。	GreaterOrEquals
Tips	string	入力パラメーターの説明。	You are not logged in or your login token has expired.
SourceDetails	array<object>	ルールがトリガーされる間隔。有効な値は次のとおりです： One_Hour：1 時間 Three_Hours：3 時間 Six_Hours：6 時間 Twelve_Hours：12 時間 TwentyFour_Hours：24 時間
	object
EventSource	string	ルールのイベントソース。説明 Cloud Config に関連するイベントのみがサポートされます。値は aliyun.config に固定されます。	aliyun.config
MaximumExecutionFrequency	string	ルールがトリガーされる間隔。有効な値： One_Hour：1 時間。 Three_Hours：3 時間。 Six_Hours：6 時間。 Twelve_Hours：12 時間。 TwentyFour_Hours：24 時間。	Six_Hours
MessageType	string	ルールのトリガータイプ。有効な値： ConfigurationItemChangeNotification：ルールは設定変更によってトリガーされます。 ScheduledNotification：ルールはスケジュールに従ってトリガーされます。	ConfigurationItemChangeNotification
RequestId	string	リクエスト ID。	A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99

例

成功レスポンス

JSONJSON

{
  "ConfigRule": {
    "ConfigRuleArn": "acs:config::120886317861****:rule/cr-7bc06457e0d90041****",
    "ConfigRuleEvaluationStatus": {
      "FirstActivatedTimestamp": 1618901952341,
      "FirstEvaluationStarted": true,
      "LastErrorCode": "FunctionNotFound",
      "LastErrorMessage": "function 'funtionName' does not exist in service 'serviceName'",
      "LastFailedEvaluationTimestamp": 1602819143913,
      "LastFailedInvocationTimestamp": 1602819143910,
      "LastSuccessfulEvaluationTimestamp": 1618901957876,
      "LastSuccessfulInvocationTimestamp": 1618901957395
    },
    "ConfigRuleId": "cr-7bc06457e0d90041****",
    "ConfigRuleName": "governance-guardrail-rds-public-access-check",
    "ConfigRuleState": "ACTIVE",
    "CreateTimestamp": 1602818964884,
    "Description": "The number of CPU cores of the RDS instance is greater than or equal to the set threshold, which is considered as compliance.",
    "InputParameters": {
      "cpuCount": "2"
    },
    "ManagedRule": {
      "CompulsoryInputParameterDetails": {
        "test": "test",
        "test2": 1
      },
      "Description": "The number of CPU cores of the RDS instance is greater than or equal to the set threshold, which is considered as compliance.",
      "Identifier": "rds-cpu-min-count-limit",
      "Labels": [
        "[\"RDS\",\"CPU\"]"
      ],
      "ManagedRuleName": "rds-cpu-min-count-limit",
      "OptionalInputParameterDetails": {
        "tag1Value": {
          "type": "string",
          "defaultValue": ""
        },
        "tag2Key": {
          "type": "string",
          "defaultValue": ""
        }
      },
      "SourceDetails": [
        {
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "Six_Hours",
          "MessageType": "ConfigurationItemChangeNotification"
        }
      ]
    },
    "MaximumExecutionFrequency": "Six_Hours",
    "ModifiedTimestamp": 1602992721000,
    "RiskLevel": 3,
    "Scope": {
      "ComplianceResourceId": "vpc-6weoy5flv41pj4wvr****",
      "ComplianceResourceTypes": [
        "[\"ACS::RDS::DBInstance\"]"
      ]
    },
    "Source": {
      "Identifier": "rds-cpu-min-count-limit",
      "Owner": "ALIYUN",
      "SourceConditions": [
        {
          "DesiredValue": "2",
          "Name": "cpuCount",
          "Operator": "GreaterOrEquals",
          "Tips": "You are not logged in or your login token has expired."
        }
      ],
      "SourceDetails": [
        {
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "Six_Hours",
          "MessageType": "ConfigurationItemChangeNotification"
        }
      ]
    }
  },
  "RequestId": "A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	ConfigRuleNotExists	The ConfigRule does not exist.
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.

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

変更履歴

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