DescribeMigrationJobs
最近更新时间: 2025-10-20 17:05:51
1. 接口描述
接口请求域名: csm.api3.fincloud.tencent.cn。
查询用户在线迁移任务列表
默认接口请求频率限制:20次/秒。
接口更新时间:2024-11-06 20:25:24。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeMigrationJobs |
| Version | 是 | 否 | String | 公共参数,本接口取值:2021-09-15 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 否 | Uint64 | 每页数量,用于分页,取值范围[1, 50]; |
| Filters | 否 | 否 | Array of Filter | 过滤条件,可选source-server-id,job-name,job-id,status,product。 |
| Offset | 否 | 否 | Uint64 | 任务起始数,用于分页。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| MigrationJobs | MigrationJob | 迁移任务列表 |
| TotalCount | Uint64 | 符合条件的迁移任务数 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.ParameterValueContainsIllegalCharacter | 无效参数值。参数值中包含非法字符。 |
| InvalidParameterValue.InvalidTaskIdFormat | 任务ID格式错误 |
| InvalidParameterValue.ParameterValueNotSupportValue | 不支持该参数值。 |
| InvalidParameterValue.InvalidSourceServerIdMalformed | 无效迁移源ID。指定的迁移源ID格式错误。 |
| InvalidParameterValue.InvalidMigrateJobIdMalformed | 无效迁移任务ID。指定的迁移任务ID格式错误。 |