维修任务信息获取-裸金属云服务器-文档中心-腾讯云

1. 接口描述

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

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

TaskStatus（任务状态ID）与状态中文名的对应关系如下：

1：未授权

2：处理中

3：待确认

4：未授权-暂不处理

5：已恢复

6：待确认-未恢复

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	返回任务总数量示例值：2
TaskInfoSet	Array of TaskInfo	任务信息列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 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": {
        "TotalCount": 2,
        "TaskInfoSet": [
            {
                "Zone": "xx",
                "SubnetName": "xx",
                "EndTime": "2020-09-22 00:00:00",
                "VpcId": "xx",
                "TaskSubType": "xx",
                "TaskDetail": "xx",
                "InstanceId": "xx",
                "DeviceStatus": 1,
                "VpcName": "xx",
                "SubnetId": "xx",
                "MgtIp": "xx",
                "SubnetCidrBlock": "xx",
                "Region": "xx",
                "LanIp": "xx",
                "TaskStatus": 1,
                "Alias": "xx",
                "AuthTime": "2020-09-22 00:00:00",
                "OperateStatus": 1,
                "WanIp": "xx",
                "TaskTypeName": "xx",
                "VpcCidrBlock": "xx",
                "TaskTypeId": 1,
                "TaskId": "xx",
                "CreateTime": "2020-09-22 00:00:00"
            },
            {
                "Zone": "xx",
                "SubnetName": "xx",
                "EndTime": "2020-09-22 00:00:00",
                "VpcId": "xx",
                "TaskSubType": "xx",
                "TaskDetail": "xx",
                "InstanceId": "xx",
                "DeviceStatus": 1,
                "VpcName": "xx",
                "SubnetId": "xx",
                "Region": "xx",
                "SubnetCidrBlock": "xx",
                "MgtIp": "xx",
                "LanIp": "xx",
                "TaskStatus": 1,
                "Alias": "xx",
                "AuthTime": "2020-09-22 00:00:00",
                "OperateStatus": 1,
                "WanIp": "xx",
                "TaskTypeName": "xx",
                "VpcCidrBlock": "xx",
                "TaskTypeId": 1,
                "TaskId": "xx",
                "CreateTime": "2020-09-22 00:00:00"
            }
        ],
        "RequestId": "xx"
    }
}

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	未授权操作。

维修任务信息获取

本页目录：