获取DSPA评估模板列表

最近更新时间:2025-01-15 01:15:14

我的收藏

1. 接口描述

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

获取DSPA评估模板列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDSPAAssessmentTemplates。
Version String 公共参数,本接口取值:2019-07-23。
Region String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-shanghai, ap-shanghai-fsi 。
DspaId String DSPA实例Id,格式“dspa-xxxxxxxx”
示例值:dspa-ad0gf4ks
Offset Integer 偏移量。默认为0
示例值:0
Limit Integer 结果集个数限制。默认为20,最大值为100
示例值:20
Filters.N Array of DspaAssessmentFilter 过滤项。支持模糊搜索:(TemplateId,TemplateName)支持过滤:Source:模板来源,system / userUseType:模板类型,auto,semi-auto,law等Status:模板启用状态,draft / launched,ComplianceId:关联的分类分级模板id
示例值:[{"Name":"cdb","Values":["cdb-a1b2"]}]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的模板数目
示例值:2
Items Array of AssessmentTemplate 模板列表。
示例值:[{"Id":10177,"TemplateId":"template-NDg4N","TemplateName":"评估模板回归","Description":"fasa","Source":"user","UseType":"auto","CreatedTime":"2024-11-09 13:35:40","ControlItemCount":0,"AppliedItemCount":0,"Status":"launched","SupportDataSource":["mysql","pgsql","mssql","oracle"],"IsASMTemplate":false,"IdentifyComplianceId":1}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取DSPA评估模板列表

输入示例

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

{
    "DspaId": "dspa-92aabacd",
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Items": [
            {
                "Id": 2,
                "TemplateId": "template-00000002",
                "TemplateName": "系统基础评估模板",
                "Description": "自动化测试,勿删",
                "Source": "system",
                "UseType": "auto",
                "CreatedTime": "2023-05-13 14:01:45",
                "ControlItemCount": 194,
                "AppliedItemCount": 63,
                "Status": "launched",
                "SupportDataSource": [
                    "mysql",
                    "pgsql",
                    "mongodb",
                    "oracle",
                    "mssql",
                    "es",
                    "cos",
                    "cam",
                    "db2",
                    "apigateway"
                ],
                "IsASMTemplate": false,
                "IdentifyComplianceId": 1
            }
        ],
        "RequestId": "0db4a846-ad6e-4446-b393-6d5169c88778"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。