DescribeUpgradeInstanceCheck

Last updated: 2025-10-28 22:49:09

DescribeUpgradeInstanceCheck

Last updated: 2025-10-28 22:49:09

1. API Description

Domain name for API request: sqlserver.intl.tencentcloudapi.com.

This API is used to pre-check the impact of the instance configuration adjustment before the adjustment.

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: DescribeUpgradeInstanceCheck.
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	Database instance ID, in the format of mssql-njj2mtpl.
Cpu	No	Integer	Number of CPU cores after instance configuration adjustment. If it is left blank, no modification is required.
Memory	No	Integer	Memory size after instance configuration adjustment, in GB. If it is left blank, no modification is required.
Storage	No	Integer	Disk size after instance configuration adjustment, in GB. If it is left blank, no modification is required.
DBVersion	No	String	Instance version. If it is left blank, no modification is required.
HAType	No	String	Type after instance configuration adjustment. Valid values: CLUSTER - cluster. If it is left blank, no modification is required.
MultiZones	No	String	Cross-AZ type after instance configuration adjustment. Valid values: SameZones - change to the same AZ; MultiZones - change to cross-AZ. If it is left blank, no modification is required.
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.

3. Output Parameters

Parameter Name	Type	Description
IsAffect	Integer	Whether the configuration adjustment has an impact on the instance. 0 - no; 1 - yes.
Passed	Integer	Whether the configuration adjustment can be executed. 0 - no; 1 - yes.
ModifyMode	String	Whether the configuration adjustment is a downgrade or an upgrade. Down - downgrade; up - upgrade.
CheckItems	Array of CheckItem	Check item list.
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 Checking Instance Configuration Adjustment

Input Example

https://sqlserver.intl.tencentcloudapi.com/?Action=DescribeUpgradeInstanceCheck
&InstanceId=mssql-30vft2ix
&Cpu=2
&Memory=16
&Storage=256
&DBVersion=2017
&HAType=CLUSTER
&MultiZones=SameZones
&<Common request parameters>

Output Example

{
    "Response": {
        "CheckItems": [
            {
                "CheckName": "CK_CPU",
                "CurrentValue": "0",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_MASTER_STORAGE",
                "CurrentValue": "",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_MEMORY",
                "CurrentValue": "0",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_STORAGE",
                "CurrentValue": "0",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_UPGRATE",
                "CurrentValue": "MIGRATE",
                "IsAffect": 1,
                "Msg": "version 2008 -> 2017 upgrade requires data migration",
                "MsgCode": 5,
                "Passed": 1
            }
        ],
        "IsAffect": 1,
        "ModifyMode": "up",
        "Passed": 1,
        "RequestId": "44416ab3-794e-47e2-840c-f645efc3481c"
    }
}

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

Tencent Cloud CLI 3.0

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.QueryPriceFailed	Billing error. Failed to query price.
InternalError.DBError	Database error
InternalError.SystemError	System error.
InvalidParameter.InputIllegal	Input error.
InvalidParameter.NotSupportPubSubInstance	Instances with publish-subscribe relationships are not supported.
InvalidParameter.NotSupportReadOnlyMasterInstance	Primary instances with read-only replicas are not supported.
InvalidParameter.NotSupportSingleInstance	Single-node edition (basic edition or RO replica) instances are not supported.
InvalidParameter.ParamsAssertFailed	An error occurred while converting parameter assertion.
InvalidParameterValue.IllegalSpec	Incorrect instance specification information.
ResourceNotFound.InstanceNotFound	The instance does not exist.
UnauthorizedOperation.PermissionDenied	CAM authentication error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud