获取自定义脚本任务列表-API 中心-腾讯云

1. 接口描述

接口请求域名： bm.tencentcloudapi.com 。

获取自定义脚本任务列表

默认接口请求频率限制：10次/秒。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUserCmdTasks。
Version	是	String	公共参数，本接口取值：2018-04-23。
Region	是	String	公共参数，详见产品支持的地域列表。
Offset	是	Integer	偏移量
Limit	是	Integer	数量限制
OrderField	否	String	排序字段，支持： RunBeginTime,RunEndTime,InstanceCount,SuccessCount,FailureCount
Order	否	Integer	排序方式，取值: 1倒序，0顺序；默认倒序

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	脚本任务信息数量
UserCmdTasks	Array of UserCmdTask	脚本任务信息列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取自定义脚本任务列表

输入示例

https://bm.tencentcloudapi.com/?Action=DescribeUserCmdTasks
&Offset=0
&Limit=20
&OrderField=RunBeginTime
&Order=1
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 4,
        "UserCmdTasks": [
            {
                "TaskId": "cmdtask-1ghosm17",
                "Status": -1,
                "Alias": "marsinfan",
                "CmdId": "cmd-dr3ja3hq",
                "InstanceCount": 2,
                "SuccessCount": 0,
                "FailureCount": 0,
                "RunBeginTime": "2018-09-20 17:42:21",
                "RunEndTime": ""
            },
            {
                "TaskId": "cmdtask-2obesa6h",
                "Status": -1,
                "Alias": "marsinfan",
                "CmdId": "cmd-dr3ja3hq",
                "InstanceCount": 1,
                "SuccessCount": 0,
                "FailureCount": 0,
                "RunBeginTime": "2018-09-10 21:09:49",
                "RunEndTime": ""
            },
            {
                "TaskId": "cmdtask-mi5k1o5p",
                "Status": -1,
                "Alias": "marsinfan",
                "CmdId": "cmd-dr3ja3hq",
                "InstanceCount": 1,
                "SuccessCount": 0,
                "FailureCount": 0,
                "RunBeginTime": "2018-09-10 21:06:52",
                "RunEndTime": ""
            },
            {
                "TaskId": "cmdtask-jjbalbah",
                "Status": -1,
                "Alias": "1",
                "CmdId": "cmd-bugfk68c",
                "InstanceCount": 1,
                "SuccessCount": 0,
                "FailureCount": 0,
                "RunBeginTime": "2018-09-10 20:57:09",
                "RunEndTime": ""
            }
        ],
        "RequestId": "c63330d9-0e57-4c7e-a34e-3e228d58ebc6"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation	操作失败。
InvalidParameter	参数错误。
UnauthorizedOperation	未授权操作。