维修任务信息获取

最近更新时间:2018-09-18 16:56:25

1. 接口描述

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

获取用户维修任务列表及详细信息

TaskStatus(任务状态ID)与状态中文名的对应关系如下:
1:未授权
2:处理中
3:待确认
4:未授权-暂不处理
5:已恢复
6:待确认-未恢复

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeTaskInfo
Version String 公共参数,本接口取值:2018-04-23
Region String 公共参数,详见产品支持的地域列表
Offset Integer 开始位置
Limit Integer 数据条数
StartDate Date 时间过滤下限
EndDate Date 时间过滤上限
TaskStatus.N Array of Integer 任务状态ID过滤
OrderField String 排序字段,目前支持:CreateTime,AuthTime,EndTime
Order Integer 排序方式 0:递增(默认) 1:递减
TaskIds.N Array of String 任务ID过滤
InstanceIds.N Array of String 实例ID过滤
Aliases.N Array of String 实例别名过滤
TaskTypeIds.N Array of Integer 故障类型ID过滤

3. 输出参数

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

4. 示例

示例1 维修任务信息获取

输入示例

https://bm.tencentcloudapi.com/?Action=DescribeTaskInfo
&Offset=0
&Limit=20
&OrderField=CreateTime
&Order=1
&StartDate=2018-07-10
&EndDate=2018-07-19
&TaskStatus.0=1
&TaskIds.0=b
&InstanceIds.0=o
&Aliases.0=-
&TaskTypeIds.0=44
&TaskTypeIds.1=49
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "56b1bc7b-c97c-4f17-a42d-bb9c181b9b83",
    "TaskInfoSet": [
      {
        "Alias": "jason - 黑石 - 织云测试1",
        "AuthTime": "",
        "CreateTime": "2018-07-16 10:42:29",
        "DeviceStatus": 4,
        "EndTime": "",
        "InstanceId": "tcpm-rewhxuo7",
        "LanIp": "10.10.1.60",
        "MgtIp": "100.73.46.196",
        "OperateStatus": 20,
        "Region": "ap-beijing",
        "SubnetCidrBlock": "10.0.0.0/24",
        "SubnetId": "subnet-1so5ae8m",
        "SubnetName": "sub1",
        "TaskDetail": "内存出现故障会导致存储数据发生改变、程序出错,严重情况下会导致系统出现异常直接影响业务。",
        "TaskId": "bm-repair-pygkh5q7",
        "TaskStatus": 1,
        "TaskTypeId": 49,
        "VpcCidrBlock": "10.0.0.0/16",
        "VpcId": "vpc-34cxlz7z",
        "VpcName": "test",
        "WanIp": "115.159.240.68",
        "Zone": "ap-beijing-bls-1"
      },
      {
        "Alias": "ami - NAT日志版本测试",
        "AuthTime": "",
        "CreateTime": "2018-07-13 17:47:33",
        "DeviceStatus": 4,
        "EndTime": "",
        "InstanceId": "cpm-cbqm5mo8",
        "LanIp": "10.123.0.30",
        "MgtIp": "100.81.198.66",
        "OperateStatus": 1,
        "Region": "ap-beijing",
        "SubnetCidrBlock": "10.1.55.0/24",
        "SubnetId": "subnet-mkziizg3",
        "SubnetName": "sub13",
        "TaskDetail": "设备己停机,业务己中断。",
        "TaskId": "bm-repair-6ofdlrht",
        "TaskStatus": 1,
        "TaskTypeId": 44,
        "VpcCidrBlock": "10.1.0.0/16",
        "VpcId": "vpc-4vk5e4bu",
        "VpcName": "HEISHI_VPCk",
        "WanIp": "",
        "Zone": "ap-beijing-bls-1"
      }
    ],
    "TotalCount": 2
  }
}

5. 开发者资源

API Explorer

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

SDK

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

命令行工具

6. 错误码

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

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

如果有其他疑问,你也可以通过提问形式与我们联系探讨