CreateInstance - ApsaraMQ for RocketMQ: Central de Documentação do Alibaba Cloud

Cria uma instância da série ApsaraMQ for RocketMQ 5.x.

Descrição da operação

Importante A OpenAPI fornecida pelo Alibaba Cloud é uma API de gerenciamento e controle usada para gerenciar e consultar recursos dos serviços do Alibaba Cloud. Integre-a apenas em sistemas de gerenciamento e controle. Não dependa da OpenAPI no link de dados principal para envio e recebimento de mensagens. Caso contrário, riscos podem ocorrer.

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	O token do cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não pode exceder 64 caracteres de comprimento.	c2c5d1274a8d4317a13bc5b0d4******
body	object	Não	Os parâmetros do corpo.
instanceName	string	Não	O nome da instância a ser criada.	rmq-cn-72u3048uxxx.
serviceCode	string	Sim	A codificação do serviço da instância. A codificação do serviço para MSMQ RocketMQ é rmq.	rmq.
seriesCode	string	Sim	A codificação da série primária da instância. Para obter mais informações sobre as diferenças entre as séries primárias, consulte Seleção de produtos. Valores válidos: standard : Standard Edition. ultimate : Platinum Edition. professional : Professional Edition. dedicated : Dedicated Edition. shared : Shared Edition.	standard.
subSeriesCode	string	Sim	A codificação da subsérie da instância. Para obter mais informações sobre as diferenças entre as subséries, consulte Seleção de produtos. Valores válidos: serverless : Serverless Edition. cluster_ha : Cluster high availability edition. single_node : Single-node testing edition.	cluster_ha.
paymentType	string	Sim	O tipo de pagamento da instância. O MSMQ RocketMQ suporta assinatura e pay-as-you-go. Valores válidos: PayAsYouGo : Pay-as-you-go. Um modelo de pós-pagamento no qual você usa os recursos primeiro e paga depois. Subscription : Assinatura. Um modelo de pré-pagamento no qual você paga primeiro e usa os recursos depois.	Subscription.
period	integer	Não	A duração da assinatura. Este parâmetro entra em vigor apenas quando o tipo de pagamento da instância é Subscription.	3
periodUnit	string	Não	A unidade mínima de época da duração da assinatura. Valores válidos: Month : Assinatura mensal. Year : Assinatura anual.	Month.
autoRenew	boolean	Não	Especifica se a renovação automática deve ser ativada. Este parâmetro entra em vigor apenas quando o tipo de pagamento da instância é Subscription. Valores válidos: true : Ativar renovação automática. false : Desativar renovação automática.	true.
autoRenewPeriod	integer	Não	O ciclo unificado de renovação automática. Este parâmetro entra em vigor apenas quando a renovação automática está ativada. Unidade: meses.	3
remark	string	Não	As observações da instância.	Esta é a observação para teste.
productInfo	object	Não	As informações de especificação da instância.
msgProcessSpec	string	Não	A especificação de computação para envio e recebimento de mensagens. Para obter mais informações sobre o limite superior de TPS para envio e recebimento de mensagens, consulte Especificações da instância.	rmq.s2.2xlarge.
sendReceiveRatio	number	Não	A proporção do TPS de envio de mensagens em relação ao TPS total de envio e recebimento de mensagens da instância.	0.5
autoScaling	boolean	Não	Especifica se a escalabilidade elástica expansível além da especificação deve ser ativada. Valores válidos: true : Ativar escalabilidade elástica. false : Desativar escalabilidade elástica.	true.
messageRetentionTime	integer	Não	O período de retenção de mensagens. Unidade: horas.	72
storageEncryption	boolean	Não	Indica se a criptografia de armazenamento está ativada.	false.
storageSecretKey	string	Não	A chave para criptografia de armazenamento.	xxxxx.
capacityType	string	Não	O padrão de capacidade. Valores válidos: provisioned : Provisionado + elástico. ondemand : Pay-as-you-go.	provisioned.
provisionedCapacity	integer	Não	A capacidade provisionada.	5000
traceOn	boolean	Não	Indica se o recurso de rastreamento de mensagens está ativado.	true.
drReplicationMode	string	Não	O padrão de replicação entre regiões. Valores válidos: async_cross_az : Replicação assíncrona. sync_cross_az : Replicação síncrona.	async_cross_az.
adaptiveElasticity	boolean	Não
networkInfo	object	Sim	As informações de configuração de rede.
vpcInfo	object	Sim	As informações de configuração da VPC.
vpcId	string	Sim	O ID da VPC à qual a instância está conectada. Nota Após a criação de uma instância do Message Queue for Apache RocketMQ, você não pode alterar a VPC à qual a instância está conectada. Se quiser alterar a VPC, você deve liberar a instância e adquirir uma nova.	vpc-wz9qt50xhtj9krb******
vSwitchId `deprecated`	string	Não	O ID do vSwitch ao qual a instância está conectada. Se quiser conectar a instância a vários vSwitches, separe os IDs dos vSwitches com barras verticais (\|). Nota Após a criação de uma instância do Message Queue for Apache RocketMQ, você não pode alterar o vSwitch ao qual a instância está conectada. Se quiser alterar o vSwitch, você deve liberar a instância e adquirir uma nova. Importante Este parâmetro está obsoleto. Recomendamos que você use o parâmetro `vSwitches`.	vsw-uf6gwtbn6etadpv*******
securityGroupIds	string	Não	O ID do grupo de segurança.	sg-bp17hpmgz96tvnsdy6so
vSwitches	array<object>	Não	A lista de vSwitches. Nota Após a criação de uma instância do Message Queue for Apache RocketMQ, você não pode alterar os vSwitches da instância. Se quiser alterar os vSwitches, você deve liberar a instância e adquirir uma nova. Importante Este parâmetro é obrigatório. Recomendamos que você use este parâmetro para especificar um vSwitch em vez do parâmetro obsoleto `vSwitchId`.
	object	Não	Os vSwitches.
vSwitchId	string	Não	O ID do vSwitch ao qual a instância está conectada.	vsw-uf6gwtbn6etadpv*******
internetInfo	object	Sim	As informações de configuração de rede pública.
internetSpec	string	Sim	Especifica se o acesso à Internet deve ser ativado. Por padrão, as instâncias podem ser acessadas apenas dentro de uma VPC. Se você ativar o acesso à Internet para uma instância, será cobrado pelo tráfego de Internet gerado pela instância. Para mais informações, consulte Taxas de acesso à Internet. Valores válidos: enable : Ativa o acesso à Internet. disable : Desativa o acesso à Internet.	disable
flowOutType	string	Sim	O método de cobrança para acesso à Internet. Valores válidos: payByBandwidth : Pagamento por largura de banda. Este método de cobrança está disponível apenas quando você ativa o acesso à Internet. payByTraffic : Pagamento por tráfego. Este método de cobrança está disponível apenas quando você ativa o acesso à Internet. uninvolved : Não envolvido. Este valor é usado quando você desativa o acesso à Internet.	uninvolved
flowOutBandwidth	integer	Não	A largura de banda da Internet. Unidade: Mbit/s. Este parâmetro é obrigatório apenas quando o método de cobrança para acesso à Internet é pagamento por largura de banda. Intervalo de valores: 1 a 1000.	100
ipWhitelist `deprecated`	array	Não	A lista de permissões de IP para acesso à Internet. Você pode configurar uma lista de permissões de IP apenas para endpoints públicos. Endpoints VPC não suportam este recurso. Se você não configurar uma lista de permissões de IP, todos os endereços IP terão permissão para acessar a instância do Message Queue for Apache RocketMQ pela Internet. Se você configurar uma lista de permissões de IP, apenas os endereços IP na lista poderão acessar a instância do Message Queue for Apache RocketMQ pela Internet.
	string	Não	Um endereço IP ou bloco CIDR na lista de permissões.	192.168.x.x/24
commodityCode `deprecated`	string	Não	O código da mercadoria.	ons_ rmqpost_public_cn.
resourceGroupId	string	Não	O ID do grupo de recursos.	rg-aekzy6pist7uuna.
tags	array<object>	Não	A lista de 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 autenticação a partir de endpoints de VPC deve ser permitido quando o tipo de reconhecimento inteligente de identidade é utilizado.	false.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
requestId	string	O ID da solicitação. Cada ID de solicitação é único e pode ser usado para solucionar problemas.	AF9A8B10-C426-530F-A0DD-96320B39****
success	boolean	Indica se a operação 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.