1. 接口描述
接口请求域名: ssa.tencentcloudapi.com 。
云安全配置检查项结果列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeSocCheckResultList。 |
Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Filter.N | 否 | Array of QueryFilter | 查询参数,可支持的查询参数: Name,Type,AssetType,Result,PloyName,PloyId |
Sorter.N | 否 | Array of QuerySort | 排序参数,可支持的排序参数:CheckStatus,RiskCount |
PageSize | 否 | Integer | 当前页码数据,默认值为10 示例值:20 |
PageIndex | 否 | Integer | 当前页面索引,默认值为0 示例值:1 |
AssetId | 否 | String | 资产id |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Data | DescribeSocCheckResultListRspRsp | 无 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 配置检测详情列表
输入示例
POST / HTTP/1.1
Host: ssa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSocCheckResultList
<公共请求参数>
{
"Filter": [
{
"FilterValue": "1023115",
"FilterOperatorType": "1",
"FilterKey": " PloyId"
}
],
"PageIndex": "1",
"PageSize": "3",
"Sorter": [
{
"SortType": "1",
"SortKey": "RiskCount"
}
]
}
输出示例
{
"Response": {
"Data": {
"NormalTotal": 124,
"MiddleTotal": 72,
"Total": 269,
"LowTotal": 20,
"HighTotal": 53,
"List": [
{
"TotalAssetNum": 7,
"FailAssetNum": 0,
"Name": "关系型数据库-MariaDB应该启用备份",
"Result": "正常",
"PloyName": "腾讯云默认安全规范检查",
"PloyId": 1022732,
"Type": "数据安全",
"CheckId": "00fe63c2-94c7-11ea-89eb-6c92bf621820",
"DealUrl": "",
"AssetType": "mariadb"
},
{
"TotalAssetNum": 32,
"FailAssetNum": 0,
"Name": "CLB不应转发高危端口",
"Result": "正常",
"PloyName": "腾讯云默认安全规范检查",
"PloyId": 1022732,
"Type": "网络访问控制",
"CheckId": "12a8e83e-ddbd-4bb4-8d87-88da71facedf",
"DealUrl": "",
"AssetType": "clb"
},
{
"TotalAssetNum": 8,
"FailAssetNum": 0,
"Name": "Nosql数据库-Redis应该开启自动备份",
"Result": "正常",
"PloyName": "腾讯云默认安全规范检查",
"PloyId": 1022732,
"Type": "数据安全",
"CheckId": "3c6d8565-94c4-11ea-89eb-6c92bf621820",
"DealUrl": "",
"AssetType": "redis"
}
]
},
"RequestId": "8e668163-32f4-4a77-b248-9b14cbee1232"
}
}
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 | 内部错误。 |
InternalError.DBError | DB错误。 |
InternalError.ParamError | 参数校验失败。 |