tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for Redis®
    Documentation
    Download PDF

    DescribeTaskInfo

    Last updated: 2024-04-03 11:33:14
    Download PDF

      1. API Description

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

      This API is used to get the execution of a specified task.

      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: DescribeTaskInfo.
      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.
      TaskId Yes Integer Task ID

      3. Output Parameters

      Parameter Name Type Description
      Status String Task status. Valid values:
      - preparing: To be run
      - running: Running
      - succeed: Succeeded
      - failed: Failed
      - Error: Error occurred while running
      StartTime String Task start time
      TaskType String Task type, including Create, Configure, Disable Instance, Clear Instance, Reset Password, Upgrade Version, Back up Instance, Modify Network, Migrate to New AZ and Promote to Master.
      InstanceId String Instance ID
      TaskMessage String Message returned by task execution, which will be an error message when execution fails or be empty when the status is running or succeed-.
      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 request

      This example shows you how to query the task execution results.

      Input Example

      https://redis.tencentcloudapi.com/?Action=DescribeTaskInfo
&TaskId=18215
&<Common request parameters>

      Output Example

      {
    "Response": {
        "Status": "succeed",
        "StartTime": "2018-11-01 17:25:14",
        "TaskType": "redis cache clearing process",
        "InstanceId": "crs-09u2u96z",
        "TaskMessage": "",
        "RequestId": "81120ab8-fea0-41ab-af7e-283c0348c4fc"
    }
}

      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.
      InvalidParameter.InvalidParameter Invalid service parameter.
      InvalidParameter.PermissionDenied The API has no CAM permissions.
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy