DescribeTaskList

Download PDF

Last updated: 2025-10-28 22:21:58

DescribeTaskList

Last updated: 2025-10-28 22:21:58

Download PDF

1. API Description

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

This API is used to query the task list data for the last 30 days.

A maximum of 100 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: DescribeTaskList.
Version	Yes	String	Common Params. The value used for this API: 2018-04-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	No	String	ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.
InstanceName	No	String	Instance name. Log in to the Redis console, and copy it from the instance list.
Limit	No	Integer	Number of taskss returned per page. Default value: `20`. Maximum value: `100`.
Offset	No	Integer	Pagination offset, which is an integer multiple of Limit. Offset = Limit x (Page number – 1). The default value is 0.
TaskTypes.N	No	Array of String	Task type. - FLOW_CREATE: "001", indicating instance creation. - FLOW_RESIZE: "002", indicating configuration modification. - FLOW_CLOSE: "003", indicating instance disabling. - FLOW_CLEAN: "004", indicating instance cleanup. - FLOW_STARTUP: "005", indicating instance enabling. - FLOW_DELETE: "006", indicating instance deletion. - FLOW_SETPWD: "007", indicating password reset. - FLOW_EXPORTBACKUP: "009", indicating backup file export. - FLOW_RESTOREBACKUP: "010", indicating backup restoration. - FLOW_BACKUPINSTANCE: "012", indicating instance backup. - FLOW_MIGRATEINSTANCE: "013", indicating instance migration. - FLOW_DELBACKUP: "014", indicating backup deletion. - FLOW_EXCHANGEINSTANCE: "016", indicating instance switch. - FLOW_AUTOBACKUP: "017", indicating automatic instance backup. - FLOW_MIGRATECHECK: "022", indicating migration parameter verification. - FLOW_MIGRATETASK: "023", indicating that data migration is in progress. - FLOW_CLEANDB: "025", indicating database cleanup. - FLOW_CLONEBACKUP: "026": indicating backup cloning. - FLOW_CHANGEVIP: "027", indicating VIP address modification. - FLOW_EXPORSHR: "028", indicating scaling. - FLOW_ADDNODES: "029", indicating node addition (removal). - FLOW_CHANGENET: "031", indicating network type modification. - FLOW_MODIFYINSTACEREADONLY: "033": indicating read-only policy modification. - FLOW_MODIFYINSTANCEPARAMS: "034", indicating instance parameter modification. - FLOW_MODIFYINSTANCEPASSWORDFREE: "035", indicating password-free access settings. - FLOW_SWITCHINSTANCEVIP: "036", indicating instance VIP address switch. - FLOW_MODIFYINSTANCEACCOUNT: "037", indicating instance account modification. - FLOW_MODIFYINSTANCEBANDWIDTH: "038", indicating instance bandwidth modification. - FLOW_ENABLEINSTANCE_REPLICATE: "039", indicating enabling of read-only replica. - FLOW_DISABLEINSTANCE_REPLICATE: "040", indicating disabling of read-only replica. - FLOW_UpgradeArch: "041", indicating instance architecture upgrade from the standard architecture to the cluster architecture. - FLOW_DowngradeArch: "042", indicating instance architecture downgrade from the cluster architecture to the standard architecture. - FLOW_UpgradeVersion: "043", indicating version upgrade. - FLOW_MODIFYCONNECTIONCONFIG: "044", indicating adjustment of the bandwidth and the number of connections. - FLOW_CLEARNETWORK: "045", indicating network change. - FLOW_REMOVE_BACKUP_FILE: "046", indicating backup deletion. - FLOW_UPGRADE_SUPPORT_MULTI_AZ: "047", indicating instance upgrade to multi-AZ deployment. - FLOW_SHUTDOWN_MASTER: "048", indicating fault simulation. - FLOW_CHANGE_REPLICA_TO_MASTER: "049", indicating manual promotion to the primary node. - FLOW_CODE_ADD_REPLICATION_INSTANCE: "050", indicating replication group addition. - FLOW_OPEN_WAN: "052", indicating enabling of public network access. - FLOW_CLOSE_WAN: "053", indicating disabling of public network access. - FLOW_UPDATE_WAN: "054", indicating update of the public network access configuration. - FLOW_CODE_DELETE_REPLICATION_INSTANCE: "055", indicating replication group unbinding. - FLOW_CODE_CHANGE_MASTER_INSTANCE: "056", indicating switching a replication group instance to the primary instance. - FLOW_CODE_CHANGE_INSTANCE_ROLE: "057", indicating modification of the replication group instance role. - FLOW_MIGRATE_NODE: "058", indicating node migration. - FLOW_SWITCH_NODE: "059", indicating node switch. - FLOW_UPGRADE_SMALL_VERSION: "060", indicating Redis version upgrade. - FLOW_UPGRADE_PROXY_VERSION: "061", indicating proxy version upgrade. - FLOW_MODIFY_INSTANCE_NETWORK: "062", indicating instance network modification. - FLOW_MIGRATE_PROXY_NODE: "063", indicating proxy node migration. - FLOW_MIGRATION_INSTANCE_ZONE: "066", indicating that instance migration to another AZ is in progress. - FLOW_UPGRADE_INSTANCE_CACHE_AND_PROXY: "067", indicating that instance version upgrade is in progress. - FLOW_MODIFY_PROXY_NUM: "069", indicating proxy node addition (removal). - FLOW_MODIFYBACKUPMOD: "070", indicating instance backup mode modification.
BeginTime	No	String	Start time of the task, for example, in the format of 2021-12-30 00:00:00. Data in the last 30 days can be queried.
EndTime	No	String	End time of the task, for example, in the format of 2021-12-30 20:59:35. Data in the last 30 days can be queried.
TaskStatus.N	No	Array of Integer	This parameter is only for internal use and can be ignored.
Result.N	No	Array of Integer	Task execution status. Valid values: - `0` (initilized) - `1` (executing) - `2` (completed) - `4` (failed)
OperateUin.N	No	Array of String	Operator account ID or UIN

3. Output Parameters

Parameter Name	Type	Description
TotalCount	Integer	Total number of tasks
Tasks	Array of TaskInfoDetail	Task details
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 Sample

This example shows you how to query the task details of an instance.

Input Example

POST / HTTP/1.1Host: redis.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeTaskList<Common request parameters>{    "InstanceId": "crs-opcazbrb"}

Output Example

{
    "Response": {
        "RequestId": "19a7fb07-8e21-4827-88dd-fee57f38e8cd",
        "Tasks": [
            {
                "EndTime": "2019-11-15 14:25:46",
                "InstanceId": "crs-opcazbrb",
                "InstanceName": "multidbccbugfix11153",
                "Progress": 1,
                "ProjectId": 0,
                "Result": 2,
                "StartTime": "2019-11-15 14:25:37",
                "TaskId": 42372,
                "TaskType": "037"
            },
            {
                "EndTime": "2019-11-15 14:25:25",
                "InstanceId": "crs-opcazbrb",
                "InstanceName": "multidbccbugfix11153",
                "Progress": 1,
                "ProjectId": 0,
                "Result": 2,
                "StartTime": "2019-11-15 14:25:16",
                "TaskId": 42371,
                "TaskType": "037"
            }
        ],
        "TotalCount": 2
    }
}

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
FailedOperation.SystemError	Internal system error, which is irrelevant to the business.
InternalError.DbOperationFailed	Internal system error with the database operation, which may be update, insert, select, etc.
InternalError.InternalError	Internal error.
InvalidParameter.PermissionDenied	The API has no CAM permissions.

Was this page helpful?

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

Yes

Feedback

tencent cloud