DescribeInstanceTasks

Last updated: 2025-10-28 22:49:10

DescribeInstanceTasks

Last updated: 2025-10-28 22:49:10

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to query the list of asynchronous tasks related to an instance.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeInstanceTasks.
Version	Yes	String	Common Params. The value used for this API: 2018-03-28.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	Yes	String	Database instance ID, in the format of mssql-njj2mtpl.
Limit	Yes	Integer	Pagination size.
Status	No	Integer	Asynchronous task status. 1 - running; 2 - running successful; 3 - running failed.
Offset	No	Integer	Pagination offset.

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of asynchronous tasks.
InstanceTaskSet	Array of InstanceTask	Asynchronous task information array.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying the List of Asynchronous Tasks

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeInstanceTasks
&InstanceId=mssql-njj2mtpl
&Status=2
&Limit=10
&Offset=0
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.DBError	Database error
InternalError.SystemError	System error.
InvalidParameter.InputIllegal	Input error.
ResourceNotFound.InstanceNotFound	The instance does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud