Domain name for API request: sqlserver.intl.tencentcloudapi.com.
This API is used to upgrade an 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: UpgradeDBInstance. |
| Version | Yes | String | Common Params. The value used for this API: 2018-03-28. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceId | Yes | String | Instance ID in the format of mssql-j8kv137v |
| Memory | No | Integer | Memory size after instance upgrade in GB, which cannot be smaller than the current instance memory size |
| Storage | No | Integer | Storage capacity after instance upgrade in GB, which cannot be smaller than the current instance storage capacity |
| AutoVoucher | No | Integer | Whether to automatically use vouchers. 0: no, 1: yes. Default value: 0 |
| VoucherIds.N | No | Array of String | Voucher ID (currently, only one voucher can be used per order) |
| Cpu | No | Integer | The number of CUP cores after the instance is upgraded. |
| DBVersion | No | String | Upgrade the SQL Server version. Supported versions include SQL Server 2008 Enterprise (2008R2), SQL Server 2012 Enterprise (2012SP3), etc. As the purchasable versions are region-specific, you can use the DescribeProductConfig API to query the information of purchasable versions in each region. Downgrading is unsupported. If this parameter is left empty, the SQL Server version will not be changed. |
| HAType | No | String | Upgrade the high availability architecture from image-based disaster recovery to Always On cluster disaster recovery. This parameter is valid only for instances which support Always On high availability and run SQL Server 2017 or later. Neither downgrading to image-based disaster recovery nor upgrading from cluster disaster recovery to Always On disaster recovery is supported. If this parameter is left empty, the high availability architecture will not be changed. |
| MultiZones | No | String | Change the instance deployment scheme. Valid values: SameZones (change to single-AZ deployment, which does not support cross-AZ disaster recovery), MultiZones (change to multi-AZ deployment, which supports cross-AZ disaster recovery). |
| WaitSwitch | No | Integer | The time when configuration adjustment task is performed. Valid values: 0 (execute immediately), 1 (execute during maintenance time). Default value: 1. |
| DrZones.N | No | Array of DrZoneInfo | Secondary node AZ of the multi-node architecture instance. The default value is null. It should be specified when modifying the AZ of the specified secondary node needs to be performed during configuration adjustment. When MultiZones = MultiZones, the AZs of the primary nodes and secondary nodes cannot all be the same. The collection of AZs of the secondary node can include 2-5 AZs. |
| Parameter Name | Type | Description |
|---|---|---|
| DealName | String | Order name. |
| 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. |
https://sqlserver.intl.tencentcloudapi.com/?Action=UpgradeDBInstance
&InstanceId=mssql-j8kv137v
&Memory=4
&Storage=400
&<Common request parameters>{
"Response": {
"RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
"DealName": "201806261980"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.CreateOrderFailed | Failed to create order. |
| FailedOperation.DBError | Database error. |
| FailedOperation.QueryPriceFailed | Billing error. Failed to query price. |
| InternalError.DBError | Database error |
| InternalError.SystemError | System error. |
| InvalidParameter.InputIllegal | Input error. |
| InvalidParameter.ParamsAssertFailed | An error occurred while converting parameter assertion. |
| InvalidParameter.PayOrderFailed | Failed to make order payment. |
| InvalidParameterValue.IllegalSpec | Incorrect instance specification information. |
| InvalidParameterValue.ParameterTypeError | Incorrect parameter type. |
| ResourceNotFound.InstanceNotFound | The instance does not exist. |
| UnauthorizedOperation.PermissionDenied | CAM authentication error. |
文档反馈