查询命令模板列表

最近更新时间:2024-10-31 01:29:18

我的收藏

1. 接口描述

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

查询命令模板列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCmdTemplates。
Version String 公共参数,本接口取值:2019-10-18。
Region String 公共参数,详见产品支持的 地域列表
IdSet.N Array of Integer 命令模板ID集合,非必需
示例值:[1,2]
Name String 命令模板名,模糊查询,最大长度64字符
示例值:测试模板
Type Integer 命令模板类型 1-内置模板 2-自定义模板
示例值:1
Offset Integer 分页偏移位置,默认值为0
示例值:0
Limit Integer 每页条目数量,默认20
示例值:10

3. 输出参数

参数名称 类型 描述
CmdTemplateSet Array of CmdTemplate 命令模板列表
示例值:[{"Id":1, "Name":"测试模板", "CmdList":"rm -rf", "Type":2}]
TotalCount Integer 总记录数
示例值:10
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询命令模板列表

输入示例

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

{
    "IdSet": [
        1
    ]
}

输出示例

{
    "Response": {
        "CmdTemplateSet": [
            {
                "Id": 1,
                "Name": "测试模板",
                "CmdList": "rm -rf"
            }
        ],
        "TotalCount": 1,
        "RequestId": "4e7e46fe-c632-4a67-92ac-b9e8228c78ea"
    }
}

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 资源不存在。