All Products
Search
Document Center

Message Queue for Apache Kafka:CreatePrePayOrder

Last Updated:Nov 18, 2022

Creates a subscription Message Queue for Apache Kafka instance.

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 the "Billing" section in Billing overview.
  • By default, the instance created after you call this operation has a subscription duration of one month, and the auto-renewal feature is enabled. The auto-renewal cycle is also one month. If you want to modify the auto-renewal cycle or disable the auto-renewal feature, you can perform operations on the Renewal page in the Alibaba Cloud Management Console.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance.

cn-hangzhou
DiskTypestringYes

The type of the disk. Valid values:

  • 0: ultra disk
  • 1: standard SSD
0
DiskSizeintegerYes

The size of the disk. Unit: GB.

For more information about the valid values, see Billing overview.

500
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 old topic selling 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 old topic selling 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
DeployTypeintegerYes

The deployment mode of the instance. Valid values:

  • 4: deploys the instance that allows access from the Internet and a VPC.
  • 5: deploys the instance that allows access only from a VPC.
5
EipMaxintegerNo

The Internet traffic for the instance.

  • This parameter is required if the DeployType parameter is set to 4.
  • For more information about the valid values, see Pay-as-you-go.
0
SpecTypestringNo

The edition of the instance. Valid values:

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

For more information, see Billing overview.

normal
IoMaxSpecstringNo

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

  • You must configure one of the IoMax and IoMaxSpec parameters. If both parameters are configured, 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
IoMaxintegerNo

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

  • You must configure at least one of the IoMax and IoMaxSpec parameters. If both parameters are configured, 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.
20
ResourceGroupIdstringNo

The ID of the resource group to which the instances you want to query belong.

The ID of the resource group. If this parameter is left empty, the default resource group is used. You can view the resource group ID in the resource group console.

rg-ac***********7q
TagarrayNo
objectNo
KeystringYes
ValuestringNo

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

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

200
Messagestring

The returned message.

operation success.
RequestIdstring

The ID of the request.

06084011-E093-46F3-A51F-4B19A8AD****
Successboolean

Indicates whether the request is successful.

true
OrderIdstring

The ID of the order.

20497346575****

Example

Normal return example

JSONFormat

{
  "Code": 200,
  "Message": "operation success.",
  "RequestId": "06084011-E093-46F3-A51F-4B19A8AD****",
  "Success": true,
  "OrderId": "20497346575****"
}

Error codes

Http 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
400Invalid.Partition.%sInvalid.%s
400BIZ_FIELD_CHECK_INVALID%s. Please check and try again later.

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2022-11-13
Change itemChange content
2022-10-28The error codes of the API operation has changed, The input parameters of the API operation has changed
Change itemChange content
Error CodesThe error codes of the API operation has changed
    delete Error Codes: 400
Input ParametersThe input parameters of the API operation has changed
    Added Input Parameters: Tag
2022-08-31The error codes of the API operation has changed
Change itemChange content
Error CodesThe error codes of the API operation has changed
    delete Error Codes: 400