tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeFlow

Last updated: 2023-08-23 14:22:58

1. API Description

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

This API is used to query task flow information.

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: DescribeFlow.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
FlowId Yes Integer Task flow ID

3. Output Parameters

Parameter Name Type Description
Status Integer Task flow status. Valid values: 0 (succeeded), 1 (failed), 2 (Processing).
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying task flow information

Input Example

https://cynosdb.tencentcloudapi.com/?Action=DescribeFlow
&FlowId=123
&<Common request parameters>

Output Example

{
    "Response": {
        "Status": 0,
        "RequestId": "186253"
    }
}

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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FlowNotFoundError The task flow does not exist.
InternalError.DbOperationFailed Failed to query the database.
InvalidParameterValue.FlowNotFound Taskflow ID doesn’t exist.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
UnauthorizedOperation.PermissionDenied CAM authentication failed.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy