有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

1. 接口描述

接口请求域名: tcss.tencentcloudapi.com 。

查询所有检查项接口,返回总数和检查项列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCheckItemList。
Version String 公共参数,本接口取值:2020-11-01。
Region String 公共参数,此参数为可选参数。
Offset Integer 偏移量
示例值:0
Limit Integer 每次查询的最大记录数量
示例值:20
Filters.N Array of ComplianceFilters Name 可取值:
Name: 检查项名称
RiskType: 风险类别
RiskLevel: 风险等级
RiskTarget: 检查对象
RiskAttribute: 检测项所属分型线类型
Enable: 检查项是否开启(0:关闭 1:开启)

3. 输出参数

参数名称 类型 描述
ClusterCheckItems Array of ClusterCheckItem 检查项详情数组
TotalCount Integer 检查项总数
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询所有检查项示例

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCheckItemList
<公共请求参数>

{
    "Limit": "2",
    "Offset": "0"
}

输出示例

{
    "Response": {
        "ClusterCheckItems": [
            {
                "CheckItemId": 0,
                "Name": "abc",
                "ItemDetail": "abc",
                "RiskLevel": "abc",
                "RiskTarget": "abc",
                "RiskType": "abc",
                "RiskAttribute": "abc",
                "RiskProperty": "abc",
                "CVENumber": "abc",
                "DiscoverTime": "abc",
                "Solution": "abc",
                "CVSS": "abc",
                "CVSSScore": "abc",
                "RelateLink": "abc",
                "AffectedType": "abc",
                "AffectedVersion": "abc",
                "IgnoredAssetNum": 0,
                "IsIgnored": true,
                "RiskAssessment": "abc"
            }
        ],
        "TotalCount": 1,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
OperationDenied 操作被拒绝。
RequestLimitExceeded 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。