调用DescribeConfigRule接口查询规则详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeConfigRule |
要执行的操作,取值:DescribeConfigRule。 |
ConfigRuleId | String | 是 | cr-7bc06457e0d90041**** |
规则ID。关于如何查询规则ID,请参见ListConfigRules。 |
MultiAccount | Boolean | 否 | false |
该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见账号组。 |
MemberId | Long | 否 | 123456789 |
该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见账号组。 |
返回数据
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeConfigRule
&ConfigRuleId=cr-7bc06457e0d90041****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeConfigRuleResponse>
<RequestId>A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99</RequestId>
<ConfigRule>
<ManagedRule>
<ManagedRuleName>rds-cpu-min-count-limit</ManagedRuleName>
<OptionalInputParameterDetails />
<Description>RDS实例的CPU核数大于等于设置的阈值,视为“合规”。</Description>
<Identifier>rds-cpu-min-count-limit</Identifier>
<CompulsoryInputParameterDetails>
<cpuCount>
<defaultValue>2</defaultValue>
<type>integer</type>
</cpuCount>
</CompulsoryInputParameterDetails>
<Labels>RDS</Labels>
<Labels>CPU</Labels>
<SourceDetails>
<EventSource>aliyun.config</EventSource>
<MessageType>ConfigurationItemChangeNotification</MessageType>
</SourceDetails>
</ManagedRule>
<ConfigRuleEvaluationStatus>
<FirstActivatedTimestamp>1618901952341</FirstActivatedTimestamp>
<LastSuccessfulEvaluationTimestamp>1618901957876</LastSuccessfulEvaluationTimestamp>
<FirstEvaluationStarted>true</FirstEvaluationStarted>
<LastSuccessfulInvocationTimestamp>1618901957395</LastSuccessfulInvocationTimestamp>
</ConfigRuleEvaluationStatus>
<ConfigRuleState>ACTIVE</ConfigRuleState>
<Source>
<Owner>ALIYUN</Owner>
<Identifier>rds-cpu-min-count-limit</Identifier>
<SourceConditions>
<Operator>GreaterOrEquals</Operator>
<DesiredValue>2</DesiredValue>
<Required>true</Required>
<SelectPath>$.DBInstanceCPU</SelectPath>
</SourceConditions>
<SourceDetails>
<EventSource>aliyun.config</EventSource>
<MessageType>ConfigurationItemChangeNotification</MessageType>
</SourceDetails>
</Source>
<OrganizationRule>false</OrganizationRule>
<ConfigRuleId>cr-7bc06457e0d90041****</ConfigRuleId>
<Scope>
<ComplianceResourceTypes>ACS::RDS::DBInstance</ComplianceResourceTypes>
</Scope>
<ConfigRuleArn>acs:config::120886317861****:rule/cr-7bc06457e0d90041****</ConfigRuleArn>
<ConfigRuleName>RDS实例CPU核数满足最低要求</ConfigRuleName>
<RiskLevel>3</RiskLevel>
<InputParameters>
<cpuCount>2</cpuCount>
</InputParameters>
</ConfigRule>
</DescribeConfigRuleResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99",
"ConfigRule" : {
"ManagedRule" : {
"ManagedRuleName" : "rds-cpu-min-count-limit",
"OptionalInputParameterDetails" : { },
"Description" : "RDS实例的CPU核数大于等于设置的阈值,视为“合规”。",
"Identifier" : "rds-cpu-min-count-limit",
"CompulsoryInputParameterDetails" : {
"cpuCount" : {
"defaultValue" : "2",
"type" : "integer"
}
},
"Labels" : [ "RDS", "CPU" ],
"SourceDetails" : [ {
"EventSource" : "aliyun.config",
"MessageType" : "ConfigurationItemChangeNotification"
} ]
},
"ConfigRuleEvaluationStatus" : {
"FirstActivatedTimestamp" : 1618901952341,
"LastSuccessfulEvaluationTimestamp" : 1618901957876,
"FirstEvaluationStarted" : true,
"LastSuccessfulInvocationTimestamp" : 1618901957395
},
"ConfigRuleState" : "ACTIVE",
"Source" : {
"Owner" : "ALIYUN",
"Identifier" : "rds-cpu-min-count-limit",
"SourceConditions" : [ {
"Operator" : "GreaterOrEquals",
"DesiredValue" : "2",
"Required" : true,
"SelectPath" : "$.DBInstanceCPU"
} ],
"SourceDetails" : [ {
"EventSource" : "aliyun.config",
"MessageType" : "ConfigurationItemChangeNotification"
} ]
},
"OrganizationRule" : false,
"ConfigRuleId" : "cr-7bc06457e0d90041****",
"Scope" : {
"ComplianceResourceTypes" : [ "ACS::RDS::DBInstance" ]
},
"ConfigRuleArn" : "acs:config::120886317861****:rule/cr-7bc06457e0d90041****",
"ConfigRuleName" : "RDS实例CPU核数满足最低要求",
"RiskLevel" : 3,
"InputParameters" : {
"cpuCount" : "2"
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|
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. | 服务不可用。 |
访问错误中心查看更多错误码。