すべてのプロダクト
Search
ドキュメントセンター

:GetConfigRule

最終更新日:Nov 26, 2025

指定されたルールの詳細を照会します。

操作説明

このトピックでは、ルール cr-7f7d626622af0041**** の詳細を照会する方法の例を示します。

今すぐお試しください

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

get

*Rule

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

ConfigRuleId

string

必須

ルール ID。

詳細については、「ListConfigRules」をご参照ください。

cr-7f7d626622af0041****

Tag deprecated

array<object>

任意

リソースのタグ。このパラメーターは非推奨であり、効果はありません。

リソースには最大 20 個のタグを追加できます。

object

任意

リソースのタグ。

Key

string

任意

リソースのタグキー。

リソースには最大 20 個のタグキーを追加できます。

key-1

Value

string

任意

リソースのタグ値。

リソースには最大 20 個のタグ値を追加できます。

value-1

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

レスポンスフィールド

フィールド

説明

object

ConfigRule

object

ルールの詳細。

AccountId

integer

ルールが属する Alibaba Cloud アカウントの ID。

120886317861****

Compliance

object

ルールのコンプライアンス統計。

ComplianceType

string

コンプライアンス評価結果。有効な値:

  • COMPLIANT:リソースは準拠しています。

  • NON_COMPLIANT:リソースは非準拠です。

  • NOT_APPLICABLE:ルールはリソースに適用されません。

  • INSUFFICIENT_DATA:利用可能なデータがありません。

NON_COMPLIANT

Count

integer

コンプライアンス結果に基づいて評価されるリソースの数。

3

ConfigRuleArn

string

ルールの Alibaba Cloud リソースネーム (ARN)。

acs:config::100931896542****:rule/cr-7f7d626622af0041****

ConfigRuleEvaluationStatus

object

ルールの実行ステータス。

FirstActivatedTimestamp

integer

ルールが最初にアクティブ化されたときのタイムスタンプ。単位:ミリ秒。

1624932221993

FirstEvaluationStarted

boolean

ルールが評価されたかどうかを示します。有効な値:

  • true:ルールは評価済みです。

  • false:ルールは評価されていません。

true

LastErrorCode

string

ルールの最後の失敗した実行に対して返されたエラーコード。

TimeOut

LastErrorMessage

string

ルールの最後の失敗した実行に対して返されたエラーメッセージ。

Time out

LastFailedEvaluationTimestamp

integer

ルールの最後の失敗した評価が終了したときのタイムスタンプ。単位:ミリ秒。

1614687022000

LastFailedInvocationTimestamp

integer

ルールの最後の失敗した呼び出しが開始されたときのタイムスタンプ。単位:ミリ秒。

1614687022000

LastSuccessfulEvaluationTimestamp

integer

ルールの最後の成功した評価が終了したときのタイムスタンプ。単位:ミリ秒。

1624932227486

LastSuccessfulInvocationTimestamp

integer

ルールの最後の成功した呼び出しが開始されたときのタイムスタンプ。単位:ミリ秒。

1624932227476

ConfigRuleId

string

ルール ID。

cr-7f7d626622af0041****

ConfigRuleName

string

ルール名。

RAM用户开启MFA

ConfigRuleState

string

ルールのステータス。有効な値:

  • ACTIVE:ルールは有効です。

  • DELETING:ルールは削除中です。

  • EVALUATING:ルールはリソース構成の評価に使用されています。

  • INACTIVE:ルールは無効です。

ACTIVE

ConfigRuleTriggerTypes

string

ルールのトリガータイプ。有効な値:

  • ConfigurationItemChangeNotification:ルールは設定変更によってトリガーされます。

  • ScheduledNotification:ルールは定期的にトリガーされます。

ConfigurationItemChangeNotification

CreateBy

object

ルールの作成者に関する情報。

CompliancePackId

string

コンプライアンスパッケージの ID。

cp-541e626622af008****

CompliancePackName

string

コンプライアンスパッケージの名前。

OSS合规基线

CreatorId

string

ルールの作成に使用された Alibaba Cloud アカウントの ID。

100931896542****

CreatorName

string

作成者の名前。

Alice

CreateTimestamp

integer

ルールが作成されたときのタイムスタンプ。単位:ミリ秒。

1604684022000

Description

string

ルールの説明。

RAM用户开启MFA,视为“合规”。

ExcludeRegionIdsScope

string

ルールが適用されないリージョンの ID。ルールはこれらのリージョン内のリソースを評価しません。複数のリージョン ID はコンマ (,) で区切ります。

cn-hangzhou

ExcludeResourceGroupIdsScope

string

ルールが適用されないリソースグループの ID。ルールはこれらのリソースグループ内のリソースを評価しません。複数のリソースグループ ID はコンマ (,) で区切ります。

rg-aekzdibsjjc****

ExcludeResourceIdsScope

string

ルールによって評価されないリソースの ID。複数のリソース ID はコンマ (,) で区切ります。

23642660635687****

ExcludeTagsScope

array<object>

ルールによって評価されないリソースのタグ。

object

ルールによって評価されないリソースのタグ。

TagKey

string

タグキー。

key-2

TagValue

string

タグ値。

value-2

InputParameters

object

ルールの入力パラメーター。

ManagedRule

object

マネージドルールの詳細。

CompulsoryInputParameterDetails

object

マネージドルールの必須入力パラメーターの詳細。

{}

Description

string

マネージドルールの説明。

ECS磁盘未因欠费或安全等原因而被锁定,视为“合规”。

Identifier

string

マネージドルールの識別子。

ram-user-mfa-check

Labels

array

ルールラベルのリスト。

string

マネージドルールのラベル。

["RAM","User"]

ManagedRuleName

string

マネージドルールの名前。

RAM用户开启MFA

OptionalInputParameterDetails

object

マネージドルールのオプションの入力パラメーターの詳細。

{}

SourceDetails

array<object>

マネージドルールのソース詳細。

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 時間。

説明

このパラメーターは、ルールが定期的にトリガーされる場合にのみ返されます。

One_Hour

MessageType

string

ルールのトリガータイプ。有効な値:

  • ConfigurationItemChangeNotification:ルールは設定変更によってトリガーされます。

  • ScheduledNotification:ルールは定期的にトリガーされます。

ConfigurationItemChangeNotification

MaximumExecutionFrequency

string

ルールの実行頻度。有効な値:

  • One_Hour:1 時間。

  • Three_Hours:3 時間。

  • Six_Hours:6 時間。

  • Twelve_Hours:12 時間。

  • TwentyFour_Hours:24 時間。

説明

このパラメーターは、ルールが定期的にトリガーされる場合にのみ返されます。

One_Hour

ModifiedTimestamp

integer

ルールが最後に更新されたときのタイムスタンプ。単位:ミリ秒。

1614687022000

RegionIdsScope

string

ルールが適用されるリージョンの ID。ルールはこれらのリージョン内のリソースのみを評価します。

global

ResourceGroupIdsScope

string

ルールが適用されるリソースグループの ID。ルールはこれらのリソースグループ内のリソースのみを評価します。

rg-aekzdibsjjc****

ResourceIdsScope

string

ルールによって評価されるリソースの ID。複数のリソース ID はコンマ (,) で区切ります。

eip-8vbf3x310fn56ijfd****

ResourceTypesScope

string

ルールによって評価されるリソースのタイプ。

ACS::RAM::User

RiskLevel

integer

ルールのリスクレベル。有効な値:

  • 1:高

  • 2:中

  • 3:低

1

Scope

object

ルールの有効範囲。

ComplianceResourceTypes

array

ルールによって評価されるリソースタイプのリスト。この情報は ResourceTypesScope フィールドでも確認できます。

string

ルールによって評価されるリソースのタイプ。

ACS::RAM::User

Source

object

ルールのソース。

Identifier

string

ルールの識別子。

  • ルールがマネージドルールの場合、このパラメーターの値はマネージドルールの識別子です。

  • ルールがカスタムルールの場合、このパラメーターの値は関数の ARN です。

acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config

Owner

string

ルールのオーナー。有効な値:

  • CUSTOM_FC:カスタムルール。

  • ALIYUN:マネージドルール。

ALIYUN

SourceDetails

array<object>

ソースの詳細。

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 時間。

説明

このパラメーターは、ルールが定期的にトリガーされる場合にのみ返されます。

One_Hour

MessageType

string

ルールのトリガータイプ。有効な値:

  • ConfigurationItemChangeNotification:ルールは設定変更によってトリガーされます。

  • ScheduledNotification:ルールは定期的にトリガーされます。

ConfigurationItemChangeNotification

TagKeyLogicScope

string

このパラメーターは、TagsScope パラメーターを使用して作成されたルールには返されません。

このパラメーターは、非推奨の TagKeyScope パラメーターを使用して作成されたルールに対して返されます。TagKeyScope パラメーターの使用は推奨されません。たとえば、TagKeyScopeECS,OSS に設定され、このパラメーターが AND に設定されている場合、ルールは ECSOSS の両方のタグを持つリソースにのみ適用されます。

有効な値:

  • AND

  • OR

OR

TagKeyScope deprecated

string

このパラメーターは非推奨です。代わりに TagsScope パラメーターを使用してください。

ルールは、指定されたタグを持つリソースにのみ適用されます。

説明

TagKeyScopeTagValueScope パラメーターは同時に返されます。

RAM

TagValueScope deprecated

string

このパラメーターは非推奨です。代わりに TagsScope パラメーターを使用してください。

ルールは、指定されたタグを持つリソースにのみ適用されます。

説明

TagKeyScopeTagValueScope パラメーターは同時に返されます。

MFA

TagsScope

array<object>

タグベースの範囲。

object

範囲を定義するタグ。

TagKey

string

タグキー。

key-1

TagValue

string

タグ値。

value-1

Tags

array<object>

リソースのタグ。

object

リソースのタグ。

TagKey

string

タグキー。

key-1

TagValue

string

タグ値。

value-1

ResourceNameScope

string

ルールは、指定された名前を持つリソースのみを評価します。

i-xxx

ExtendContent

string

拡張コンテンツ。このパラメーターは、24 時間周期でトリガーされるルールのトリガー時間を指定するためにのみ使用されます。

{"fixedHour":"12"}

RequestId

string

リクエスト ID。

811234F4-C3AB-4D15-B90B-F55016D1B5AA

成功レスポンス

JSONJSON

{
  "ConfigRule": {
    "AccountId": 0,
    "Compliance": {
      "ComplianceType": "NON_COMPLIANT",
      "Count": 3
    },
    "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "ConfigRuleEvaluationStatus": {
      "FirstActivatedTimestamp": 1624932221993,
      "FirstEvaluationStarted": true,
      "LastErrorCode": "TimeOut",
      "LastErrorMessage": "Time out",
      "LastFailedEvaluationTimestamp": 1614687022000,
      "LastFailedInvocationTimestamp": 1614687022000,
      "LastSuccessfulEvaluationTimestamp": 1624932227486,
      "LastSuccessfulInvocationTimestamp": 1624932227476
    },
    "ConfigRuleId": "cr-7f7d626622af0041****",
    "ConfigRuleName": "RAM用户开启MFA",
    "ConfigRuleState": "ACTIVE",
    "ConfigRuleTriggerTypes": "ConfigurationItemChangeNotification",
    "CreateBy": {
      "CompliancePackId": "cp-541e626622af008****",
      "CompliancePackName": "OSS合规基线",
      "CreatorId": "100931896542****",
      "CreatorName": "Alice"
    },
    "CreateTimestamp": 1604684022000,
    "Description": "RAM用户开启MFA,视为“合规”。",
    "ExcludeRegionIdsScope": "cn-hangzhou",
    "ExcludeResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "ExcludeResourceIdsScope": "23642660635687****",
    "ExcludeTagsScope": [
      {
        "TagKey": "key-2",
        "TagValue": "value-2"
      }
    ],
    "InputParameters": {
      "test": "test",
      "test2": 1
    },
    "ManagedRule": {
      "CompulsoryInputParameterDetails": {},
      "Description": "ECS磁盘未因欠费或安全等原因而被锁定,视为“合规”。",
      "Identifier": "ram-user-mfa-check",
      "Labels": [
        "[\"RAM\",\"User\"]"
      ],
      "ManagedRuleName": "RAM用户开启MFA",
      "OptionalInputParameterDetails": {},
      "SourceDetails": [
        {
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour",
          "MessageType": "ConfigurationItemChangeNotification"
        }
      ]
    },
    "MaximumExecutionFrequency": "One_Hour",
    "ModifiedTimestamp": 1614687022000,
    "RegionIdsScope": "global",
    "ResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "ResourceIdsScope": "eip-8vbf3x310fn56ijfd****\n",
    "ResourceTypesScope": "ACS::RAM::User",
    "RiskLevel": 1,
    "Scope": {
      "ComplianceResourceTypes": [
        "ACS::RAM::User"
      ]
    },
    "Source": {
      "Identifier": "acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config",
      "Owner": "ALIYUN",
      "SourceDetails": [
        {
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour",
          "MessageType": "ConfigurationItemChangeNotification"
        }
      ]
    },
    "TagKeyLogicScope": "OR",
    "TagKeyScope": "RAM",
    "TagValueScope": "MFA",
    "TagsScope": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "Tags": [
      {
        "TagKey": "key-1",
        "TagValue": "value-1"
      }
    ],
    "ResourceNameScope": "i-xxx",
    "ExtendContent": "{\"fixedHour\":\"12\"}"
  },
  "RequestId": "811234F4-C3AB-4D15-B90B-F55016D1B5AA"
}

エラーコード

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.

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

変更履歴

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