消息队列 RocketMQ 版 平滑迁移:查询Topic迁移状态列表

1.接口描述接口请求域名:trocket.tencentcloudapi.com。查询Topic迁移状态列表。Filters字段为查询过滤器,支持以下条件:TopicName主题名称,支持模糊查询Mi。

相关产品
消息队列 RocketMQ 版 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

接口请求域名: trocket.tencentcloudapi.com 。

查询Topic迁移状态列表。

Filters字段为查询过滤器,支持以下条件:

·TopicName 主题名称,支持模糊查询

·MigrationStatus 迁移状态,可参考MigratingTopic数据结构

·Namespace 命名空间,仅4.x集群有效

Filters示例:[{ "Name": "TopicName", "Values": ["topic-a"]}]

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeMigratingTopicList。
Version 是 String 公共参数,本接口取值:2023-03-08。
Region 是 String 公共参数,详见产品支持的 地域列表。
TaskId 是 String 任务ID,可在DescribeSmoothMigrationTaskList接口返回的SmoothMigrationTaskItem或控制台中获得。示例值:02f6c31a-9707-4244-8dd3-35ad868ef92a
Limit 否 Integer 查询结果限制数量,默认20。示例值:20
Offset 否 Integer 查询起始位置,默认为0。示例值:0
Filters.N 否 Array of Filter 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。

三、3. 输出参数

参数名称 类型 描述
TotalCount Integer 查询总数示例值:10
MigrateTopics Array of MigratingTopic 主题列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、输入示例

POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMigratingTopicList
<公共请求参数>
{
"Filters": [],
"Offset": 0,
"Limit": 10,
"TaskId": "02f6c31a-9707-4244-8dd3-35ad868ef92a"
}

五、输出示例

{
"Error": null,
"RequestId": null,
"Response": {
"TotalCount": 10,
"MigrateTopics": [
{
"TopicName": "topic-a",
"MigrationStatus": "S_RW_D_NA",
"HealthCheckPassed": true,
"HealthCheckError": "",
"Namespace": "",
"FullNamespaceV4": null,
"NamespaceV4": null,
"TopicNameV4": null,
"HealthCheckErrorList": []
}
],
"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. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
ResourceNotFound.MigrationTask 迁移任务不存在,请检查后重试。
赞 (0)
上一篇 4天前
下一篇 4天前