1. 接口描述
接口请求域名: cwp.tencentcloudapi.com 。
根据基线策略id查询策略详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBaselineStrategyDetail。 |
Version | 是 | String | 公共参数,本接口取值:2018-02-28。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
StrategyId | 是 | Integer | 用户基线策略id 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PassRate | Integer | 策略扫描通过率 示例值:1 |
StrategyName | String | 策略名 示例值:等保一级策略 |
ScanCycle | String | 策略扫描周期(天) 示例值:1 |
ScanAt | String | 定期检测时间, 该时间下发扫描 示例值:00:00:00 |
IsGlobal | Integer | 扫描范围是否全部服务器, 1:是 0:否, 为1则为全部专业版主机 示例值:1 |
MachineType | String | 云服务器类型: cvm:腾讯云服务器 bm:裸金属 ecm:边缘计算主机 lh: 轻量应用服务器 ohter: 混合云机器 示例值:CVM |
Region | String | 主机地域 示例值:ap-bj |
Quuids | Array of String | 用户该策略下的所有主机id 示例值:["0096440e-9a9f-4e80-a82d-0b018637****"] |
CategoryIds | Array of String | 用户该策略下所有的基线id 示例值:"10021" |
IfScanned | Integer | 1 表示扫描过, 0没扫描过 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询策略详情接口
根据策略id查询该策略的详情
输入示例
https://cwp.tencentcloudapi.com/?Action=DescribeBaselineStrategyDetail
&StrategyId=1
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "req-566234234",
"PassRate": 50,
"StrategyName": "等保一级策略",
"ScanCycle": "1",
"ScanAt": "00:00:00",
"IsGlobal": 1,
"IfScanned": 1,
"MachineType": "cvm",
"Region": "ap-bj",
"Quuids": [
"2001",
"2002",
"2003"
],
"CategoryIds": [
"1"
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.MissingParameter | 参数缺失。 |
InvalidParameter.ParsingError | 参数解析错误。 |
InvalidParameterValue | 参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound | 资源不存在。 |