Todos os produtos
Search

Este produto

    ApsaraMQ for RocketMQ:CreateInstance

    Central de documentação

    ApsaraMQ for RocketMQ:CreateInstance

    Última atualização: Jun 28, 2026

    Cria uma instância do ApsaraMQ for RocketMQ 5.x.

    Descrição da operação

    Importante

    A OpenAPI da Alibaba Cloud é uma API de gerenciamento para gerenciar e consultar seus recursos. Ela é destinada apenas à integração com o plano de gerenciamento. Para evitar instabilidade, não use a OpenAPI para transporte de mensagens em links de dados principais.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    rocketmq:CreateInstance

    create

    *Instance

    acs:rocketmq:{#regionId}:{#accountId}:Instance/*
    • rocketmq:InternetSpec
    		 Nenhuma

    Sintaxe da solicitação

    POST /instances HTTP/1.1

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    clientToken

    string

    Não

    Um token gerado pelo cliente para garantir a idempotência da solicitação. O token deve ser único para cada solicitação e pode conter até 64 caracteres ASCII.

    c2c5d1274a8d4317a13bc5b0d4******
    body

    object

    Não

    O corpo da solicitação.

    instanceName

    string

    Não

    O nome da instância. Se você não especificar este parâmetro, o ID da instância será usado como nome.

    Se deixado em branco, o ID da instância será usado como nome da instância.

    rmq-cn-72u3048uxxx
    serviceCode

    string

    Sim

    O código de serviço da instância. Para o Message Queue for Apache RocketMQ, o código de serviço é rmq.

    rmq
    seriesCode

    string

    Sim

    A edição principal da instância. Para mais informações sobre as diferenças entre as edições principais, consulte Seleção de produto.

    Importante

    Após a criação de uma instância, você só pode fazer upgrade da edição, não downgrade. O caminho de upgrade é: Standard Edition > Professional Edition > Platinum Edition.

    Valores válidos:

    • standard :

      Standard Edition.

    • ultimate :

      Platinum Edition.

    • professional :

      Professional Edition.

    standard
    subSeriesCode

    string

    Sim

    A sub-edição da instância. Para mais informações sobre as diferenças entre as sub-edições, consulte Seleção de produto.

    Se você definir o parâmetro seriesCode como ultimate (Platinum Edition), este parâmetro só pode ser definido como cluster_ha (High-availability Cluster Edition).

    Importante Após a criação de uma instância, você não pode alterar sua sub-edição.

    Valores válidos:

    • serverless :

      Serverless Edition.

    • cluster_ha :

      High-availability Cluster Edition.

    • single_node :

      Single-node Testing Edition.

    cluster_ha
    paymentType

    string

    Sim

    O método de cobrança da instância. O Message Queue for Apache RocketMQ suporta assinatura e pagamento conforme o uso.

    Para mais informações, consulte Métodos de cobrança.

    Valores válidos:

    • PayAsYouGo :

      Pagamento conforme o uso. Este é um modo pós-pago no qual você é cobrado pelo uso real.

    • Subscription :

      Assinatura. Este é um modo pré-pago no qual você paga antecipadamente por uma duração de assinatura.

    Subscription
    period

    integer

    Não

    A duração da assinatura. Este parâmetro é obrigatório apenas se você definir o parâmetro paymentType como Subscription.

    Valores válidos:

    • Se periodUnit for definido como Month, os valores válidos são 1, 2, 3, 4, 5 e 6.

    • Se periodUnit for definido como Year, os valores válidos são 1, 2 e 3.

    3
    periodUnit

    string

    Não

    A unidade da duração da assinatura.

    Valores válidos:

    • Month :

      A duração da assinatura é especificada em meses.

    • Year :

      A duração da assinatura é especificada em anos.

    Month
    autoRenew

    boolean

    Não

    Especifica se a renovação automática deve ser ativada para a instância. Este parâmetro é válido apenas para instâncias de assinatura.

    Valores válidos:

    • true :

      Ativa a renovação automática.

    • false :

      Desativa a renovação automática.

    true
    autoRenewPeriod

    integer

    Não

    O período de renovação automática. Este parâmetro é válido apenas se a renovação automática estiver ativada. Unidade: meses.

    Valores válidos:

    • 1, 2, 3, 6 e 12.

    3
    remark

    string

    Não

    As observações sobre a instância.

    This is the remark for test.
    productInfo

    object

    Não

    As especificações da instância.

    msgProcessSpec

    string

    Não

    A especificação de computação para envio e recebimento de mensagens. Para informações sobre os limites de TPS para envio e recebimento de mensagens, consulte Especificações da instância.

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    Não

    A proporção de TPS para envio de mensagens em relação ao TPS total da instância.

    Por exemplo, se o limite de TPS de uma instância for 1.000 e a proporção for 0,8, o limite de TPS para envio de mensagens será 800 e o limite de TPS para recebimento de mensagens será 200.

    O valor deste parâmetro deve ser um decimal entre 0,05 e 0,95. Valor padrão: 0,5.

    0.5
    autoScaling

    boolean

    Não

    Especifica se o TPS elástico deve ser ativado para a instância.

    Se você ativar este recurso, a instância poderá processar mais mensagens do que o número especificado pelas especificações básicas. Você será cobrado pelo TPS extra. Para mais informações, consulte Taxas de computação.

    Nota

    Este recurso é suportado apenas por edições específicas de instância. Para mais informações, consulte Especificações da instância.

    Valores válidos:

    • true :

      Ativa o TPS elástico.

    • false :

      Desativa o TPS elástico.

    true
    messageRetentionTime

    integer

    Não

    O período de retenção de mensagens. Unidade: horas.

    Para informações sobre o intervalo de valores, consulte a seção "Período de retenção de mensagens" no tópico Limites.

    O Message Queue for Apache RocketMQ fornece armazenamento de mensagens serverless que é cobrado com base no uso real. Você pode ajustar o período de retenção de mensagens para gerenciar a capacidade de armazenamento. Para mais informações, consulte Taxas de armazenamento.

    72
    storageEncryption

    boolean

    Não

    Especifica se a criptografia de armazenamento deve ser ativada.

    false
    storageSecretKey

    string

    Não

    A chave usada para criptografia de armazenamento.

    xxxxx
    capacityType

    string

    Não

    O modo de capacidade.

    Valores válidos:

    • provisioned :

      Reservado + Elástico.

    • ondemand :

      Pagamento conforme o uso.

    provisioned
    provisionedCapacity

    integer

    Não

    A capacidade reservada.

    5000
    traceOn

    boolean

    Não

    Especifica se o recurso de rastreamento de mensagens deve ser ativado. Valores válidos:

    Este parâmetro é válido apenas para instâncias serverless. Se você ativar o recurso de rastreamento de mensagens, será cobrado pelo recurso. Para mais informações, consulte Cobrança de instâncias serverless. Para instâncias de pagamento conforme o uso e de assinatura, este parâmetro não tem efeito. O recurso de rastreamento de mensagens é ativado por padrão para essas instâncias.

    true
    drReplicationMode

    string

    Não

    O modo de replicação entre zonas.

    Valores válidos:

    • async_cross_az :

      replicação assíncrona.

    • sync_cross_az :

      replicação síncrona.

    async_cross_az
    networkInfo

    object

    Sim

    As configurações de rede.

    vpcInfo

    object

    Sim

    As configurações da virtual private cloud (VPC).

    vpcId

    string

    Sim

    The ID of the VPC to which the instance is connected.

    Nota

    After a Message Queue for Apache RocketMQ instance is created, you cannot change the VPC to which the instance is connected. If you want to change the VPC, you must release the instance and purchase a new one.

    vpc-wz9qt50xhtj9krb******
    vSwitchId deprecated

    string

    Não

    The ID of the vSwitch to which the instance is connected. If you want to connect the instance to multiple vSwitches, separate the vSwitch IDs with vertical bars (|).

    Nota

    After a Message Queue for Apache RocketMQ instance is created, you cannot change the vSwitch to which the instance is connected. If you want to change the vSwitch, you must release the instance and purchase a new one.

    Importante

    This parameter is deprecated. We recommend that you use the vSwitches parameter.

    vsw-uf6gwtbn6etadpv*******
    securityGroupIds

    string

    Não

    The ID of the security group.

    sg-bp17hpmgz96tvnsdy6so
    vSwitches

    array<object>

    Não

    The list of vSwitches.

    Nota

    After a Message Queue for Apache RocketMQ instance is created, you cannot change the vSwitches for the instance. If you want to change the vSwitches, you must release the instance and purchase a new one.

    Importante

    This parameter is required. We recommend that you use this parameter to specify a vSwitch instead of the deprecated vSwitchId parameter.

    object

    Não

    The vSwitches.

    vSwitchId

    string

    Não

    The ID of the vSwitch to which the instance is connected.

    vsw-uf6gwtbn6etadpv*******
    internetInfo

    object

    Sim

    As configurações de acesso à Internet.

    internetSpec

    string

    Sim

    Specifies whether to enable Internet access.

    By default, instances can be accessed only within a VPC. If you enable Internet access for an instance, you are charged for Internet traffic that is generated by the instance. For more information, see Internet access fees.

    Valores válidos:

    • enable :

      Enables Internet access.

    • disable :

      Disables Internet access.

    disable
    flowOutType

    string

    Sim

    The billing method for Internet access.

    Valores válidos:

    • payByBandwidth :

      pay-by-bandwidth. This billing method is available only when you enable Internet access.

    • payByTraffic :

      pay-by-traffic. This billing method is available only when you enable Internet access.

    • uninvolved :

      not involved. This value is used when you disable Internet access.

    uninvolved
    flowOutBandwidth

    integer

    Não

    The Internet bandwidth. Unit: Mbit/s.

    This parameter is required only when the billing method for Internet access is pay-by-bandwidth.

    Value range: 1 to 1000.

    100
    ipWhitelist deprecated

    array

    Não

    The IP address whitelist for Internet access. You can configure an IP address whitelist only for public endpoints. VPC endpoints do not support this feature.

    • If you do not configure an IP address whitelist, all IP addresses are allowed to access the Message Queue for Apache RocketMQ instance over the Internet.

    • If you configure an IP address whitelist, only the IP addresses in the whitelist can access the Message Queue for Apache RocketMQ instance over the Internet.

    string

    Não

    An IP address or CIDR block in the whitelist.

    192.168.x.x/24
    commodityCode deprecated

    string

    Não

    O código de commodity.

    • ons_rmqpost_public_intl: instância de pagamento conforme o uso

    • ons_rmqsub_public_intl: instância de assinatura

    • ons_rmqsrvlesspost_public_intl: instância serverless

    ons_ rmqpost_public_cn
    resourceGroupId

    string

    Não

    O ID do grupo de recursos.

    rg-aekzy6pist7uuna
    tags

    array<object>

    Não

    As tags de recurso.

    object

    Não

    A tag de recurso.

    key

    string

    Não

    A chave da tag de recurso.

    xxxKey
    value

    string

    Não

    O valor da tag de recurso.

    xxxValue
    aclInfo

    object

    Não

    As informações de controle de acesso.

    defaultVpcAuthFree

    boolean

    Não

    Especifica se o acesso sem senha à instância dentro da VPC deve ser ativado usando reconhecimento inteligente de identidade.

    • true: Ativa o acesso sem senha.

    • false: Desativa o acesso sem senha.

    false

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os dados retornados.

    requestId

    string

    O ID da solicitação. Este parâmetro é um parâmetro comum. Cada solicitação possui um ID único. Você pode usar este ID para solucionar problemas.

    AF9A8B10-C426-530F-A0DD-96320B39****
    success

    boolean

    Indica se a chamada foi bem-sucedida.

    true
    data

    string

    O ID da instância criada.

    rmq-cn-7e22ody****
    code

    string

    O código de erro.

    200
    message

    string

    A mensagem de erro.

    Success
    httpStatusCode

    integer

    O código de status HTTP.

    200
    dynamicCode

    string

    O código de erro dinâmico.

    InstanceId
    dynamicMessage

    string

    A mensagem de erro dinâmica.

    instanceId

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "requestId": "AF9A8B10-C426-530F-A0DD-96320B39****",
  "success": true,
  "data": "rmq-cn-7e22ody****",
  "code": "200",
  "message": "Success",
  "httpStatusCode": 200,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    Códigos de erro

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.