1. 接口描述
接口请求域名: config.tencentcloudapi.com 。
获取系统合规包详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSystemCompliancePack。 |
| Version | 是 | String | 公共参数,本接口取值:2022-08-02。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| CompliancePackId | 是 | String | 合规包ID 示例值:cp-wn7attowki |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CompliancePackId | String | 合规包ID 示例值:cp-wn7attowki |
| CompliancePackName | String | 合规包名称 示例值:网络及数据安全最佳实践 |
| Description | String | 合规包描述 示例值:从网络架构和数据安全等方面进行全面检测,以确保系统和数据进行了合理的设置和保护,有效减少网络和数据泄漏的风险。参考CIS Benchmarks文件要求。 |
| RiskLevel | Integer | 风险等级 示例值:1 |
| ConfigRules | Array of CompliancePackRuleForManage | 合规包规则列表 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取合规包详情
输入示例
POST / HTTP/1.1
Host: config.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSystemCompliancePack
<公共请求参数>
{
"CompliancePackId": "cp-wn7attowki"
}
输出示例
{
"Response": {
"CompliancePackId": "cp-wn7attowki",
"CompliancePackName": "PCI-DSSu6570u636eu5b89u5168u6807u51c6u5408u89c4u5305",
"ConfigRules": [
{
"CreateTime": "2023-07-14 09:08:20",
"Description": "CBSu4e91u786cu76d8u5f00u542fu4e86u52a0u5bc6uff0cu5219u7b26u5408u89c4u5219",
"Identifier": "cbs-disk-encrypted",
"RiskLevel": 2,
"RuleName": "CBSu4e91u786cu76d8u5f00u542fu52a0u5bc6u72b6u6001",
"UpdateTime": "2023-09-11 18:04:45"
}
],
"Description": "u53c2u7167PCI DSS v4.0u5bf9u8d26u53f7u6570u636eu4fddu62a4u7684u57fau7eb***u9762u63d0u4f9bu90e8u5206u5efau8baeu7684u5408u89c4u6027u68c0u6d4bu3002",
"RiskLevel": 1,
"RequestId": "3b76f6ae-1cc6-455f-8073-409cbf34e186"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
| ResourceNotFound.CompliancePackNotExist | 合规包不存在。 |