DescribeConfigRule - 查询规则详情

查询指定的规则详情。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
config:DescribeConfigRuleget
*全部资源
*

请求参数

名称类型必填描述示例值
ConfigRuleIdstring

规则 ID。关于如何查询规则 ID,请参见 ListConfigRules

cr-7bc06457e0d90041****
MultiAccountboolean

该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组

false
MemberIdlong

该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组

123456789

返回参数

名称类型描述示例值
object

无。

ConfigRuleobject

规则详情。

ConfigRuleArnstring

规则 ARN。

acs:config::120886317861****:rule/cr-7bc06457e0d90041****
ConfigRuleEvaluationStatusobject

资源评估状态。

FirstActivatedTimestamplong

首次激活时间戳。

1618901952341
FirstEvaluationStartedboolean

规则是否已执行过评估。取值:

  • true(默认值)
  • false
true
LastErrorCodestring

规则最近一次执行的错误码。

FunctionNotFound
LastErrorMessagestring

规则最近一次执行的错误信息。

function 'funtionName' does not exist in service 'serviceName'
LastFailedEvaluationTimestamplong

规则最近一次调用失败的结束时间戳。

1602819143913
LastFailedInvocationTimestamplong

规则最近一次调用失败的开始时间戳。

1602819143910
LastSuccessfulEvaluationTimestamplong

规则最近一次调用成功的结束时间戳。

1618901957876
LastSuccessfulInvocationTimestamplong

规则最近一次调用成功的开始时间戳。

1618901957395
ConfigRuleIdstring

规则 ID。

cr-7bc06457e0d90041****
ConfigRuleNamestring

规则名称。

RDS实例CPU核数满足最低要求
ConfigRuleStatestring

当前规则的运行状态。取值:

  • ACTIVE:应用中。
  • EVALUATING:评估中。
  • INACTIVE:已停用。
ACTIVE
CreateTimestamplong

创建规则时的时间戳。

1602818964884
Descriptionstring

规则的描述信息。

RDS实例的CPU核数大于等于设置的阈值,视为“合规”。
InputParametersobject

规则入参。

{"cpuCount": "2" }
ManagedRuleobject

托管规则详情。

CompulsoryInputParameterDetailsobject

托管规则必填参数的信息。

{"cpuCount": {"defaultValue": "2","type": "integer"}
Descriptionstring

托管规则的描述信息。

RDS实例的CPU核数大于等于设置的阈值,视为“合规”。
Identifierstring

托管规则的标识符。

rds-cpu-min-count-limit
Labelsarray

无。

Labelsstring

托管规则的标签列表。

["RDS","CPU"]
ManagedRuleNamestring

托管规则的名称。

rds-cpu-min-count-limit
OptionalInputParameterDetailsobject

托管规则可选参数的描述信息。

{"tag1Value":{"type":"string","defaultValue":""},"tag2Key":{"type":"string","defaultValue":""}}
SourceDetailsarray<object>

托管规则详情。

SourceDetailsobject

无。

EventSourcestring

规则的事件来源。

说明 目前仅支持配置审计事件:aliyun.config。
aliyun.config
MaximumExecutionFrequencystring

规则的执行周期。取值:

  • One_Hour:1 小时。

  • Three_Hours:3 小时。

  • Six_Hours:6 小时。

  • Twelve_Hours:12 小时。

  • TwentyFour_Hours:24 小时。

Six_Hours
MessageTypestring

规则的触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
ConfigurationItemChangeNotification
MaximumExecutionFrequencystring

规则的执行周期。取值:

  • One_Hour:1 小时。

  • Three_Hours:3 小时。

  • Six_Hours:6 小时。

  • Twelve_Hours:12 小时。

  • TwentyFour_Hours:24 小时。

Six_Hours
ModifiedTimestamplong

规则最近一次修改的时间戳。

1602992721000
RiskLevelinteger

规则的风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
3
Scopeobject

规则的监控范围。

ComplianceResourceIdstring

待评估资源 ID。

vpc-6weoy5flv41pj4wvr****
ComplianceResourceTypesarray

无。

ComplianceResourceTypesstring

待评估资源类型列表。

["ACS::RDS::DBInstance"]
Sourceobject

规则执行逻辑的来源信息。

Identifierstring

规则标识。

  • 如果规则使用了托管规则,则该参数为托管规则名称。

  • 如果规则使用了自定义函数,则该参数为函数 ARN。

rds-cpu-min-count-limit
Ownerstring

规则来源的归属。取值:

  • CUSTOM_FC:用户自定义函数。

  • ALIYUN:托管规则。

ALIYUN
SourceConditionsarray<object>

规则的配置条件。

SourceConditionsobject

无。

DesiredValuestring

规则入参的期望值。

2
Namestring

规则入参的名称。

cpuCount
Operatorstring

规则入参的操作符。通过 SelectPath 获取到的不同数据类型,对应不同的操作符。

  • 当数据类型为 String 时,取值:

    • StringEquals:等于。
    • NotStringEquals:不等于。
    • StringIn:存在。
    • NotStringIn:不存在。
    • StringContains:包含。
    • NotStringContains:不包含。
  • 当数据类型为 Number 时,取值:

    • Equals:等于。
    • NotEquals:不等于。
    • Less:小于。
    • LessOrEquals:小于等于。
    • Greater:大于。
    • GreaterOrEquals:大于等于。
  • 当数据类型为基于 Base64 进制编码的 Base64 String 时,取值:

    • Base64Contains:包含。
    • NotBase64Contains:不包含。
    • Base64ContainsAll:包含全部。
    • Base64ExcludeAll:排除全部。
  • 当数据类型为 Array 时,取值:

    • Contains:包含。
    • NotContains:不包含。
    • In:存在。
    • NotIn:不存在。
    • ContainsAll:包含全部。
    • ExcludeAll:排除全部。
    • IsEmpty:为空。
GreaterOrEquals
Tipsstring

参数的提示信息。

实例的状态
SourceDetailsarray<object>

规则来源详情。

SourceDetailsobject

无。

EventSourcestring

事件来源。

说明 目前仅支持配置审计事件:aliyun.config。
aliyun.config
MaximumExecutionFrequencystring

规则的执行周期。取值:

  • One_Hour:1 小时。

  • Three_Hours:3 小时。

  • Six_Hours:6 小时。

  • Twelve_Hours:12 小时。

  • TwentyFour_Hours:24 小时。

Six_Hours
MessageTypestring

规则的触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
ConfigurationItemChangeNotification
RequestIdstring

请求 ID。

A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99

示例

正常返回示例

JSON格式

{
  "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": "RDS实例CPU核数满足最低要求",
    "ConfigRuleState": "ACTIVE",
    "CreateTimestamp": 1602818964884,
    "Description": "RDS实例的CPU核数大于等于设置的阈值,视为“合规”。",
    "InputParameters": {
      "cpuCount": 2
    },
    "ManagedRule": {
      "CompulsoryInputParameterDetails": {
        "test": "test",
        "test2": 1
      },
      "Description": "RDS实例的CPU核数大于等于设置的阈值,视为“合规”。",
      "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": "实例的状态"
        }
      ],
      "SourceDetails": [
        {
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "Six_Hours",
          "MessageType": "ConfigurationItemChangeNotification"
        }
      ]
    }
  },
  "RequestId": "A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99"
}

错误码

HTTP status code错误码错误信息描述
400ConfigRuleNotExistsThe ConfigRule does not exist.此规则不存在。
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
404AccountNotExistedYour account does not exist.-
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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