tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTaskList

Last updated: 2024-12-04 11:19:17

    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
    Limit No Integer Number of taskss returned per page. Default value: 20. Maximum value: 100.
    Offset No Integer Pagination offset, which is an integral multiple of Limit. Calculation formula: offset = limit * (page number - 1).
    ProjectIds.N No Array of Integer Project ID Log in to the Redis console, go to the account information menu in the top-right corner, and select Project Management to query the project ID.
    TaskTypes.N No Array of String Task type.



    - FLOW_CREATE: "001" - Create an instance.
    - FLOW_RESIZE: "002" - Change the configuration.
    - FLOW_CLOSE: "003" - Close an instance.
    - FLOW_CLEAN: "004" - Clear an instance.
    - FLOW_STARTUP: "005" - Enable an instance.
    - FLOW_DELETE: "006" - Delete an instance.
    - FLOW_SETPWD: "007" - Reset the password.
    - FLOW_EXPORTBACKUP: "009" - Export the backup file.
    - FLOW_RESTOREBACKUP: "010" - Restore the backup.
    - FLOW_BACKUPINSTANCE: "012" - Back up an instance.
    - FLOW_MIGRATEINSTANCE: "013" - Migrate an instance.
    - FLOW_DELBACKUP: "014" - Delete the backup.
    - FLOW_EXCHANGEINSTANCE: "016" - Switch an instance.
    - FLOW_AUTOBACKUP: "017" - Automatically backup an instance.
    - FLOW_MIGRATECHECK: "022" - Verify migration parameters.
    - FLOW_MIGRATETASK: "023" - Migrate data in progress.
    - FLOW_CLEANDB: "025" - Clear a database.
    - FLOW_CLONEBACKUP: "026" - Clone the backup.
    - FLOW_CHANGEVIP: "027" - Change the VIP.
    - FLOW_EXPORSHR: "028" - Perform scaling.
    - FLOW_ADDNODES: "029" - Add or remove a node.
    - FLOW_CHANGENET: "031" - Change the network type.
    - FLOW_MODIFYINSTACEREADONLY: "033" - Modify the read-only policy.
    - FLOW_MODIFYINSTANCEPARAMS: "034" - Modify instance parameters.
    - FLOW_MODIFYINSTANCEPASSWORDFREE: "035" - Set password-free access.
    - FLOW_SWITCHINSTANCEVIP: "036" - Switch the instance VIP.
    - FLOW_MODIFYINSTANCEACCOUNT: "037" - Modify the instance account.
    - FLOW_MODIFYINSTANCEBANDWIDTH: "038" - Modify the instance bandwidth.
    - FLOW_ENABLEINSTANCE_REPLICATE: "039" - Enable read-only replica.
    - FLOW_DISABLEINSTANCE_REPLICATE: "040" - Disable read-only replica.
    - FLOW_UpgradeArch: "041" - Upgrade the instance architecture from primary-secondary to cluster.
    - FLOW_DowngradeArch: "042" - Downgrade the instance architecture from cluster to primary-secondary.
    - FLOW_UpgradeVersion: "043" - Upgrade the version.
    - FLOW_MODIFYCONNECTIONCONFIG: "044" - Modify the number of bandwidth connections.
    - FLOW_CLEARNETWORK: "045" - Change the network.
    - FLOW_REMOVE_BACKUP_FILE: "046" - Delete the backup.
    - FLOW_UPGRADE_SUPPORT_MULTI_AZ: "047" - Upgrade an instance to support multiple AZs.
    - FLOW_SHUTDOWN_MASTER: "048" - Simulate a fault.
    - FLOW_CHANGE_REPLICA_TO_MASTER: "049" - Manually promote the replica node to the primary node.
    - FLOW_CODE_ADD_REPLICATION_INSTANCE: "050" - Add a replication group.
    - FLOW_OPEN_WAN: "052" - Enable the public network.
    - FLOW_CLOSE_WAN: "053" - Disable the public network. - FLOW_UPDATE_WAN: "054" - Update the public network.
    - FLOW_CODE_DELETE_REPLICATION_INSTANCE: "055" - Unbind the replication group.
    - FLOW_CODE_CHANGE_MASTER_INSTANCE: "056" - Switch to the primary instance in the replication group.
    - FLOW_CODE_CHANGE_INSTANCE_ROLE: "057" - Change the roles of instances in the replication group.
    - FLOW_MIGRATE_NODE: "058" - Migrate a node.
    - FLOW_SWITCH_NODE: "059" - Switch a node.
    - FLOW_UPGRADE_SMALL_VERSION: "060" - Upgrade the Redis version.
    - FLOW_UPGRADE_PROXY_VERSION: "061" - Upgrade the Proxy version.
    - FLOW_MODIFY_INSTANCE_NETWORK: "062" - Modify the instance network.
    - FLOW_MIGRATE_PROXY_NODE: "063" - Migrate the Proxy node.
    - FLOW_MIGRATION_INSTANCE_ZONE: "066" - Migrate the instance AZ in progress.
    - FLOW_UPGRADE_INSTANCE_CACHE_AND_PROXY: "067" - Upgrade the instance version in progress.
    - FLOW_MODIFY_PROXY_NUM: "069" - Add or remove a Proxy node.
    - FLOW_MODIFYBACKUPMOD: "070" - Change the instance backup mode.
    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)
    OperatorUin.N No Array of Integer The field OperatorUin has been disused and replaced by OperateUin.
    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

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy