tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
云数据库 Redis®
    文档
    Download PDF

    DescribeTaskList

    最后更新时间：2024-04-03 11:33:13
    下载PDF

      1. API Description

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

      This API is used to query the task list information of a specified instance.

      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 No String Common Params. This parameter is not required for this API.
      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. Valid values: - FLOW_CREATE: Create an instance. - FLOW_MODIFYCONNECTIONCONFIG: Adjust the number of bandwidth connections. - FLOW_MODIFYINSTANCEPASSWORDFREE: Modify the process of password-free access. - FLOW_CLEARNETWORK: Returning VPC - FLOW_SETPWD: Set the access password. - FLOW_EXPORSHR: Expand or reduce the capacity. - FLOW_UpgradeArch: Upgrade the instance architecture. - FLOW_MODIFYINSTANCEPARAMS: Modify the instance parameters. - FLOW_MODIFYINSTACEREADONLY: Modify read-only process. - FLOW_CLOSE: Disable the instance. - FLOW_DELETE: Delete the instance. - FLOW_OPEN_WAN: Enable the public network. - FLOW_FLOW_CLEAN: Clear the instance. - FLOW_MODIFYINSTANCEACCOUNT: Modify the instance account. - FLOW_ENABLEINSTANCE_REPLICATE: Enable the replica read-only feature. - FLOW_DISABLEINSTANCE_REPLICATE: Disable the replica read-only feature. - FLOW_SWITCHINSTANCEVIP: Swap the VIPs of instances. - FLOW_CHANGE_REPLICA_TO_MSTER: Promote the replica node to the mater node. - FLOW_BACKUPINSTANCE: Back up an instance.
      BeginTime No String Start time for executing a task, in the format of “2020-10-12 00:00:00”.
      EndTime No String End time for executing a task, in the format of “2021-12-30 20:59:35”.
      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.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.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款