一、1. 接口描述
修改迁移任务名
默认接口请求频率限制:20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数,本接口取值:ModifyMigrateName。 |
| Version | 是 | String | 公共参数,本接口取值:2021-12-06。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| JobId | 是 | String | 迁移任务id,可通过DescribeMigrationJobs接口获取。示例值:dts-7itt1j4w |
| JobName | 是 | String | 修改后的迁移任务名示例值:userDefine |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: dts.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMigrateName
<公共请求参数>
{
"JobName": "userDefine",
"JobId": "dts-7itt1j4w"
}
五、输出示例
{
"Response": {
"RequestId": "14a719b5-ffb34ab6-816c43c1-8c6a23eb"
}
}
六、腾讯云 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
| AuthFailure.AuthFailureError | 认证失败。 |
| DryRunOperation.DryRunOperationError | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
| FailedOperation.FailedOperationError | 操作失败。 |
| InternalError.InternalErrorError | 内部错误。 |
| InvalidParameter.InvalidParameterError | 参数无效。 |
| InvalidParameterValue.InvalidParameterValueError | 非法参数。 |
| LimitExceeded.LimitExceededError | 数量超出限制。 |
| MissingParameter.MissingParameterError | 参数丢失。 |
| OperationDenied.OperationDeniedError | 操作被拒绝。 |
| RequestLimitExceeded.RequestLimitExceededError | 请求次数超限。 |
| ResourceInUse.ResourceInUseError | 资源在使用中。 |
| ResourceInsufficient.ResourceInsufficientError | 资源短缺。 |
| ResourceNotFound.JobNotExist | 迁移任务不存在。 |
| ResourceNotFound.ResourceNotFoundError | 资源未找到。 |
| ResourceUnavailable.ResourceUnavailableError | 资源不可用。 |
| ResourcesSoldOut.ResourcesSoldOutError | 资源售罄。 |
| UnauthorizedOperation.UnauthorizedOperationError | 未授权的操作。 |
| UnknownParameter.UnknownParameterError | 未知参数。 |
| UnsupportedOperation.UnsupportedOperationError | 不支持的操作。 |