AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 配置审计 开发参考 API参考 API参考（2020-09-07） API目录 规则 单账号 GetConfigRule - 查询规则详情

GetConfigRule - 查询规则详情

更新时间：
产品详情
我的收藏

查询指定规则详情。

接口说明

本文将提供一个示例，查询规则cr-7f7d626622af0041****的详情。

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:GetConfigRule

get

*Rule

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

 无 无

请求参数

名称

类型

必填

描述

示例值
ConfigRuleId

string

是

规则 ID。

关于如何获取规则 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

规则归属阿里云账号 ID。

120886317861****
Compliance

object

规则合规统计结果。

ComplianceType

string

合规统计结果。取值：

  • COMPLIANT：合规。

  • NON_COMPLIANT：不合规。

  • NOT_APPLICABLE：不适用。

  • INSUFFICIENT_DATA：无数据。

NON_COMPLIANT
Count

integer

合规统计结果对应的评估资源数量。

3
ConfigRuleArn

string

规则模板 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

规则创建者的阿里云账号 ID。

100931896542****
CreatorName

string

规则创建者的名称。

Alice
CreateTimestamp

integer

创建规则的时间戳。单位：毫秒。

1604684022000
Description

string

规则模板描述。

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

string

规则对指定地域内资源无效，即不对该地域内资源执行评估。多个地域 ID 之间用半角逗号（,）分隔。

cn-hangzhou
ExcludeResourceGroupIdsScope

string

规则对指定资源组 ID 中的资源无效，即不对该资源组内的资源评估。多个资源组 ID 之间用半角逗号（,）分隔。

rg-aekzdibsjjc****
ExcludeResourceIdsScope

string

规则对指定资源 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

事件来源。

说明

目前仅支持配置审计事件：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

事件来源。

说明

目前仅支持配置审计事件：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取值为ECS,OSS时，如果该参数为AND，则表示规则仅对同时绑定标签ECS和OSS的资源生效。

取值：

  • AND：与。

  • OR：或。

OR
TagKeyScope deprecated

string

已废弃，请使用 TagsScope 字段。

规则仅对绑定指定标签的资源生效。

说明

参数TagKeyScope和TagValueScope同时返回。

RAM
TagValueScope deprecated

string

已废弃，请使用 TagsScope 字段。

规则仅对绑定指定标签的资源生效。

说明

参数TagKeyScope和TagValueScope同时返回。

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

示例

正常返回示例

JSON格式

{
  "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 status code

错误码

错误信息

描述
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. 服务不可用。

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

变更历史

更多信息，参考变更详情。

上一篇：ListConfigRules - 查询规则列表下一篇：ListConfigRuleEvaluationResults - 查询规则评估结果