Domain name for API request: cdb.intl.tencentcloudapi.com.
This API is used to query the upgrade type of a database instance.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeInstanceUpgradeType. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID, which can be obtained through the DescribeDBInstances API. |
| DstCpu | Yes | Float | The number of CPU cores of the target instance. To ensure the input value is valid, please use DescribeCdbZoneConfig to get the saleable CPU range of the instance. |
| DstMemory | Yes | Integer | Target instance memory size, measurement unit: MB. To ensure the input value is valid, please use DescribeCdbZoneConfig to get the saleable memory size range of the instance. |
| DstDisk | Yes | Integer | Target instance disk size, unit: GB. To ensure the input value is valid, please use DescribeCdbZoneConfig to get the saleable disk size range of the instance. |
| DstVersion | No | String | Target instance database version. Available values: 5.6, 5.7, 8.0. |
| DstDeployMode | No | Integer | Deployment model of the target instance. Defaults to 0. Supported values include: 0 - means single availability zone, 1 - means multi-availability zone. |
| DstProtectMode | No | Integer | Replication type of the target instance. Supported values include: 0 - means async replication, 1 - means semi-sync replication, 2 - means strong sync replication. |
| DstSlaveZone | No | Integer | AZ ID of the standby instance 1 of the target instance. You can use the DescribeCdbZoneConfig API to obtain the availability zone ID. |
| DstBackupZone | No | Integer | AZ ID of the standby instance 2. You can use the DescribeCdbZoneConfig API to obtain the AZ ID. |
| DstCdbType | No | String | Target instance type. Supported values include: "CUSTOM" - general-purpose instance, "EXCLUSIVE" - dedicated instance, "ONTKE" - ONTKE single-node instance, "CLOUD_NATIVE_CLUSTER" - standard type for CLOUD disk, "CLOUD_NATIVE_CLUSTER_EXCLUSIVE" - enhanced type for CLOUD disk. |
| DstZoneId | No | Integer | Primary availability zone ID of the target instance. You can use the DescribeCdbZoneConfig API to obtain the AZ ID. |
| NodeDistribution | No | NodeDistribution | Node distribution of CDB instances in the dedicated cluster. |
| ClusterTopology | No | ClusterTopology | Topology configuration for cloud disk edition nodes. Nodeld information can be obtained through the DescribeClusterInfo API. |
| DstFourthZone | No | Integer | AZ ID of the standby instance 3 in the target instance. Use the DescribeCdbZoneConfig API to obtain the availability zone ID. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Instance ID. |
| UpgradeType | String | Instance upgrade type. Trsf - Migration upgrade, InPlace - In-place upgrade, Topology - Architecture upgrade. |
| 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. |
POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceUpgradeType
<Common request parameters>
{
"InstanceId": "cdb-2wpip1dd",
"DstCpu": 1,
"DstMemory": 1000,
"DstDisk": 200,
"DstVersion": "8.0",
"DstProtectMode": 0,
"DstDeployMode": 0,
"DstSlaveZone": 100003,
"DstBackupZone": 0,
"DstCdbType": "CUSTOM"
}
{
"Response": {
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
"InstanceId": "cdb-2wpip1dd",
"UpgradeType": "Trsf"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback