获取自定义脚本任务详细信息

最近更新时间:2019-04-29 17:08:15

1. 接口描述

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

获取自定义脚本任务详细信息

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserCmdTaskInfo
Version String 公共参数,本接口取值:2018-04-23
Region String 公共参数,本接口不需要传递此参数。
TaskId String 任务ID
Offset Integer 偏移量
Limit Integer 数量限制
OrderField String 排序字段,支持: RunBeginTime,RunEndTime,Status
Order Integer 排序方式,取值: 1倒序,0顺序;默认倒序
SearchKey String 关键字搜索,可搜索ID或别名,支持模糊搜索

3. 输出参数

参数名称 类型 描述
TotalCount Integer 返回数量
UserCmdTaskInfoSet Array of UserCmdTaskInfo 自定义脚本任务详细信息列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取自定义脚本任务详细信息

输入示例

https://bm.tencentcloudapi.com/?Action=DescribeUserCmdTaskInfo
&TaskId=cmdtask-mi5k1oct
&Offset=0
&Limit=20
&OrderField=RunBeginTime
&Order=1
&SearchKey=m
&<公共请求参数>

输出示例

{
  "Response": {
    "TotalCount": 2,
    "UserCmdTaskInfoSet": [
      {
        "AutoId": 4,
        "TaskId": "cmdtask-abc1",
        "RunBeginTime": "2018-09-20 17:42:21",
        "RunEndTime": "",
        "Status": -1,
        "InstanceName": "xxx1",
        "InstanceId": "cpm-aaa",
        "VpcName": "asdas",
        "VpcId": "vpc-123",
        "VpcCidrBlock": "10.88.0.0/16",
        "SubnetName": "asdadads",
        "SubnetId": "subnet-123",
        "SubnetCidrBlock": "10.88.0.0/24",
        "LanIp": "10.88.0.3",
        "CmdContent": "IyEvYmluL2Jhc2gKZm9yIGkgaW4gezEuLjEwMH0KZG8KICAgIGVjaG8gJGkKCXNsZWVwIDEwCmRvbmUK",
        "CmdParam": "",
        "CmdResult": "",
        "AppId": 123,
        "LastShellExit": -1
      },
      {
        "AutoId": 5,
        "TaskId": "cmdtask-abc2",
        "RunBeginTime": "2018-09-20 17:42:21",
        "RunEndTime": "",
        "Status": -1,
        "InstanceName": "xxxxx",
        "InstanceId": "cpm-bbb",
        "VpcName": "dsffdssfd",
        "VpcId": "vpc-234",
        "VpcCidrBlock": "10.88.0.0/16",
        "SubnetName": "fdsfdsfds",
        "SubnetId": "subnet-234",
        "SubnetCidrBlock": "10.88.255.0/24",
        "LanIp": "10.88.255.2",
        "CmdContent": "IyEvYmluL2Jhc2gKZm9yIGkgaW4gezEuLjEwMH0KZG8KICAgIGVjaG8gJGkKCXNsZWVwIDEwCmRvbmUK",
        "CmdParam": "",
        "CmdResult": "",
        "AppId": 123,
        "LastShellExit": -1
      }
    ],
    "RequestId": "da45b829-bbe4-4e49-b85e-e9cd0aeeb139"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

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