一、1. 接口描述
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：DoHealthCheckOnMigratingTopic。 |
| Version | 是 | String | 公共参数，本接口取值：2023-03-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| TaskId | 是 | String | 任务ID，可在DescribeSmoothMigrationTaskList接口返回的SmoothMigrationTaskItem或控制台中获得。示例值：02f6c31a-9707-4244-8dd3-35ad868ef92a |
| TopicName | 是 | String | 主题名称，可在DescribeMigratingTopicList接口返回的MigratingTopic数据结构中获得。示例值：topic-a |
| IgnoreCheck | 否 | Boolean | 是否忽略当前检查示例值：true |
| Namespace | 否 | String | 命名空间，仅迁移至4.x集群有效，可在DescribeMigratingTopicList接口返回的MigratingTopic数据结构中获得。示例值：ns1 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| Passed | Boolean | 是否通过 示例值：true |
| Reason | String | 健康检查返回的错误信息NotChecked 未执行检查， Unknown 未知错误, TopicNotImported 主题未导入,TopicNotExistsInSourceCluster 主题在源集群中不存在, TopicNotExistsInTargetCluster 主题在目标集群中不存在, ConsumerConnectedOnTarget 目标集群上存在消费者连接, SourceTopicHasNewMessagesIn5Minutes 源集群主题前5分钟内有新消息写入, TargetTopicHasNewMessagesIn5Minutes 目标集群主题前5分钟内有新消息写入, SourceTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, TargetTopicHasNoMessagesIn5Minutes 源集群前5分钟内没有新消息写入, ConsumerGroupCountNotMatch 订阅组数量不一致, SourceTopicHasUnconsumedMessages 源集群主题存在未消费消息。注意：此字段可能返回 null，表示取不到有效值。示例值：TopicNotExistsInTargetCluster |
| ReasonList | Array of String | 健康检查返回的错误信息列表注意：此字段可能返回 null，表示取不到有效值。示例值：["Failed"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DoHealthCheckOnMigratingTopic
<公共请求参数>
{
"TaskId": "02f6c31a-9707-4244-8dd3-35ad868ef92a",
"TopicName": "Test",
"IgnoreCheck": true,
"Namespace": ""
}
五、输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"Passed": true,
"Reason": null,
"ReasonList": null,
"RequestId": "02f6c31a-9707-4244-8dd3-35ad868ef92a"
}
}
六、腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便你从同一入口查询及使用腾讯云提供的所有 API 服务。
七、API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
八、SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。