TencentDB for Redis®
- Release Notes and Announcements
- Product Introduction
- Product Series
- Purchase Guide
- Getting Started
- Operation Guide
- Access Management
- SDK Connection
- Daily Instance Operation
- Upgrading Redis Edition Instances
- Managing Redis Edition Nodes
- Multi-AZ Deployment Management
- Backup and Restoration
- Downloading Redis Edition Backups
- Data Migration for Redis Edition Instances
- Account and Password (Redis Edition)
- Parameter Configuration
- Redis Parameter Operations
- Network and Security
- Monitoring and Alarms
- Redis Edition Event Management
- Global Replication for Redis Edition
- Performance Optimization
- Development Guidelines
- Connection Pool Configuration
- Command Reference
- Commands Supported by Different Versions
- Additional Command Operations in the Redis Edition
- Troubleshooting
- Connection Exception
- Performance Troubleshooting and Fine-Tuning
- Practical Tutorial
- API Documentation
- Making API Requests
- Instance APIs
- Parameter Management APIs
- Other APIs
- Backup and Restoration APIs
- Monitoring and Management APIs
- Service Agreement
DescribeTaskInfo
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 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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| TaskId | Yes | Integer | Task ID, which can be obtained through the sub-parameter TaskId of the response parameter Tasks of the API DescribeTaskList. |
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.intl.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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No