All Products
Search

This Product

    ApsaraMQ for Kafka:UpgradePostPayOrder

    Document Center

    ApsaraMQ for Kafka:UpgradePostPayOrder

    Last Updated:Apr 12, 2024

    Upgrades a pay-as-you-go ApsaraMQ for Kafka instance.

    Operation description

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

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The instance ID.

    		alikafka_post-cn-mp919o4v****
    DiskSizeintegerNo

    The disk size. Unit: GB.

    • The disk size that you specify must be greater than or equal to the current disk size of the instance.
    • For information about the valid values of this parameter, see Billing .
    Note When you create an ApsaraMQ for Kafka V3 serverless instance, you do not need to configure this parameter.
    		500
    RegionIdstringYes

    The region ID of the instance.

    		cn-hangzhou
    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 IoMax and IoMaxSpec. If you configure both parameters, the value of IoMaxSpec takes effect. We recommend that you configure only IoMaxSpec.
    • For information about the valid values of this parameter, see Billing .
    Note When you create an ApsaraMQ for Kafka V3 serverless instance, you do not need to configure this parameter.
    		alikafka.hw.6xlarge
    IoMaxintegerNo

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

    • The maximum traffic that you specify must be greater than or equal to the current maximum traffic of the instance.
    • You must configure at least one of IoMax and IoMaxSpec. If you configure both parameters, the value of IoMaxSpec takes effect. We recommend that you configure only IoMaxSpec.
    • For information about the valid values of this parameter, see Billing .
    Note When you create an ApsaraMQ for Kafka V3 serverless instance, you do not need to configure this parameter.
    		60
    SpecTypestringNo

    The instance edition.

    Valid values for this parameter if you set PaidType to 1:

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

    Valid values for this parameter if you set PaidType to 3:

    • normal: Serverless Standard Edition
    • professional: Serverless Professional Edition

    For more information, see Billing .

    		professional
    PartitionNumintegerNo

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

    • You must configure one of PartitionNum and TopicQuota. We recommend that you configure only ParittionNum.
    • If you configure PartitionNum and TopicQuota at the same time, the system verifies whether the price of the partitions equals the price of the topics based on the previous topic-based selling mode. If the price of the partitions does not equal the price of the topics, an error is returned. If the price of the partitions equals the price of the topics, the instance is purchased based on the partition number.
    • For information about the valid values of this parameter, see Billing .
    Note When you create an ApsaraMQ for Kafka V3 serverless instance, you do not need to configure this parameter.
    		80
    TopicQuotaintegerNo

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

    • You must configure one of PartitionNum and TopicQuota. We recommend that you configure only ParittionNum.
    • If you configure PartitionNum and TopicQuota at the same time, the system verifies whether the price of the partitions equals the price of the topics based on the previous topic-based selling mode. If the price of the partitions does not equal the price of the topics, an error is returned. If the price of the partitions equals the price of the topics, the instance is purchased based on the partition number.
    • The default value of TopicQuota varies based on the value of IoMaxSpec. If the number of topics that you consume exceeds the default value, you are charged additional fees.
    • For information about the valid values of this parameter, see Billing .
    Note When you create an ApsaraMQ for Kafka V3 serverless instance, you do not need to configure this parameter.
    		80
    EipModelbooleanNo

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

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

    The Internet traffic for the instance.

    • The Internet traffic that you specify must be greater than or equal to the current Internet traffic of the instance.
    • For information about the valid values of this parameter, see Billing .
    Note

    • If you set EipModel to true, set EipMax to a value that is greater than 0.

    • If you set EipModel to false, set EipMax to 0.

    • When you create an ApsaraMQ for Kafka V3 serverless instance, you do not need to configure this parameter.

    		0
    ServerlessConfigobjectNo

    The parameters configured for the Serverless instance. When you create an ApsaraMQ for Kafka V3 serverless instance, you must configure these parameters.

    ReservedPublishCapacitylongNo

    The traffic reserved for message publishing. Unit: MB/s. Valid values: 1 to 31457280. You can specify only integers for this parameter.

    		50
    ReservedSubscribeCapacitylongNo

    The traffic reserved for message subscription. Unit: MB/s. Valid values: 1 to 31457280. You can specify only integers for this parameter.

    		50

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codeinteger

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

    		200
    Messagestring

    The message returned.

    		operation success.
    RequestIdstring

    The ID of the request.

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

    Indicates whether the request is successful.

    		true

    Examples

    Sample success responses

    JSONformat

    {
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015A***",
  "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-04-11The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 500
    2024-03-20The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Added Error Codes: 404
    2024-02-26The 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: ServerlessConfig
    2022-08-31The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400