查询指定规则详情。
接口说明
本文将提供一个示例,查询规则cr-7f7d626622af0041****
的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
config:GetConfigRule | get | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ConfigRuleId | string | 是 | 规则 ID。 关于如何获取规则 ID,请参见 ListConfigRules 。 | cr-7f7d626622af0041**** |
关于公共请求参数的详情,请参见公共参数。
返回参数
示例
正常返回示例
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"
}
],
"ExtendContent": "{\"fixedHour\":\"12\"}",
"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": "120886317861****",
"TagKeyScope": "RAM",
"TagValueScope": "MFA",
"TagsScope": [
{
"TagKey": "key-1",
"TagValue": "value-1"
}
]
},
"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. | 服务不可用。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-04-18 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |