PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for Redis
    Documentation
    Download PDF

    UpgradeInstance

    Last updated: 2021-03-19 16:50:36
    Download PDF

    1. API Description

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

    This API is used to upgrade an instance.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: UpgradeInstance.
    Version Yes String Common parameter. The value used for this API: 2018-04-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID
    MemSize Yes Integer Shard size in MB
    RedisShardNum No Integer Number of shards. This parameter can be left blank for Redis 2.8 primary-secondary edition, CKV primary-secondary edition, and Redis 2.8 standalone edition
    RedisReplicasNum No Integer Number of replicas. This parameter can be left blank for Redis 2.8 primary-secondary edition, CKV primary-secondary edition, and Redis 2.8 standalone edition
    NodeSet.N No Array of RedisNodeInfo The information of the replica to be added to a multi-AZ instance, such as replica availability zone and replica type (NodeType should be 1). This parameter is required only when multi-AZ instances add replicas.

    3. Output Parameters

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

    4. Example

    Example1 Sample request

    Input Example

    https://redis.tencentcloudapi.com/?Action=UpgradeInstance
&InstanceId=crs-5qlrlhux
&MemSize=4096
&<Common request parameters>

    Output Example

    {
  "Response": {
    "DealId": "6954227",
    "RequestId": "4daddc97-0005-45d8-b5b8-38514ec1e97c"
  }
}

    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.SystemError Internal system error, which is irrelevant to the business.
    InvalidParameter.PermissionDenied The API has no CAM permissions.
    InvalidParameterValue.MemSizeNotInRange The requested capacity is out of the purchasable capacity range.
    InvalidParameterValue.ReduceCapacityNotAllowed The request capacity is too small. Capacity reduction is not supported.
    InvalidParameterValue.SpecNotExist The instance specification does not exist.
    LimitExceeded.InvalidMemSize The requested capacity is out of the purchasable specification range (memSize should be an integer multiple of 1,024 in MB).
    ResourceNotFound.InstanceNotExists No Redis instance is found by the serialId.
    ResourceUnavailable.AccountBalanceNotEnough The request order number does not exist.
    ResourceUnavailable.InstanceStatusAbnormal The Redis status is exceptional, and the corresponding process cannot be executed.
    ResourceUnavailable.InstanceStatusError Operation unsupported: the instance is exceptional.
    UnauthorizedOperation.NoCAMAuthed No CAM permissions.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy