tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TencentDB for SQL Server
    Documentation
    Download PDF

    UpgradeDBInstance

    Last updated: 2023-09-18 11:41:40
    Download PDF

    1. API Description

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

    This API is used to upgrade an instance.

    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: 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.
    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.

    3. Output Parameters

    Parameter Name Type Description
    DealName String Order name
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Upgrading an instance

    Input Example

    https://sqlserver.tencentcloudapi.com/?Action=UpgradeDBInstance
&InstanceId=mssql-j8kv137v
&Memory=4
&Storage=400
&<Common request parameters>

    Output Example

    {
    "Response": {
        "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
        "DealName": "201806261980"
    }
}

    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.CreateOrderFailed Failed to create order.
    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.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy