GetCompliancePack - 查询合规包详情

查询指定的合规包详情。

接口说明

本文将提供一个示例,查询合规包cp-fdc8626622af00f9****的详情。返回结果显示,合规包名称为等保三级预检合规包、合规包状态为ACTIVE(正常)、合规包中规则的风险等级为1(高风险)等。

调试

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

调试

授权信息

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

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

请求参数

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

合规包ID。

关于如何获取合规包ID,请参见ListCompliancePacks

cp-a8a8626622af0082****

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求ID。

6EC7AED1-172F-42AE-9C12-295BC2ADB751
CompliancePackobject

合规包信息。

Statusstring

合规包状态。取值:

  • ACTIVE:正常。
  • CREATING:创建中。
ACTIVE
CompliancePackIdstring

合规包ID。

cp-a8a8626622af0082****
RiskLevelinteger

合规包风险等级。取值:

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

合规包描述。

基于等保2.0三级标准,提供持续检测合规性的建议模板,帮助您提前自检并修复问题,以便快速通过正式检测。
ConfigRulesarray

合规包中的规则列表。

object

无。

ManagedRuleIdentifierstring

托管规则标识。

eip-bandwidth-limit
ConfigRuleNamestring

规则名称。

弹性IP实例带宽满足最低要求
ConfigRuleIdstring

规则ID。

cr-a260626622af0005****
ConfigRuleParametersarray

规则参数信息。

object

无。

Requiredboolean

规则中参数是否必填。取值:

  • true:必填。
  • false:非必填。
true
ParameterNamestring

规则参数名称。

bandwidth
ParameterValuestring

规则参数值。

10
Descriptionstring

规则描述。

弹性IP实例可用带宽大于等于指定参数值,视为“合规”。默认值:10 MB。
RiskLevelinteger

规则风险等级。取值:

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

合规包名称。

等保三级预检合规包
AccountIdlong

合规包归属的阿里云账号ID。

100931896542****
CompliancePackTemplateIdstring

合规包模板ID。

ct-5f26ff4e06a300c4****
CreateTimestamplong

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

1624245766000
Scopeobject

资源组生效范围。

RegionIdsScopestring

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

cn-hangzhou
ExcludeResourceIdsScopestring

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

eip-8vbf3x310fn56ijfd****
ResourceGroupIdsScopestring

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

rg-aekzc7r7rhx****
TagKeyScopestring

合规包仅对绑定指定标签键的资源生效。

ECS
TagValueScopestring

合规包仅对绑定指定标签键值对的资源生效。

test

示例

正常返回示例

JSON格式

{
  "RequestId": "6EC7AED1-172F-42AE-9C12-295BC2ADB751",
  "CompliancePack": {
    "Status": "ACTIVE",
    "CompliancePackId": "cp-a8a8626622af0082****",
    "RiskLevel": 1,
    "Description": "基于等保2.0三级标准,提供持续检测合规性的建议模板,帮助您提前自检并修复问题,以便快速通过正式检测。",
    "ConfigRules": [
      {
        "ManagedRuleIdentifier": "eip-bandwidth-limit",
        "ConfigRuleName": "弹性IP实例带宽满足最低要求",
        "ConfigRuleId": "cr-a260626622af0005****",
        "ConfigRuleParameters": [
          {
            "Required": true,
            "ParameterName": "bandwidth",
            "ParameterValue": "10"
          }
        ],
        "Description": "弹性IP实例可用带宽大于等于指定参数值,视为“合规”。默认值:10 MB。",
        "RiskLevel": 1
      }
    ],
    "CompliancePackName": "等保三级预检合规包",
    "AccountId": 0,
    "CompliancePackTemplateId": "ct-5f26ff4e06a300c4****",
    "CreateTimestamp": 1624245766000,
    "Scope": {
      "RegionIdsScope": "cn-hangzhou",
      "ExcludeResourceIdsScope": "eip-8vbf3x310fn56ijfd****",
      "ResourceGroupIdsScope": "rg-aekzc7r7rhx****",
      "TagKeyScope": "ECS",
      "TagValueScope": "test"
    }
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.CompliancePackId.ValueThe specified CompliancePackId does not exist.合规包ID不存在。
404AccountNotExistedYour account does not exist.您的账号不存在。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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

阿里云首页 配置审计 相关技术圈