1. API Description
Domain name for API request: mariadb.tencentcloudapi.com.
This API is used to query flow status.
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.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
| Parameter Name |
Required |
Type |
Description |
| Action |
Yes |
String |
Common parameter. The value used for this API: DescribeFlow. |
| Version |
Yes |
String |
Common parameter. The value used for this API: 2017-03-12. |
| Region |
Yes |
String |
Common parameter. For more information, please see the list of regions supported by the product. |
| FlowId |
Yes |
Integer |
Flow ID returned by async request API. |
3. Output Parameters
| Parameter Name |
Type |
Description |
| Status |
Integer |
Flow status. 0: succeeded, 1: failed, 2: running |
| RequestId |
String |
The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Querying task execution status
https:
&FlowId=3340
&<Common request parameters>
Output Example
{
"Response": {
"RequestId": "f63a9e3a-cfe9-4fa3-a690-9671ebdf6bd8",
"Status": 1
}
}
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 |
| InternalError.CamAuthFailed |
CAM authentication request failed. |
| InternalError.DbOperationFailed |
Failed to query the database. |
| InvalidParameter.FlowNotFound |
The specified flow information was not found. |
| InvalidParameter.GenericParameterError |
An error occurred while verifying parameter validity. |
| UnauthorizedOperation.PermissionDenied |
You have no permission to manipulate this API or resource. |