1. 接口描述
接口请求域名: bm.tencentcloudapi.com 。
获取自定义脚本任务详细信息
默认接口请求频率限制:10次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
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)。定位问题时需要提供该次请求的 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 平台
腾讯云 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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter | 参数错误。 |
UnauthorizedOperation | 未授权操作。 |