DescribeIntegrateTask

下载PDF

最后更新时间：2025-11-13 20:51:13

DescribeIntegrateTask

最后更新时间： 2025-11-13 20:51:13

下载PDF

1. API Description

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

This API is used to query cluster tasks.

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: DescribeIntegrateTask.
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. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
BigDealId	No	String	Large order id. must choose between large order id and sub-order id.
DealNames.N	No	Array of String	Order list

3. Output Parameters

Parameter Name	Type	Description
CurrentStep	String	Current step.
CurrentProgress	String	Current progress.
TaskStatus	String	Indicates the task status.
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 Querying an Integration Task

Describe Integrate Task

Input Example

POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeIntegrateTask
<Common request parameters>

{
    "DealNames": [
        "20250922456021575003931"
    ]
}

Output Example

{
    "Response": {
        "CurrentProgress": "5/5",
        "CurrentStep": "FinishTask",
        "RequestId": "de351c1d-72fa-477b-997a-8ae045f90da2",
        "TaskStatus": "success"
    }
}

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

Tencent Cloud CLI 3.0

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.FlowCreateError	Failed to create a task. Try again later. If the problem persists, contact customer service.
FailedOperation.OperationFailedError	Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.DbOperationFailed	Failed to query the database.
InvalidParameterValue.InstanceNotFound	The instance does not exist.
InvalidParameterValue.ParamError	Incorrect parameter.
ResourceNotFound.InstanceNotFoundError	The instance does not exist.
ResourceNotFound.ResourceError	The resource corresponding to the parameter does not exist.
ResourceUnavailable.InstanceLockFail	Failed to lock the instance, so the operation cannot be performed temporarily.
ResourceUnavailable.InstanceStatusAbnormal	The instance is exceptional, so the operation cannot be performed temporarily.
UnauthorizedOperation.PermissionDenied	CAM authentication failed.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud