查询指定的规则详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
config:DescribeConfigRule | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConfigRuleId | string | 是 | 规则 ID。关于如何查询规则 ID,请参见 ListConfigRules 。 | cr-7bc06457e0d90041**** |
MultiAccount | boolean | 否 | 该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组。 | false |
MemberId | long | 否 | 该参数计划于 2021 年 06 月 30 日 00 时 00 分 00 秒前下线,其替代功能账号组的 API 将于 2021 年 05 月 30 日 00 时 00 分 00 秒前上线。如果您正在使用该参数,建议您在 2021 年 05 月 30 日 00 时 00 分 00 秒之后切换为账号组的 API。关于账号组,请参见账号组。 | 123456789 |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 服务不可用。 |
访问错误中心查看更多错误码。