调用GetConfigRule接口查询指定规则详情。

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetConfigRule

要执行的操作,取值:GetConfigRule

ConfigRuleId String cr-7f7d626622af0041****

规则ID。

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

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

返回数据

名称 类型 示例值 描述
RequestId String 811234F4-C3AB-4D15-B90B-F55016D1B5AA

请求ID。

ConfigRule Object

规则详情。

RiskLevel Integer 1

规则风险等级。取值:

  • 1:高风险。
  • 2:中风险。
  • 3:低风险。
InputParameters Map

规则参数信息。

Source Object

规则来源信息。

SourceDetails Array of SourceDetails

规则来源详情。

MessageType String ConfigurationItemChangeNotification

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
EventSource String aliyun.config

事件来源。

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

规则执行周期。

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

规则来源的归属。取值:

  • CUSTOM_FC:自定义规则。
  • ALIYUN:托管规则。
Identifier String acs:fc:cn-hangzhou:100931896542****:services/ConfigService.LATEST/functions/specific-config

规则标识。

  • 如果是托管规则,该参数为托管规则标识。
  • 如果是自定义规则,该参数为函数ARN。
ConfigRuleState String ACTIVE

规则运行状态。取值:

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

规则执行周期。

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

托管规则详情。

SourceDetails Array of SourceDetails

托管规则来源详情。

MessageType String ConfigurationItemChangeNotification

规则触发机制。取值:

  • ConfigurationItemChangeNotification:配置变更。
  • ScheduledNotification:周期执行。
EventSource String aliyun.config

事件来源。

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

规则执行周期。

  • One_Hour:1小时。
  • Three_Hours:3小时。
  • Six_Hours:6小时。
  • Twelve_Hours:12小时。
  • TwentyFour_Hours:24小时。
说明 当规则触发机制为周期执行时,返回该参数。
Description String ECS磁盘未因欠费或安全等原因而被锁定,视为“合规”。

托管规则描述。

Labels Array of String ["RAM","User"]

托管规则标签。

Identifier String ram-user-mfa-check

托管规则标识。

OptionalInputParameterDetails Map

托管规则可选参数详情。

ManagedRuleName String RAM用户开启MFA

托管规则名称。

CompulsoryInputParameterDetails Map

托管规则必选参数详情。

ConfigRuleArn String acs:config::100931896542****:rule/cr-7f7d626622af0041****

托管规则ARN。

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

托管规则描述。

CreateBy Object

创建信息。

CompliancePackId String cp-541e626622af008****

合规包ID。

CompliancePackName String OSS合规基线

合规包名称。

CreatorName String Alice

规则创建者的名称。

CreatorId String 100931896542****

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

ConfigRuleName String RAM用户开启MFA

规则名称。

ConfigRuleEvaluationStatus Object

规则执行状态。

LastErrorCode String TimeOut

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

LastSuccessfulEvaluationTimestamp Long 1624932227486

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

FirstActivatedTimestamp Long 1624932221993

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

FirstEvaluationStarted Boolean true

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

  • true
  • false
LastSuccessfulInvocationTimestamp Long 1624932227476

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

LastErrorMessage String Time out

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

LastFailedEvaluationTimestamp Long 1614687022000

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

LastFailedInvocationTimestamp Long 1614687022000

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

ConfigRuleId String cr-7f7d626622af0041****

规则ID。

ModifiedTimestamp Long 1614687022000

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

CreateTimestamp Long 1604684022000

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

ResourceTypesScope String ACS::RAM::User

规则评估的资源类型。

RegionIdsScope String global

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

ExcludeResourceIdsScope String 23642660635687****

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

ResourceGroupIdsScope String rg-aekzdibsjjc****

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

TagKeyScope String RAM

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

说明 参数TagKeyScopeTagValueScope同时返回。
TagValueScope String MFA

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

说明 参数TagKeyScopeTagValueScope同时返回。
ConfigRuleTriggerTypes String ConfigurationItemChangeNotification

规则触发机制。取值:

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

示例

请求示例

http(s)://[Endpoint]/?Action=GetConfigRule
&ConfigRuleId=cr-7f7d626622af0041****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetAggregateConfigRuleResponse>
	<RequestId>811234F4-C3AB-4D15-B90B-F55016D1B5AA</RequestId>
	<ConfigRule>
		<ManagedRule>
			<ManagedRuleName>RAM用户开启MFA</ManagedRuleName>
			<OptionalInputParameterDetails />
			<Description>RAM用户开启MFA,视为“合规”。</Description>
			<Identifier>ram-user-mfa-check</Identifier>
			<CompulsoryInputParameterDetails />
			<Labels>RAM</Labels>
			<Labels>User</Labels>
			<SourceDetails>
				<EventSource>aliyun.config</EventSource>
				<MessageType>ConfigurationItemChangeNotification</MessageType>
			</SourceDetails>
		</ManagedRule>
		<Description>RAM用户开启MFA,视为“合规”。</Description>
		<CreateBy>
			<CreatorId>100931896542****</CreatorId>
			<CreatorName>Alice</CreatorName>
		</CreateBy>
		<ConfigRuleEvaluationStatus>
			<LastSuccessfulEvaluationTimestamp>1624932227486</LastSuccessfulEvaluationTimestamp>
			<FirstActivatedTimestamp>1624932221993</FirstActivatedTimestamp>
			<FirstEvaluationStarted>true</FirstEvaluationStarted>
			<LastSuccessfulInvocationTimestamp>1624932227476</LastSuccessfulInvocationTimestamp>
		</ConfigRuleEvaluationStatus>
		<ConfigRuleState>ACTIVE</ConfigRuleState>
		<Source>
			<Owner>ALIYUN</Owner>
			<Identifier>ram-user-mfa-check</Identifier>
			<SourceDetails>
				<EventSource>aliyun.config</EventSource>
				<MessageType>ConfigurationItemChangeNotification</MessageType>
			</SourceDetails>
		</Source>
		<ConfigRuleId>cr-7f7d626622af0041****</ConfigRuleId>
		<Scope>
			<ComplianceResourceTypes>ACS::RAM::User</ComplianceResourceTypes>
		</Scope>
		<ConfigRuleArn>acs:config::100931896542****:rule/cr-7f7d626622af0041****</ConfigRuleArn>
		<ConfigRuleTriggerTypes>ConfigurationItemChangeNotification</ConfigRuleTriggerTypes>
		<ConfigRuleName>RAM用户开启MFA</ConfigRuleName>
		<RiskLevel>1</RiskLevel>
		<ResourceTypesScope>ACS::RAM::User</ResourceTypesScope>
		<InputParameters>
			<tag1Key>RAM</tag1Key>
			<tag1Value>test</tag1Value>
		</InputParameters>
	</ConfigRule>
</GetAggregateConfigRuleResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "811234F4-C3AB-4D15-B90B-F55016D1B5AA",
  "ConfigRule" : {
    "ManagedRule" : {
      "ManagedRuleName" : "RAM用户开启MFA",
      "OptionalInputParameterDetails" : { },
      "Description" : "RAM用户开启MFA,视为“合规”。",
      "Identifier" : "ram-user-mfa-check",
      "CompulsoryInputParameterDetails" : { },
      "Labels" : [ "RAM", "User" ],
      "SourceDetails" : [ {
        "EventSource" : "aliyun.config",
        "MessageType" : "ConfigurationItemChangeNotification"
      } ]
    },
    "Description" : "RAM用户开启MFA,视为“合规”。",
    "CreateBy" : {
      "CreatorId" : "100931896542****",
      "CreatorName" : "Alice"
    },
    "ConfigRuleEvaluationStatus" : {
      "LastSuccessfulEvaluationTimestamp" : 1624932227486,
      "FirstActivatedTimestamp" : 1624932221993,
      "FirstEvaluationStarted" : true,
      "LastSuccessfulInvocationTimestamp" : 1624932227476
    },
    "ConfigRuleState" : "ACTIVE",
    "Source" : {
      "Owner" : "ALIYUN",
      "Identifier" : "ram-user-mfa-check",
      "SourceDetails" : [ {
        "EventSource" : "aliyun.config",
        "MessageType" : "ConfigurationItemChangeNotification"
      } ]
    },
    "ConfigRuleId" : "cr-7f7d626622af0041****",
    "Scope" : {
      "ComplianceResourceTypes" : [ "ACS::RAM::User" ]
    },
    "ConfigRuleArn" : "acs:config::100931896542****:rule/cr-7f7d626622af0041****",
    "ConfigRuleTriggerTypes" : "ConfigurationItemChangeNotification",
    "ConfigRuleName" : "RAM用户开启MFA",
    "RiskLevel" : 1,
    "ResourceTypesScope" : "ACS::RAM::User",
    "InputParameters" : {
      "tag1Key" : "RAM",
      "tag1Value" : "test"
    }
  }
}

错误码

HttpCode 错误码 错误信息 描述
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. 服务不可用。

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