テンプレートに基づいてルールを作成するか、Function Compute に基づいてカスタムルールを作成し、リソースのコンプライアンスを確認します。ルールの作成後、自動的に評価が実行されます。その後、Cloud Config はルールのトリガーメカニズムに基づいて評価を自動的にトリガーします。手動で評価をトリガーすることもできます。
操作説明
使用制限
アカウントごとに最大 200 個のルールを作成できます。
バックグラウンド情報
Cloud Config では、以下の方法でルールを作成できます。
-
テンプレートに基づいてルールを作成する
ルールテンプレートは、Cloud Config が Function Compute に組み込んだルール関数です。ルールテンプレートを使用すると、ルールを素早く作成できます。ルールの詳細については、「ルールの定義と実行中の原理」をご参照ください。
-
Function Compute に基づいてルールを作成する
カスタム関数ルールは、コードが Function Compute の関数にホストされているカスタムルールです。Cloud Config のプリセットルールテンプレートがコンプライアンス要件を満たさない場合は、機能コードを記述して複雑なシナリオでのコンプライアンスチェックを実行できます。カスタム関数ルールの詳細については、「カスタム関数ルールの定義と実行中の原理」をご参照ください。
操作の説明
この Topic では、ルールテンプレート「必須タグ」を使用してルールを作成する例を示します。応答は、ルールが作成され、ルール ID が cr-5772ba41209e007b**** であることを示しています。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
config:CreateConfigRule |
create |
*ルール。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
TagKeyScope
deprecated
|
string |
任意 |
[非推奨] 代わりに ルールは、指定されたタグキーを持つリソースにのみ適用されます。 説明
このパラメーターは、マネージドルールにのみ適用されます。 |
ECS |
TagValueScope
deprecated
|
string |
任意 |
[非推奨] 代わりに ルールは、指定されたタグ値を持つリソースにのみ適用されます。 説明
このパラメーターは、ルールテンプレートにのみ適用されます。 |
test |
| TagKeyLogicScope |
string |
任意 |
このパラメーターは、非推奨の 有効な値:
列挙値:
|
AND |
| TagsScope |
array<object> |
任意 |
タグの範囲。 |
|
|
object |
任意 |
|||
| TagKey |
string |
任意 |
タグキー。 |
key-1 |
| TagValue |
string |
任意 |
タグ値。 |
value-1 |
| ExcludeTagsScope |
array<object> |
任意 |
除外するタグの範囲。 |
|
|
object |
任意 |
|||
| TagKey |
string |
任意 |
タグキー。 |
key-2 |
| TagValue |
string |
任意 |
タグ値。 |
value-2 |
| Description |
string |
任意 |
ルールの説明。 |
最大 6 つのタググループを定義できます。リソースが指定されたすべてのタグを持っている場合、そのリソースは「準拠」とみなされます |
| SourceOwner |
string |
必須 |
作成するルールのタイプ。有効な値:
列挙値:
|
ALIYUN |
| MaximumExecutionFrequency |
string |
任意 |
ルールの実行周波数。有効な値:
説明
このパラメーターは、ConfigRuleTriggerTypes が ScheduledNotification に設定されている場合に必須です。 列挙値:
|
One_Hour |
| Conditions |
string |
任意 |
カスタム条件ルールの条件 (JSON フォーマット)。 |
{"ComplianceConditions":"{\"operator\":\"and\",\"children\":[{\"operator\":\"StringEquals\",\"featurePath\":\"$.Status\",\"desired\":\"1\",\"featureSource\":\"CONFIGURATION\"}]}"} |
| RegionIdsScope |
string |
任意 |
ルールは、指定されたリージョン ID のリソースにのみ適用されます。複数のリージョン ID はコンマ (,) で区切ります。 説明
このパラメーターは、ルールテンプレートにのみ適用されます。 |
cn-hangzhou |
| ExcludeRegionIdsScope |
string |
任意 |
ルールは、指定されたリージョンのリソースには適用されません。これらのリージョンのリソースは評価されません。複数のリージョン ID はコンマ (,) で区切ります。 |
cn-shanghai |
| ResourceGroupIdsScope |
string |
任意 |
ルールは、指定されたリソースグループ ID のリソースにのみ適用されます。複数のリソースグループ ID はコンマ (,) で区切ります。 説明
このパラメーターは、ルールテンプレートにのみ適用されます。 |
rg-aekzc7r7rhx**** |
| ExcludeResourceGroupIdsScope |
string |
任意 |
ルールは、指定されたリソースグループ ID のリソースには適用されません。これらのリソースグループのリソースは評価されません。複数のリソースグループ ID はコンマ (,) で区切ります。 |
rg-bnczc6r7rml**** |
| InputParameters |
object |
任意 |
ルールの入力パラメーター。 GetManagedRule 操作を呼び出すことで入力パラメーターを取得できます。必須パラメーターと任意パラメーターについては、それぞれ 入力パラメーターのフォーマットは |
{"key1":"value1","key2":"value2"} |
| ResourceIdsScope |
string |
任意 |
ルールは、指定されたリソース ID にのみ適用されます。複数のリソース ID はコンマ (,) で区切ります。 |
lb-5cmbowstbkss9ta03**** |
| ExcludeResourceIdsScope |
string |
任意 |
ルールは、指定されたリソース ID には適用されません。指定されたリソースは評価されません。複数のリソース ID はコンマ (,) で区切ります。 説明
このパラメーターは、ルールテンプレートにのみ適用されます。 |
lb-t4nbowvtbkss7t326**** |
| SourceIdentifier |
string |
必須 |
ルールテンプレートの ID。
|
required-tags |
| ConfigRuleTriggerTypes |
string |
必須 |
ルールのトリガーメカニズム。有効な値:
説明
ルールに両方のトリガーメカニズムが含まれる場合は、コンマ (,) で区切ります。 |
ConfigurationItemChangeNotification |
| ConfigRuleName |
string |
必須 |
ルールの名前。 |
required-tags |
| ClientToken |
string |
任意 |
リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。 |
1594295238-f9361358-5843-4294-8d30-b5183fac**** |
| ResourceTypesScope |
array |
必須 |
ルールによって評価されるリソースタイプ。実パラメーターのフォーマットは、コンマ区切りの文字列です(例: ACS::ECS::Instance,ACS::RDS::DBInstance)。JSON 配列や ResourceTypesScope.1 形式のインデックス付きパラメーターはサポートされていません。 |
ACS::ECS::Instance |
|
string |
任意 |
ルールによって評価されるリソースタイプ。複数のリソースタイプはコンマ (,) で区切ります。 |
ACS::ECS::Instance |
|
| RiskLevel |
integer |
必須 |
ルールのリスクレベル。有効な値:
列挙値:
|
1 |
| ExtendContent |
string |
任意 |
拡張コンテンツ。現在、このパラメーターは 24 時間の定期トリガーのトリガー時間を設定するためにのみ使用されます。 |
{"fixedHour":"13"} |
| Tag |
array<object> |
任意 |
作成されたルールのタグ。 |
|
|
object |
任意 |
リソースのタグ。 最大 20 個のタグを追加できます。 |
||
| Key |
string |
任意 |
リソースのタグキー。 最大 20 個のタグキーを指定できます。 |
key-1 |
| Value |
string |
任意 |
リソースのタグ値。 最大 20 個のタグ値を指定できます。 |
value-1 |
| ResourceNameScope |
string |
任意 |
ルールは、指定されたリソース名を持つリソースにのみ適用されます。 |
i-xxx |
共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答パラメーター。 |
||
| ConfigRuleId |
string |
ルール ID。 |
cr-5772ba41209e007b**** |
| RequestId |
string |
リクエスト ID。 |
6EC7AED1-172F-42AE-9C12-295BC2ADB751 |
例
成功レスポンス
JSONJSON
{
"ConfigRuleId": "cr-5772ba41209e007b****",
"RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ExceedMaxRuleCount | The maximum number of rules is exceeded. | |
| 400 | ConfigRuleNotExists | The ConfigRule does not exist. | |
| 400 | ConfigRuleExists | The ConfigRule already exists. | |
| 404 | AccountNotExisted | Your account does not exist. | |
| 503 | ServiceUnavailable | The request has failed due to a temporary failure of the server. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。