云数据库 SQL Server 查询异步任务列表-API 文档-文档中心-腾讯云

1. 接口描述

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

本接口（DescribeInstanceTasks）用于查询实例相关的异步任务列表。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceTasks。
Version	是	String	公共参数，本接口取值：2018-03-28。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	数据库实例ID，形如mssql-njj2mtpl 示例值：mssql-njj2mtpl
Limit	是	Integer	分页大小示例值：10
Status	否	Integer	异步任务状态 1-运行中，2-运行成功，3-运行失败示例值：2
Offset	否	Integer	分页偏移量示例值：0

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	异步任务总条数示例值：21
InstanceTaskSet	Array of InstanceTask	异步任务信息数组
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询异步任务列表

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeInstanceTasks
&InstanceId=mssql-njj2mtpl
&Status=2
&Limit=10
&Offset=0
&<公共请求参数>

输出示例

{
    "Response": {
        "InstanceTaskSet": [
            {
                "EndTime": "2019-08-15 14:26:22",
                "ErrorCode": 0,
                "Id": 23517,
                "Message": "",
                "Progress": 100,
                "StartTime": "2019-08-15 14:25:20",
                "Status": 2,
                "Type": 62
            }
        ],
        "RequestId": "c736ff8a-5e23-4549-b9fb-6d79d11586ac",
        "TotalCount": 21
    }
}

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.DBError	数据库错误。
InternalError.SystemError	系统错误。
InvalidParameter.InputIllegal	输入错误。
ResourceNotFound.InstanceNotFound	实例不存在。
UnauthorizedOperation.PermissionDenied	cam鉴权错误。

查询异步任务列表

本页目录：