調用EvaluatePreConfigRules執行資源合規預檢-配置審計-阿里雲

執行預檢規則對資源進行合規預檢。

介面說明

關於預檢規則的概念、運行原理和整合過程，請參見預檢規則的定義與運行原理。

預檢規則和規則模板是同源規則，當您建立資源後，預檢規則可以持續檢測資源的合規性。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

config:EvaluatePreConfigRules

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ResourceTypeFormat	string	否	查詢開始 Token	ros
ResourceEvaluateItems	array<object>	是	預檢規則評估項列表。
	array<object>	否	預檢規則評估項。
ResourceLogicalId	string	否	資源邏輯 ID。說明如果該參數為空白，則按照`ResourceProperties`的 Base64 位元產生。	ResourceLogicId-test
ResourceType	string	否	資源類型。關於如何擷取預檢規則的標識，請參見 ListPreManagedRules 。說明參數`ResourceType`、`Identifier`和`ResourceProperties`必須同時設定。	ACS::ECS::Instance
Rules	array<object>	否	預檢規則列表。
	object	否	預檢規則。
Identifier	string	否	規則標識。關於如何擷取規則標識，請參見 ListPreManagedRules 。說明參數`ResourceType`、`Identifier`和`ResourceProperties`必須同時設定。	ecs-instance-deletion-protection-enabled
InputParameters	string	否	規則參數。	{}
ResourceProperties	string	否	資源配置項（即將建立的資源屬性），例如：資源的規格、所屬地區、名稱、狀態、連接埠或網口開關狀態等。說明參數`ResourceType`、`Identifier`和`ResourceProperties`必須同時設定。	{"ResourceGroupId":"","Memory":8192,"InstanceChargeType":"PostPaid","Cpu":2}
EnableManagedRules	boolean	否	是否啟用規則模板。取值： true：啟用規則模板。 false（預設值）：不啟用規則模板。	false

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object	無。
RequestId	string	請求 ID。	129ECF1C-7897-1131-BD0F-4B588AC05400
ResourceEvaluations	array<object>	資源評估結果清單。
	array<object>	資源評估結果。
ResourceLogicalId	string	資源邏輯 ID。說明如果請求參數為空白，則自動根據`ResourceProperties`的 Base64 位元產生。	ResourceLogicId-test
ResourceType	string	資源類型。	ACS::ECS::Instance
Rules	array<object>	預檢規則列表。
	object	預檢規則。
Identifier	string	規則標識。	ecs-instance-deletion-protection-enabled
ComplianceType	string	預檢規則的合規類型。取值： COMPLIANT：合規。 NON_COMPLIANT：不合規。 NOT_APPLICABLE：不適用。	NON_COMPLIANT
Annotation	string	不合規原因。	{\"configuration\":\"false\",\"desiredValue\":\"True\",\"operator\":\"StringEquals\",\"property\":\"$.DeletionProtection\"}
HelpUrl	string	託管規則修正指導的文檔連結。	https://example.aliyundoc.com

關於公用請求參數的詳情，請參見公用參數。

樣本

正常返回樣本

JSON格式

{
  "RequestId": "129ECF1C-7897-1131-BD0F-4B588AC05400",
  "ResourceEvaluations": [
    {
      "ResourceLogicalId": "ResourceLogicId-test",
      "ResourceType": "ACS::ECS::Instance",
      "Rules": [
        {
          "Identifier": "ecs-instance-deletion-protection-enabled",
          "ComplianceType": "NON_COMPLIANT",
          "Annotation": "{\\\"configuration\\\":\\\"false\\\",\\\"desiredValue\\\":\\\"True\\\",\\\"operator\\\":\\\"StringEquals\\\",\\\"property\\\":\\\"$.DeletionProtection\\\"}",
          "HelpUrl": "https://example.aliyundoc.com"
        }
      ]
    }
  ]
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。