云服务器查询维修任务列表-维修任务相关接口-API 中心-腾讯云

1. 接口描述

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

本接口 (DescribeTaskInfo) 用于查询云服务器维修任务列表及详细信息。

可以根据实例ID、实例名称或任务状态等信息来查询维修任务列表。过滤信息详情可参考入参说明。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的维修任务列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTaskInfo。
Version	是	String	公共参数，本接口取值：2017-03-12。
Region	否	String	公共参数，此参数为可选参数。
Limit	是	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：20
Offset	是	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Product	否	String	按照指定的产品类型查询，支持取值： - `CVM`：云服务器 - `CDH`：专用宿主机 - `CPM2.0`：裸金属云服务器未传入或为空时，默认查询全部产品类型。示例值：CVM
TaskStatus.N	否	Array of Integer	按照一个或多个任务状态ID进行过滤。 `TaskStatus`（任务状态ID）与任务状态中文名的对应关系如下： - `1`：待授权 - `2`：处理中 - `3`：已结束 - `4`：已预约 - `5`：已取消 - `6`：已避免各任务状态的具体含义，可参考任务状态。示例值：[1, 2, 3, 4, 5, 6]
TaskTypeIds.N	否	Array of Integer	按照一个或多个任务类型ID进行过滤。 `TaskTypeId`（任务类型ID）与任务类型中文名的对应关系如下： - `101`：实例运行隐患 - `102`：实例运行异常 - `103`：实例硬盘异常 - `104`：实例网络连接异常 - `105`：实例运行预警 - `106`：实例硬盘预警 - `107`：实例维护升级各任务类型的具体含义，可参考维修任务分类。示例值：[101, 102, 103, 104, 105, 106, 107]
TaskIds.N	否	Array of String	按照一个或者多个任务ID查询。任务ID形如：`rep-xxxxxxxx`。示例值：["rep-xxxxxxxx"]
InstanceIds.N	否	Array of String	按照一个或者多个实例ID查询。实例ID形如：`ins-xxxxxxxx`。示例值：["ins-xxxxxxxx"]
Aliases.N	否	Array of String	按照一个或者多个实例名称查询。示例值：["test-1"]
StartDate	否	Timestamp	时间查询区间的起始位置，会根据任务创建时间`CreateTime`进行过滤。未传入时默认为当天`00:00:00`。示例值：2023-01-01 00:00:00
EndDate	否	Timestamp	时间查询区间的终止位置，会根据任务创建时间`CreateTime`进行过滤。未传入时默认为当前时刻。示例值：2023-02-01 00:00:00
OrderField	否	String	指定返回维修任务列表的排序字段，目前支持： - `CreateTime`：任务创建时间 - `AuthTime`：任务授权时间 - `EndTime`：任务结束时间未传入时或为空时，默认按`CreateTime`字段进行排序。示例值：CreateTime
Order	否	Integer	排序方式，目前支持： - `0`：升序（默认） - `1`：降序未传入或为空时，默认按升序排序。示例值：1

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询返回的维修任务总数量。示例值：2
RepairTaskInfoSet	Array of RepairTaskInfo	查询返回的维修任务列表。注意：此字段可能返回 null，表示取不到有效值。示例值：NA
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询待授权的维修任务列表

根据以下条件，查询并获取维修任务返回列表：

任务的创建时间在 2023-03-01 00:00:00 ~ 2023-04-01 00:00:00 范围内。
任务当前的状态为待授权。
返回的任务列表按照CreateTime创建时间降序返回，偏移量为0，最多返回20条数据。

输入示例

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskInfo
<公共请求参数>

{
    "StartDate": "2023-03-01 00:00:00",
    "EndDate": "2023-04-01 00:00:00",
    "TaskStatus": [
        1
    ],
    "Limit": 20,
    "Offset": 0,
    "OrderField": "CreateTime",
    "Order": 1
}

输出示例

{
    "Response": {
        "TotalCount": 2,
        "RepairTaskInfoSet": [
            {
                "TaskId": "rep-xxxxxxxx",
                "InstanceId": "ins-xxxxxxxx",
                "Alias": "test-1",
                "TaskTypeId": 107,
                "TaskStatus": 1,
                "CreateTime": "2023-03-08 12:00:00",
                "AuthTime": "2023-03-10 12:00:00",
                "EndTime": null,
                "TaskDetail": "监控到您的云服务器因底层宿主机架构、软件升级需要发起在线维护，处理过程中云服务器可能出现短时间高负载或者网络抖动。为尽快完成维护以提升实例性能及安全性，需要您授权我们在线维护。感谢您的支持与理解。",
                "DeviceStatus": 1,
                "OperateStatus": 1,
                "Zone": "ap-guangzhou-7",
                "Region": "ap-guangzhou",
                "VpcId": "vpc-xxxxxxxx",
                "SubnetId": "subnet-xxxxxxxx",
                "SubnetName": "Default-Subnet",
                "VpcName": "Default-VPC",
                "AuthSource": "System_mandatory_auth",
                "WanIp": "xxx.xxx.xxx.xxx",
                "LanIp": "xxx.xxx.xxx.xxx",
                "TaskTypeName": "实例维护升级",
                "TaskSubType": null,
                "AuthType": 6,
                "Product": "CVM"
            },
            {
                "TaskId": "rep-xxxxxxxx",
                "InstanceId": "ins-xxxxxxxx",
                "Alias": "test-2",
                "TaskTypeId": 101,
                "TaskStatus": 1,
                "CreateTime": "2023-03-07 12:00:00",
                "AuthTime": "2023-03-09 12:00:00",
                "EndTime": null,
                "TaskDetail": "监控到您的云服务器存在隐患，可能导致云服务器高负载或宕机。为尽快修复隐患，需要您授权我们停机处理。感谢您的支持与理解。",
                "DeviceStatus": 1,
                "OperateStatus": 1,
                "Zone": "ap-guangzhou-7",
                "Region": "ap-guangzhou",
                "VpcId": "vpc-xxxxxxxx",
                "SubnetId": "subnet-xxxxxxxx",
                "SubnetName": "Default-Subnet",
                "VpcName": "Default-VPC",
                "AuthSource": "System_mandatory_auth",
                "WanIp": "xxx.xxx.xxx.xxx",
                "LanIp": "xxx.xxx.xxx.xxx",
                "TaskTypeName": "实例运行隐患",
                "TaskSubType": null,
                "AuthType": 2,
                "Product": "CVM"
            }
        ],
        "RequestId": "4dc8d1d7-bd0f-4216-b7c5-e8a13d6a850c"
    }
}

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. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameterValue	参数取值错误。
UnauthorizedOperation	未授权操作。

查询维修任务列表

本页目录：