DoHealthCheckOnMigratingTopic

最后更新时间：2026-01-13 21:52:09

DoHealthCheckOnMigratingTopic

最后更新时间： 2026-01-13 21:52:09

1. API Description

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

This API is used to check whether the topics being migrated are in normal status. Only topics in normal status can enter the next migration stage.

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: DoHealthCheckOnMigratingTopic.
Version	Yes	String	Common Params. The value used for this API: 2023-03-08.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
TaskId	Yes	String	Task ID. It can be obtained from SmoothMigrationTaskItem returned by the API DescribeSmoothMigrationTaskList or from the console.
TopicName	Yes	String	Topic name. It can be obtained from MigratingTopic returned by the API DescribeMigratingTopicList in Data Type.
IgnoreCheck	No	Boolean	Whether to ignore the current check.
Namespace	No	String	Namespace. This parameter is valid only for migration to a 4.x cluster. The namespace can be obtained from MigratingTopic returned by the API DescribeMigratingTopicList in Data Type.

3. Output Parameters

Parameter Name	Type	Description
Passed	Boolean	Whether to Pass
Reason	String	Error information returned by health check. NotChecked indicates the check is not executed. Unknown error. TopicNotImported. specifies the topic is not imported. TopicNotExistsInSourceCluster specifies the topic does not exist in the source cluster. Topic does not exist in the target cluster. ConsumerConnectedOnTarget specifies whether consumer connections exist on the target cluster. SourceTopicHasNewMessagesIn5Minutes indicates that new messages were written to the source cluster topic in the last 5 minutes. TargetTopicHasNewMessagesIn5Minutes specifies whether new messages were written to the target cluster topic in the last 5 minutes. SourceTopicHasNoMessagesIn5Minutes specifies no new messages were written to the source cluster in the last 5 minutes. TargetTopicHasNoMessagesIn5Minutes specifies that no new messages were written to the source cluster in the last 5 minutes. Inconsistent number of subscription groups. SourceTopicHasUnconsumedMessages specifies that unconsumed messages exist in the source cluster topic. Note: This field may return null, indicating that no valid values can be obtained.
ReasonList	Array of String	List of error information returned by health check. Note: This field may return null, indicating that no valid values can be obtained.
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 Migration Topic Security Check

Input Example

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

{
    "TaskId": "02f6c31a-9707-4244-8dd3-35ad868ef92a",
    "TopicName": "Test",
    "IgnoreCheck": true,
    "Namespace": ""
}

Output Example

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Passed": true,
        "Reason": null,
        "ReasonList": null,
        "RequestId": "02f6c31a-9707-4244-8dd3-35ad868ef92a"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

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

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

是

否

文档反馈

tencent cloud