tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ConvertOperatingSystems

Last updated: 2024-10-22 19:34:09

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to switch the operating system of an instance with CentOS 7 or CentOS 8 as the source operating system.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ConvertOperatingSystems.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceIds.N Yes Array of String ID of an instance to execute operating system switching.
MinimalConversion No Boolean Whether it is a minimum scale switching.
DryRun No Boolean Whether it is pre-check only.
TargetOSType No String Target operating system type for switching. Only TencentOS is supported.

3. Output Parameters

Parameter Name Type Description
SupportTargetOSList Array of TargetOS Information about the target operating system, which is returned only when the input parameter DryRun is true.
Note: This field may return null, indicating that no valid value is found.
TaskId String Task ID for operating system switching.
Note: This field may return null, indicating that no valid value is found.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Performing Operating System Switching

This example shows you how to perform operating system switching on instance ins-6pb6lrmy.

Input Example

POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ConvertOperatingSystem
<Common request parameters>



{
    "InstanceIds": [
        "ins-6pb6lrmy"
    ]
}

Output Example

{
    "Response": {
        "SupportTargetOSList": [
            {
                "TargetOSType": "TencentOS",
                "TargetOSVersion": "2.4"
            }
        ],
        "TaskId": "12345678",
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.GetInstanceTATAgentStatusFailed Failed to obtain the status of TencentCloud Automation Tools for the instance.
InvalidInstance.NotSupported This instance is not supported.
InvalidInstanceId.NotFound No instance found.
InvalidParameter.AutoSnapshotNotSupported Automatic snapshot creation is not supported.
InvalidParameter.InvalidTargetOSType The entered TargetOSType is invalid.
InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
UnsupportedOperation.InstanceOsConvertOsNotSupport The specified instance does not support operating system switching.
UnsupportedOperation.InstanceOsWindows The instance ins-xxxxxx with the Xserver windows2012cndatacenterx86_64 operating system does not support this operation.
UnsupportedOperation.InstanceStateNotRunning The specified operation is not supported for instances that are not in the running state.
UnsupportedOperation.MarketImageConvertOSUnsupported Marketplace image instances do not support operating system switching.
UnsupportedOperation.SpecialInstanceType This special instance type does not support the operation.
UnsupportedOperation.TatAgentNotOnline The operation is not supported when TencentCloud Automation Tools are offline.
UnsupportedOperation.UserConvertOsNotSupport The specified user does not support performing operating system switching.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy