UpgradePrePayOrder - Upgrade a subscription instance
This operation upgrades the configuration of a subscription instance.
API
Before you call this operation, ensure that you understand the billing methods and pricing of subscription instances. For more information, see the billing overview.
Debugging
You can call this operation in OpenAPI Explorer to simplify testing. OpenAPI Explorer automatically calculates the signature and generates sample code for different SDKs after a successful call.
Authorization information
The following table lists the authorization information for this API operation. You can add this information to the Action element of a RAM policy statement to grant a RAM user or RAM role the permissions to call this API operation.
Operation: The API operation.
Access level: The operation's access level. Valid values: Write, Read, and List.
Resource type: The resource type for which you can grant permissions. The following provides more details:
Required resource types are highlighted.
For operations that do not support resource-level authorization,
all resourcesis displayed.
Condition key: The condition keys that are defined by the cloud service.
Associated operation: Other operations that must be performed for this operation to succeed. To successfully call this operation, you must have the permissions to perform the associated operations.
Actions | Access level | Resource type | Condition key | Associated operation |
alikafka:UpgradePrePayOrder | Write | all resources * |
| None |
Request parameters
Parameter | Type | Required | Description | Example |
InstanceId | string | Yes | The instance ID. | alikafka_post-cn-mp919o4v**** |
DiskSize | integer | Yes | The disk size.
| 900 |
RegionId | string | Yes | The region ID. | cn-hangzhou |
IoMax | integer | No | The maximum traffic. We recommend using the IoMaxSpec parameter instead.
| 40 |
SpecType | string | No | The instance edition. Valid values for ApsaraMQ for Kafka instances:
Valid values for ApsaraMQ for Confluent instances:
You cannot downgrade an instance from Professional Edition to Standard Edition. For more information about these instance editions, see the billing overview. | professional |
PartitionNum | integer | No | The partition count. This parameter is recommended over TopicQuota.
| 50 |
TopicQuota | integer | No | The number of topics. We recommend using the PartitionNum parameter instead.
| 50 |
EipModel | boolean | No | Specifies whether to enable internet access. Valid values:
| true |
EipMax | integer | No | The internet traffic.
Note
| 3 |
IoMaxSpec | string | No | The traffic specification. This parameter is recommended.
| alikafka.hw.2xlarge |
ConfluentConfig | object | No | The configurations of the Confluent components. | |
KafkaCU | integer | No | The number of Kafka broker CPU cores. | 4 |
KafkaStorage | integer | No | The disk size of the Kafka broker in GB. | 800 |
KafkaReplica | integer | No | The number of replicas for the Kafka broker. | 3 |
ZooKeeperCU | integer | No | The number of ZooKeeper node CPU cores. | 2 |
ZooKeeperStorage | integer | No | The disk size of the ZooKeeper node in GB. | 100 |
ZooKeeperReplica | integer | No | The number of replicas for the ZooKeeper node. | 3 |
ControlCenterCU | integer | No | The number of Control Center node CPU cores. | 4 |
ControlCenterStorage | integer | No | The disk size of the Control Center node in GB. | 300 |
ControlCenterReplica | integer | No | The number of replicas for the Control Center node. | 1 |
SchemaRegistryCU | integer | No | The number of Schema Registry node CPU cores. | 1 |
SchemaRegistryReplica | integer | No | The number of replicas for the Schema Registry node. | 2 |
ConnectCU | integer | No | The number of Connect node CPU cores. | 4 |
ConnectReplica | integer | No | The number of replicas for the Connect node. | 2 |
KsqlCU | integer | No | The number of ksqlDB node CPU cores. | 4 |
KsqlStorage | integer | No | The disk size of the ksqlDB node in GB. | 100 |
KsqlReplica | integer | No | The number of replicas for the ksqlDB node. | 2 |
KafkaRestProxyCU | integer | No | The number of Kafka REST proxy node CPU cores. | 4 |
KafkaRestProxyReplica | integer | No | The number of replicas for the Kafka REST proxy node. | 2 |
PaidType | integer | No | The billing method. Valid values:
| 4 |
Response parameters
Parameter | Type | Description | Example |
object | |||
Code | integer | The response code. A value of | 200 |
Message | string | The response message. | operation success. |
RequestId | string | The request ID. | ABA4A7FD-E10F-45C7-9774-A5236015*** |
Success | boolean | Indicates whether the request was successful. | true |
Examples
Sample success response
JSON format
{
"Code": 200,
"Message": "operation success.",
"RequestId": "ABA4A7FD-E10F-45C7-9774-A5236015***",
"Success": true,
"OrderId": ""
}Error codes
For a list of common errors, see Common error codes.
Change history
Date | Change | Actions |
2024-08-22 | API description and error codes updated. | |
2024-08-02 | Error codes and response structure updated. | |
2024-04-16 | Error codes updated. | |
2024-04-11 | Error codes updated. | |
2024-03-20 | Error codes updated. | |
2024-02-27 | Error codes and request parameters updated. | |
2022-08-31 | Error codes updated. |