文档

GetConfigRule - 查询规则详情

更新时间:

查询指定规则详情。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

规则 ID。

关于如何获取规则 ID,请参见 ListConfigRules

cr-7f7d626622af0041****

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

811234F4-C3AB-4D15-B90B-F55016D1B5AA
ConfigRuleobject

规则详情。

RiskLevelinteger

规则风险等级。取值:

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

规则参数信息。

Sourceobject

规则来源信息。

SourceDetailsobject []

规则来源详情。

MessageTypestring

规则触发机制。取值:

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

事件来源。

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

规则执行周期。

  • One_Hour:1 小时。
  • Three_Hours:3 小时。
  • Six_Hours:6 小时。
  • Twelve_Hours:12 小时。
  • TwentyFour_Hours:24 小时。
说明 当规则触发机制为周期执行时,返回该参数。
One_Hour
Ownerstring

规则来源的归属。取值:

  • CUSTOM_FC:自定义规则。

  • ALIYUN:规则模板。

ALIYUN
Identifierstring

规则标识。

  • 如果是规则模板,该参数为规则模板标识。

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

acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config
ConfigRuleStatestring

规则运行状态。取值:

  • ACTIVE:应用中。
  • DELETING:删除中。
  • EVALUATING:评估中。
  • INACTIVE:已停用。
ACTIVE
MaximumExecutionFrequencystring

规则执行周期。

  • One_Hour:1 小时。
  • Three_Hours:3 小时。
  • Six_Hours:6 小时。
  • Twelve_Hours:12 小时。
  • TwentyFour_Hours:24 小时。
说明 当规则触发机制为周期执行时,返回该参数。
One_Hour
ManagedRuleobject

规则模板详情。

SourceDetailsobject []

规则模板来源详情。

MessageTypestring

规则触发机制。取值:

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

事件来源。

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

规则执行周期。

  • One_Hour:1 小时。
  • Three_Hours:3 小时。
  • Six_Hours:6 小时。
  • Twelve_Hours:12 小时。
  • TwentyFour_Hours:24 小时。
说明 当规则触发机制为周期执行时,返回该参数。
One_Hour
Descriptionstring

规则模板描述。

ECS磁盘未因欠费或安全等原因而被锁定,视为“合规”。
Labelsarray

规则标签列表。

string

规则模板标签。

["RAM","User"]
Identifierstring

规则模板标识。

ram-user-mfa-check
OptionalInputParameterDetailsobject

规则模板可选参数详情。

{}
ManagedRuleNamestring

规则模板名称。

RAM用户开启MFA
CompulsoryInputParameterDetailsobject

规则模板必选参数详情。

{}
ConfigRuleArnstring

规则模板 ARN。

acs:config::100931896542****:rule/cr-7f7d626622af0041****
Descriptionstring

规则模板描述。

RAM用户开启MFA,视为“合规”。
CreateByobject

创建信息。

CompliancePackIdstring

合规包 ID。

cp-541e626622af008****
CompliancePackNamestring

合规包名称。

OSS合规基线
CreatorNamestring

规则创建者的名称。

Alice
CreatorIdstring

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

100931896542****
ConfigRuleNamestring

规则名称。

RAM用户开启MFA
ConfigRuleEvaluationStatusobject

规则执行状态。

LastErrorCodestring

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

TimeOut
LastSuccessfulEvaluationTimestamplong

规则最近一次调用成功的结束时间戳。单位:毫秒。

1624932227486
FirstActivatedTimestamplong

规则首次激活时间戳。单位:毫秒。

1624932221993
FirstEvaluationStartedboolean

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

  • true:规则已执行评估。
  • false:规则未执行评估。
true
LastSuccessfulInvocationTimestamplong

规则最近一次调用成功的开始时间戳。单位:毫秒。

1624932227476
LastErrorMessagestring

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

Time out
LastFailedEvaluationTimestamplong

规则最近一次调用失败的结束时间戳。单位:毫秒。

1614687022000
LastFailedInvocationTimestamplong

规则最近一次调用失败的开始时间戳。单位:毫秒。

1614687022000
ConfigRuleIdstring

规则 ID。

cr-7f7d626622af0041****
ModifiedTimestamplong

规则最近一次更新的时间戳。单位:毫秒。

1614687022000
CreateTimestamplong

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

1604684022000
ResourceTypesScopestring

规则评估的资源类型。

ACS::RAM::User
ExcludeResourceIdsScopestring

规则对指定资源 ID 无效,即不对该资源执行评估。

23642660635687****
TagKeyScopestring

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

说明 参数TagKeyScopeTagValueScope同时返回。
RAM
TagValueScopestring

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

说明 参数TagKeyScopeTagValueScope同时返回。
MFA
ConfigRuleTriggerTypesstring

规则触发机制。取值:

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

规则生效范围。

ComplianceResourceTypesarray

规则评估的资源类型列表。也可使用 ResourceTypesScope 字段进行查看。

string

规则评估的资源类型。

ACS::RAM::User
TagKeyLogicScopestring

规则对指定成员账号内的资源无效,即不对该账号内的资源执行评估。

120886317861****
Complianceobject

规则合规统计结果。

ComplianceTypestring

合规统计结果。取值:

  • COMPLIANT:合规。
  • NON_COMPLIANT:不合规。
  • NOT_APPLICABLE:不适用。
  • INSUFFICIENT_DATA:无数据。
NON_COMPLIANT
Countinteger

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

3
AccountIdlong

规则归属阿里云账号 ID。

120886317861****
RegionIdsScopestring

规则仅对指定地域 ID 中的资源生效。

global
ResourceGroupIdsScopestring

规则仅对指定资源组 ID 中的资源生效。

rg-aekzdibsjjc****

示例

正常返回示例

JSON格式

{
  "RequestId": "811234F4-C3AB-4D15-B90B-F55016D1B5AA",
  "ConfigRule": {
    "RiskLevel": 1,
    "InputParameters": {
      "test": "test",
      "test2": 1
    },
    "Source": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Owner": "ALIYUN",
      "Identifier": "acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config"
    },
    "ConfigRuleState": "ACTIVE",
    "MaximumExecutionFrequency": "One_Hour",
    "ManagedRule": {
      "SourceDetails": [
        {
          "MessageType": "ConfigurationItemChangeNotification",
          "EventSource": "aliyun.config",
          "MaximumExecutionFrequency": "One_Hour"
        }
      ],
      "Description": "ECS磁盘未因欠费或安全等原因而被锁定,视为“合规”。",
      "Labels": [
        "[\"RAM\",\"User\"]"
      ],
      "Identifier": "ram-user-mfa-check",
      "OptionalInputParameterDetails": {},
      "ManagedRuleName": "RAM用户开启MFA",
      "CompulsoryInputParameterDetails": {}
    },
    "ConfigRuleArn": "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "Description": "RAM用户开启MFA,视为“合规”。",
    "CreateBy": {
      "CompliancePackId": "cp-541e626622af008****",
      "CompliancePackName": "OSS合规基线",
      "CreatorName": "Alice",
      "CreatorId": "100931896542****"
    },
    "ConfigRuleName": "RAM用户开启MFA",
    "ConfigRuleEvaluationStatus": {
      "LastErrorCode": "TimeOut",
      "LastSuccessfulEvaluationTimestamp": 1624932227486,
      "FirstActivatedTimestamp": 1624932221993,
      "FirstEvaluationStarted": true,
      "LastSuccessfulInvocationTimestamp": 1624932227476,
      "LastErrorMessage": "Time out",
      "LastFailedEvaluationTimestamp": 1614687022000,
      "LastFailedInvocationTimestamp": 1614687022000
    },
    "ConfigRuleId": "cr-7f7d626622af0041****",
    "ModifiedTimestamp": 1614687022000,
    "CreateTimestamp": 1604684022000,
    "ResourceTypesScope": "ACS::RAM::User",
    "ExcludeRegionIdsScope": "",
    "ResourceIdsScope": "",
    "ExcludeResourceIdsScope": "23642660635687****",
    "ExcludeResourceGroupIdsScope": "",
    "TagKeyScope": "RAM",
    "TagValueScope": "MFA",
    "ConfigRuleTriggerTypes": "ConfigurationItemChangeNotification",
    "Scope": {
      "ComplianceResourceTypes": [
        "ACS::RAM::User"
      ]
    },
    "TagKeyLogicScope": "120886317861****",
    "Compliance": {
      "ComplianceType": "NON_COMPLIANT",
      "Count": 3
    },
    "AccountId": 0,
    "RegionIdsScope": "global",
    "ResourceGroupIdsScope": "rg-aekzdibsjjc****",
    "TagsScope": [
      {
        "TagKey": "",
        "TagValue": ""
      }
    ],
    "ExcludeTagsScope": [
      {
        "TagKey": "",
        "TagValue": ""
      }
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2023-04-18OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
    删除错误码:503
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)