一、1. 接口描述
创建元数据迁移上云任务
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:CreateMigrationTask。 |
| Version | 是 | String | 公共参数,本接口取值:2023-03-08。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 腾讯云 RocketMQ 实例 ID,从 DescribeFusionInstanceList 接口或控制台获得。示例值:rmq-72mo3a9o |
| Type | 是 | Integer | 0 – 未指定(存量)1 – 元数据导入示例值:1 |
| Topics.N | 否 | Array of TopicItem | 待导入的消费组列表 |
| Groups.N | 否 | Array of ConsumeGroupItem | 待导入的消费组列表 |
| Roles.N | 否 | Array of RoleItem | 待导入的角色列表示例值:role |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: trocket.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateMigrationTask
<公共请求参数>
{
"InstanceId": "rmq-xxxx",
"Type": 1,
"Topics": [],
"Groups": [
{
"InstanceId": "",
"ConsumerGroup": "iegt2i",
"ConsumeEnable": true,
"ConsumeMessageOrderly": true,
"MaxRetryTimes": 8,
"Remark": ""
},
{
"InstanceId": "",
"ConsumerGroup": "iegt1i",
"ConsumeEnable": true,
"ConsumeMessageOrderly": true,
"MaxRetryTimes": 16,
"Remark": "IEGT for Import Export Group Test"
}
]
}
五、输出示例
{
"Response": {
"RequestId": "xxxx"
}
}
六、腾讯云 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| FailedOperation | 操作失败。 |