1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(ConvertOperatingSystem)用于转换实例的操作系统,仅支持源操作系统为 CentOS 7、CentOS 8 的实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ConvertOperatingSystems。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 是 | Array of String | 执行操作系统转换的实例 ID 示例值:["ins-xxxxxxxx"] |
MinimalConversion | 否 | Boolean | 是否最小规模转换 示例值:true |
DryRun | 否 | Boolean | 是否只预检 示例值:true |
TargetOSType | 否 | String | 转换的目标操作系统类型。仅支持 TencentOS。 示例值:TencentOS |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SupportTargetOSList | Array of TargetOS | 转换的目标操系统信息,仅在入参 DryRun 为 true 时返回。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ { "TargetOSType": "TencentOS", "TargetOSVersion": "2.4" } ] |
TaskId | String | 操作系统转换的任务 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:12345678 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 执行操作系统转换
针对实例 ins-6pb6lrmy 执行操作系统转换
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ConvertOperatingSystem
<公共请求参数>
{
"InstanceIds": [
"ins-6pb6lrmy"
]
}
输出示例
{
"Response": {
"SupportTargetOSList": [
{
"TargetOSType": "TencentOS",
"TargetOSVersion": "2.4"
}
],
"TaskId": "12345678",
"RequestId": "abc"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.GetInstanceTATAgentStatusFailed | 获取实例的自动化助手状态失败 |
InvalidInstance.NotSupported | 不被支持的实例。 |
InvalidInstanceId.NotFound | 没有找到相应实例。 |
InvalidParameter.AutoSnapshotNotSupported | 不支持自动制作快照。 |
InvalidParameter.InvalidTargetOSType | 输入的 TargetOSType 非法 |
InvalidParameterValue.InstanceIdMalformed | 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。 |
UnsupportedOperation.InstanceOsConvertOsNotSupport | 指定实例不支持操作系统转换。 |
UnsupportedOperation.InstanceOsWindows | 请求不支持操作系统为Xserver windows2012cndatacenterx86_64 的实例ins-xxxxxx 。 |
UnsupportedOperation.InstanceStateNotRunning | 指定操作不支持非运行中状态的实例。 |
UnsupportedOperation.MarketImageConvertOSUnsupported | 市场镜像实例不支持操作系统转换 |
UnsupportedOperation.SpecialInstanceType | 请求不支持特殊机型的实例 |
UnsupportedOperation.TatAgentNotOnline | 自动化助手不在线情况下,不支持该操作。 |
UnsupportedOperation.UserConvertOsNotSupport | 指定用户不支持执行操作系统转换。 |