All Products
Search

This Product

    ApsaraMQ for Kafka:UpgradePrePayOrder

    Document Center

    ApsaraMQ for Kafka:UpgradePrePayOrder

    Last Updated:Mar 15, 2024

    Upgrades a Message Queue for Apache Kafka instance that uses the subscription billing method.

    Operation description

    Before you call this operation, make sure that you understand the billing method and pricing of subscription Message Queue for Apache Kafka instances. For more information, see Billing overview.

    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:UpgradePrePayOrderWrite
    • Instance
      acs:alikafka:{#regionId}:{#accountId}:instance/{#InstanceId}
    • alikafka:DeployModule
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The ID of the instance.

    		alikafka_post-cn-mp919o4v****
    DiskSizeintegerYes

    The size of the disk.

    • The disk size that you specify must be greater than or equal to the current disk size of the instance.
    • For more information about the valid values, see Billing overview.
    		900
    RegionIdstringYes

    The region ID of the instance.

    		cn-hangzhou
    IoMaxintegerNo

    The maximum traffic for the instance. We recommend that you do not configure this parameter.

    • The maximum traffic volume that you specify must be greater than or equal to the current maximum traffic volume of the instance.
    • You must configure at least one of the IoMax and IoMaxSpec parameters. If you configure both parameters, the value of the IoMaxSpec parameter takes effect. We recommend that you configure only the IoMaxSpec parameter.
    • For more information about the valid values, see Billing overview.
    		40
    SpecTypestringNo

    The edition of the instance. Valid values:

    • normal: Standard Edition (High Write)
    • professional: Professional Edition (High Write)
    • professionalForHighRead: Professional Edition (High Read)

    You cannot downgrade an instance from the Professional Edition to the Standard Edition. For more information about these instance editions, see Billing overview.

    		professional
    PartitionNumintegerNo

    The number of partitions. We recommend that you configure this parameter.

    • You must specify at least one of the PartitionNum and TopicQuota parameters. We recommend that you configure only the PartitionNum parameter.
    • If you specify both parameters, the topic-based sales model is used to check whether the PartitionNum value and the TopicQuota value are the same. If they are not the same, a failure response is returned. If they are the same, the order is placed based on the PartitionNum value.
    • For more information about the valid values, see Billing overview.
    		50
    TopicQuotaintegerNo

    The number of topics. We recommend that you do not configure this parameter.

    • You must specify at least one of the PartitionNum and TopicQuota parameters. We recommend that you configure only the PartitionNum parameter.
    • If you specify both parameters, the topic-based sales model is used to check whether the PartitionNum value and the TopicQuota value are the same. If they are not the same, a failure response is returned. If they are the same, the order is placed based on the PartitionNum value.
    • The default value of the TopicQuota parameter varies based on the value of the IoMaxSpec parameter. If the number of topics that you consume exceeds the default value, you are charged additional fees.
    • For more information about the valid values, see Billing overview.
    		50
    EipModelbooleanNo

    Specifies whether to enable Internet access for the instance. Valid values:

    • true: enables Internet access.
    • false: disables Internet access.
    		true
    EipMaxintegerNo

    The Internet traffic for the instance.

    • The Internet traffic volume that you specify must be greater than or equal to the current Internet traffic volume of the instance.
    • For more information about the valid values, see Billing overview.
    Note
  • If the EipModel parameter is set to true, set the EipMax parameter to a value that is greater than 0.
  • If the EipModel parameter is set to false, set the EipMax parameter to 0.
    •
    		3
    IoMaxSpecstringNo

    The traffic specification of the instance. We recommend that you configure this parameter.

    • The traffic specification that you specify must be greater than or equal to the current traffic specification of the instance.
    • You must configure at least one of the IoMax and IoMaxSpec parameters. If you configure both parameters, the value of the IoMaxSpec parameter takes effect. We recommend that you configure only the IoMaxSpec parameter.
    • For more information about the valid values, see Billing overview.
    		alikafka.hw.2xlarge

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codeinteger

    The HTTP status code 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 message
    400BIZ.LIMIT.PUBNETWORKEipMax is invalid.
    400BIZ.LIMIT.QUOTA.DOWNInvalid.%s
    400BIZ.LIMIT.QUOTA.DOWN.1Invalid.%s
    400BIZ.LIMIT.QUOTA.DOWN.2Invalid.%s
    400BIZ_FIELD_CHECK_INVALID%s. Please check and try again later.
    400Invalid.Partition.%sInvalid.%s

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

    Change history

    Change timeSummary of changesOperation
    2024-02-27The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ConfluentConfig
      Added Input Parameters: PaidType
    2022-08-31The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400