AddCustomAuthConnectBlack - ApsaraMQ for MQTT: Central de Documentação do Alibaba Cloud

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:AddCustomAuthConnectBlack

create

*Instance

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
InstanceId	string	Sim	O ID da instância do Message Queue for MQTT.	mqtt-cn-i7m26mf****
ClientId	string	Sim	O ID de cliente do dispositivo a ser bloqueado para conexão.	GID_test@@@test

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	82B9E503-F4A1-4F30-976F-C6999FF9****
Code	integer	O código de status. O valor 200 indica sucesso.	200
Success	boolean	Indica se a operação é bem-sucedida. Valores válidos:\n- true: A operação é bem-sucedida.\n- false: A operação falha.	True
Message	string	A mensagem retornada.	operation success.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "82B9E503-F4A1-4F30-976F-C6999FF9****",
  "Code": 200,
  "Success": true,
  "Message": "operation success."
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.	A verificação de permissão da instância falhou. Verifique a propriedade e a política de acesso da instância MQTT.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	A verificação de parâmetros falhou. Um parâmetro pode estar ausente ou conter um valor inválido.
400	Customauth.over.capacity	Over custom auth capacity.	O número de permissões personalizadas excede o limite.
404	ApiNotSupport	The specified API is not supported.	A operação atual não é suportada. Verifique a solicitação.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.