All Products
Search

This Product

    ApsaraMQ for Kafka:UpgradeInstanceVersion

    Document Center

    ApsaraMQ for Kafka:UpgradeInstanceVersion

    Last Updated:Apr 12, 2024

    Updates the version of an instance.

    Operation description

    Permissions

    A RAM user must be granted the required permissions before the RAM user calls the UpgradeInstanceVersion operation. For information about how to grant permissions, see RAM policies.

    APIActionResource
    UpgradeInstanceVersionUpdateInstanceacs:alikafka:::{instanceId}

    QPS limits

    You can send a maximum of two queries per second (QPS).

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    alikafka:UpdateInstanceWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		alikafka_post-cn-v0h1fgs2****
    TargetVersionstringYes

    The major version to be upgraded to. Valid values:

    • 0.10.2
    • 2.2.0

    If you set this parameter to the current major version, the system upgrades the instance to the latest minor version.

    		0.10.2
    RegionIdstringYes

    The ID of the region where the instance resides.

    		cn-hangzhou

    Description of the TargetVersion parameter

    Major version before the upgradeMinor version before the upgradeMajor version to be upgraded toMajor version after the upgradeMinor version after the upgrade
    0.10.2Not the latest minor version0.10.20.10.2The latest minor version
    0.10.2Not the latest minor version2.2.02.2.0The latest minor version
    0.10.2The latest minor version2.2.02.2.0The latest minor version
    2.2.0Not the latest minor version2.2.02.2.0The latest minor version

    For more information about how to upgrade the minor version of an instance, see Upgrade the instance version.

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codeinteger

    The HTTP status code that is returned. The HTTP status code 200 indicates that the request is successful.

    		200
    Messagestring

    The error message returned.

    		operation success.
    RequestIdstring

    The ID of the request.

    		ABA4A7FD-E10F-45C7-9774-A5236015***
    Successboolean

    Indicates whether the request is successful.

    		true

    Examples

    Sample success responses

    JSONformat

    {
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015***",
  "Success": true
}

    Error codes

    HTTP status codeError codeError messageDescription
    400MissingParameterThe %s parameter is required.-
    400InvalidParameterThe %s parameter is invalid.-
    400Instance.StatusNotRunningThe instance is not running and cannot operate this function. Please try again later.The instance is not running and cannot operate this function. Please try again later.
    400Instance.UpgradeService.versionUpgrade version failed, please try again later.Upgrade version failed, please try again later.
    400AsyncTask.TypeAlreadyExistThe task already exists.The task already exists.
    400AsyncTask.ExecuteTimeNotSupportThe task cannot be modified because it is close to its execution time. Please adjust and try again.The task cannot be modified because it is close to its execution time. Please adjust and try again.
    404Instance.NotFoundThe instance does not exist. Please verify the entry and try again.The instance does not exist. Please verify the entry and try again.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-03-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400
      Added Error Codes: 404