文档

EvaluatePreConfigRules - 执行预检规则评估资源

更新时间:

执行预检规则对资源进行合规预检。

接口说明

关于预检规则的概念、运行原理和集成过程,请参见预检规则的定义与运行原理

预检规则和规则模板是同源规则,当您创建资源后,预检规则可以持续检测资源的合规性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ResourceEvaluateItemsobject []

预检规则评估项列表。

ResourceLogicalIdstring

资源逻辑 ID。

说明 如果该参数为空,则按照ResourceProperties的 Base64 位生成。
ResourceLogicId-test
ResourceTypestring

资源类型。

关于如何获取预检规则的标识,请参见 ListPreManagedRules

说明 参数ResourceTypeIdentifierResourceProperties必须同时设置。
ACS::ECS::Instance
Rulesobject []

预检规则列表。

Identifierstring

规则标识。

关于如何获取规则标识,请参见 ListPreManagedRules

说明 参数ResourceTypeIdentifierResourceProperties必须同时设置。
ecs-instance-deletion-protection-enabled
InputParametersstring

规则参数。

{}
ResourcePropertiesstring

资源配置项(即将创建的资源属性),例如:资源的规格、所属地域、名称、状态、端口或网口开关状态等。

说明 参数ResourceTypeIdentifierResourceProperties必须同时设置。
{"ResourceGroupId":"","Memory":8192,"InstanceChargeType":"PostPaid","Cpu":2}
EnableManagedRulesboolean

是否启用规则模板。取值:

  • true:启用规则模板。

  • false(默认值):不启用规则模板。

false

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

129ECF1C-7897-1131-BD0F-4B588AC05400
ResourceEvaluationsobject []

资源评估结果列表。

ResourceLogicalIdstring

资源逻辑 ID。

说明 如果请求参数为空,则自动根据ResourceProperties的 Base64 位生成。
ResourceLogicId-test
ResourceTypestring

资源类型。

ACS::ECS::Instance
Rulesobject []

预检规则列表。

Identifierstring

规则标识。

ecs-instance-deletion-protection-enabled
ComplianceTypestring

预检规则的合规类型。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
NON_COMPLIANT
Annotationstring

不合规原因。

{\"configuration\":\"false\",\"desiredValue\":\"True\",\"operator\":\"StringEquals\",\"property\":\"$.DeletionProtection\"}
HelpUrlstring

托管规则修正指导的文档链接。

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"
        }
      ]
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-13API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)