Todos os produtos
Search
Central de documentação

:CreateInstance

Última atualização: Jul 04, 2026

Cria uma instância do ApsaraMQ for RabbitMQ.

Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

CreateInstance

Operação a ser executada. Defina o valor como CreateInstance.

ClientToken

String

Não

c2c5d1274axxxxxxxx

Token do cliente.

PaymentType

String

Sim

Subscription

Método de faturamento da instância. Valores válidos:

  • Subscription: faturamento por assinatura.

  • PayAsYouGo: pagamento conforme o uso.

Period

Integer

Não

1

Período de assinatura. A unidade desse período é definida pelo parâmetro PeriodCycle.

Nota

Parâmetro válido apenas se PaymentType for definido como Subscription. Valor padrão: 1.

PeriodCycle

String

Não

Month

Unidade do período de assinatura. Valores válidos:

  • Month

  • Year

Parâmetro válido apenas se PaymentType for definido como Subscription. Valor padrão: Month.

AutoRenew

Boolean

Não

false

Defina se a renovação automática está ativada. Valores válidos:

  • true: ative a renovação automática.

  • false: desativa a renovação automática. Nesse caso, renove a instância manualmente.

AutoRenewPeriod

Integer

Não

1

Período de renovação automática. A unidade desse período é definida pelo parâmetro RenewalDurationUnit. Valor padrão: Month.

Nota

Parâmetro válido apenas se AutoRenew for definido como true. Valor padrão: 1.

RenewStatus

String

Não

false

Status de renovação. Equivalente ao parâmetro AutoRenew. Configure apenas um deles. Valor válido:

  • AutoRenewal

Nota

Se ambos os parâmetros forem configurados, o valor de RenewStatus prevalecerá.

RenewalDurationUnit

String

Não

Month

Unidade do período de renovação automática. Valores válidos:

  • Month

  • Year

InstanceType

String

Não

professional

Edição da instância.

Edições disponíveis para instâncias por assinatura:

  • professional: Professional Edition.

  • enterprise: Enterprise Edition.

  • vip: Enterprise Platinum Edition.

Para instâncias com pagamento conforme o uso, não configure este parâmetro.

ServerlessChargeType

String

Não

onDemand

Método de faturamento da instância com pagamento conforme o uso. Valores válidos:

  • onDemand: cobrança baseada no uso real.

InstanceName

String

Não

amqp-xxxxx

Nome da instância. Especifique um nome com até 64 caracteres.

MaxPrivateTps

Long

Não

1000

Número máximo de transações por segundo (TPS) via Virtual Private Cloud (VPC) na instância.

Configure este parâmetro conforme os valores disponíveis na página de compra do ApsaraMQ for RocketMQ.

SupportEip

Boolean

Não

true

Defina se há suporte para Elastic IP (EIP). Valores válidos:

  • True

  • False

MaxEipTps

Long

Não

128

Número máximo de TPS via EIP na instância.

Configure este parâmetro conforme os valores disponíveis na página de compra do ApsaraMQ for RocketMQ.

QueueCapacity

Integer

Não

1000

Quantidade de filas na instância.

Configure este parâmetro conforme os valores disponíveis na página de compra do ApsaraMQ for RocketMQ.

MaxConnections

Integer

Não

50000

Número máximo de conexões simultâneas à instância.

Configure este parâmetro conforme os valores disponíveis na página de compra do ApsaraMQ for RocketMQ.

StorageSize

Integer

Não

7

Capacidade de armazenamento. Unidade: GB. Valores válidos:

  • Instâncias Professional Edition e Enterprise Edition: defina como 0.

Nota

O valor 0 indica que o espaço de armazenamento está disponível sem custo adicional.

  • Instâncias Enterprise Platinum Edition: defina como um múltiplo inteiro de 100, variando de 7 a 28.

SupportTracing

Boolean

Não

true

Defina se o rastreamento de mensagens está ativado. Valores válidos:

  • true

  • false

Nota
  • Instâncias Enterprise Platinum Edition retêm rastreamentos de mensagens por 15 dias gratuitamente. Nessa edição, defina este parâmetro como true e TracingStorageTime como 15.

  • Nas demais edições, defina este parâmetro como true ou false.

TracingStorageTime

Integer

Não

3

Período de retenção de mensagens. Unidade: dias. Valores válidos:

  • 3

  • 7

  • 15

Parâmetro válido apenas se SupportTracing for definido como true.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

CCBB1225-C392-480E-8C7F-D09AB2CD2***

ID da solicitação. Utilize-o para solucionar problemas. Parâmetro comum.

Code

Integer

200

Código de resposta. O valor 200 indica sucesso na solicitação.

Message

String

xxx failed,xxxx

Mensagem retornada.

Data

Any

amqp-cn-xxxxx

ID da instância criada.

Success

Boolean

true

Indica se a solicitação foi bem-sucedida.

Exemplos

Parâmetros para instâncias por assinatura

Ao definir PaymentType como Subscription para uma instância do ApsaraMQ for RabbitMQ, configure os seguintes parâmetros:

&PaymentType=Subscription
&AutoRenew=true
&AutoRenewPeriod=1
&Period=1
&PeriodCycle=Month
&InstanceType=professional
&MaxPrivateTps=1000
&SupportEip=true
&MaxEipTps=128
&QueueCapacity=1000
&MaxConnections=50000
&StorageSize=7
&SupportTracing=true
&TracingStorageTime=3
&Common request parameters

A tabela a seguir descreve os limites de rastreamento de mensagens para instâncias do ApsaraMQ for RabbitMQ por assinatura.

InstanceType

SupportTracing

TracingStorageTime

  • professional

  • enterprise

false

0

  • professional

  • enterprise

true

  • 3

  • 7

  • 15

vip

true

15

Parâmetros para instâncias serverless

Ao definir PaymentType como PayAsYouGo para uma instância serverless do ApsaraMQ for RabbitMQ, configure os seguintes parâmetros:

&PaymentType=PayAsYouGo
&ServerlessChargeType=onDemand
&SupportEip=true
&SupportTracing=true
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateInstanceResponse>
    <RequestId>CCBB1225-C392-480E-8C7F-D09AB2CD2***</RequestId>
    <Code>200</Code>
    <Message>xxx failed,xxxx</Message>
    <Data>amqp-cn-xxxxx</Data>
    <Success>true</Success>
</CreateInstanceResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CCBB1225-C392-480E-8C7F-D09AB2CD2***",
  "Code" : 200,
  "Message" : "xxx failed,xxxx",
  "Data" : "amqp-cn-xxxxx",
  "Success" : true
}

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.