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

Descrição da operação

Importante A OpenAPI do Alibaba Cloud é uma API de gerenciamento. Você pode usá-la para gerenciar e consultar recursos de serviço do Alibaba Cloud. Integre esta API apenas para fins de gerenciamento. Não use esta API para links de dados principais para enviar e receber mensagens, pois isso pode introduzir ameaças à segurança.

Esta operação é normalmente usada para criar um novo grupo para implantar novos aplicativos ou implementar lógica de negócios.

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

mq:CreateGroup

create

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

Nenhuma

mq:QueryInstanceBaseInfo

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	string	Sim	O ID do grupo de consumidores que você deseja criar. O valor deve atender aos seguintes requisitos: O valor deve ter de 2 a 64 caracteres e pode conter apenas letras, dígitos, hifens (-) e sublinhados (_). Se a instância para a qual você deseja criar o grupo tiver um namespace, o ID do grupo deverá ser exclusivo dentro da instância. Ele não pode ser igual a um ID de grupo ou nome de tópico existente na instância. Os IDs de grupo podem ser iguais em diferentes instâncias. Por exemplo, um ID de grupo na Instância A pode ser igual a um ID de grupo ou a um nome de tópico na Instância B. Se a instância para a qual você deseja criar o grupo não tiver um namespace, o ID do grupo deverá ser globalmente exclusivo em todas as instâncias e regiões. Ele não pode ser igual a nenhum ID de grupo ou nome de tópico existente. Nota O ID do grupo não pode ser alterado após a criação do grupo. Para verificar se uma instância possui um namespace, acesse a seção Informações básicas na página Detalhes da instância no console do ApsaraMQ for RocketMQ.	GID_test_groupId
Remark	string	Não	As observações sobre o grupo.	test
InstanceId	string	Não	O ID da instância à qual o grupo pertence.	MQ_INST_111111111111_DOxxxxxx
GroupType	string	Não	O protocolo ao qual o ID do grupo se aplica. Os IDs de grupo para os protocolos TCP e HTTP não podem ser usados de forma intercambiável. Crie um ID de grupo separado para cada protocolo. Valores válidos: tcp: este é o valor padrão. O ID de grupo criado aplica-se apenas ao envio e recebimento de mensagens pelo protocolo TCP. http: o ID de grupo criado aplica-se apenas ao envio e recebimento de mensagens pelo protocolo HTTP.	tcp

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
RequestId	string	Um parâmetro comum. O ID da solicitação é exclusivo para cada solicitação. Use este ID para solucionar e localizar problemas.	A07E3902-B92E-44A6-B6C5-6AA111111****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	%s	%s, please check and retry later
400	Group.NumLimited	group count exceed limit.	The number of gid exceeds the limit.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.