1. 接口描述
接口请求域名: tdmq.tencentcloudapi.com 。
用于获取RocketMQ平滑迁移任务详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRocketMQSmoothMigrationTask。 |
Version | 是 | String | 公共参数,本接口取值:2020-02-17。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TaskId | 是 | String | 任务ID |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskName | String | 任务名称 |
ClusterId | String | 目标集群ID |
SourceClusterName | String | 源集群名称 |
ConnectionType | String | 网络连接类型, PUBLIC 公网 VPC 私有网络 OTHER 其它 |
SourceClusterNameServer | String | 源集群NameServer地址 注意:此字段可能返回 null,表示取不到有效值。 |
VpcId | String | 源集群所在私有网络ID 注意:此字段可能返回 null,表示取不到有效值。 |
SubnetId | String | 源集群所在子网ID 注意:此字段可能返回 null,表示取不到有效值。 |
EnableACL | Boolean | 是否开启ACL |
AccessKey | String | 源集群AccessKey 注意:此字段可能返回 null,表示取不到有效值。 |
SecretKey | String | 元集群SecretKey 注意:此字段可能返回 null,表示取不到有效值。 |
TaskError | String | 配置源集群时发生的错误 TIMEOUT 连接超时, SERVER_ERROR 服务错误, INTERNAL_ERROR 内部错误, CONNECT_NAMESERVER_ERROR 连接nameserver错误 CONNECT_BROKER_ERROR 连接broker错误 ACL_WRONG ACL信息不正确 注意:此字段可能返回 null,表示取不到有效值。 |
TaskStatus | String | 任务状态 Configuration 迁移配置 SourceConnecting 连接源集群中 SourceConnectionFailure 连接源集群失败 MetaDataImport 元数据导入 EndpointSetup 切换接入点 ServiceMigration 切流中 Completed 已完成 Cancelled 已取消 |
TaskId | String | 任务ID |
TopicTypeDistribution | Array of RocketMQTopicDistribution | 主题类型分布情况 注意:此字段可能返回 null,表示取不到有效值。 |
TopicStageDistribution | Array of RocketMQMigrationTopicDistribution | 主题迁移进度分布情况 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询迁移任务详情
查询迁移任务详情
输入示例
POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRocketMQSmoothMigrationTask
<公共请求参数>
{
"TaskId": "700000780519-o4n3m5g97wgr-3391d15d"
}
输出示例
{
"Error": null,
"RequestId": null,
"Response": {
"AccessKey": "",
"ClusterId": "rocketmq-o4n3m5g97wgr",
"ConnectionType": "PUBLIC",
"EnableACL": false,
"RequestId": "62a5410a-3d9b-486a-98fb-8cb23eb89072",
"SecretKey": "",
"SourceClusterName": "abcdfe",
"SourceClusterNameServer": "222.212.253.122:9876",
"SubnetId": "",
"TaskError": null,
"TaskId": "700000780519-o4n3m5g97wgr-3391d15d",
"TaskName": "mm-demo3",
"TaskStatus": "ServiceMigration",
"TopicStageDistribution": [
{
"Count": 1,
"Stage": "S_RW_D_NA"
},
{
"Count": 1,
"Stage": "S_RW_D_R"
},
{
"Count": 0,
"Stage": "S_RW_D_RW"
},
{
"Count": 1,
"Stage": "S_R_D_RW"
},
{
"Count": 0,
"Stage": "S_NA_D_RW"
}
],
"TopicTypeDistribution": [
{
"Count": 3,
"TopicType": "Normal"
},
{
"Count": 0,
"TopicType": "PartitionedOrder"
},
{
"Count": 0,
"TopicType": "Transaction"
},
{
"Count": 0,
"TopicType": "DelayScheduled"
},
{
"Count": 0,
"TopicType": "Retry"
},
{
"Count": 0,
"TopicType": "DeadLetter"
}
],
"VpcId": ""
}
}
5. 开发者资源
腾讯云 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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
ResourceNotFound.MigrationTask | 迁移任务不存在。 |