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

Consulta um ID de cliente em uma lista negra de conexões.

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

get

*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 ApsaraMQ for MQTT.	post-111****
ClientId	string	Não	O ID do cliente a ser consultado.	GID_test@@@test
NextToken	string	Não	O token que marca a posição final da página retornada anteriormente. Para obter o próximo lote de dados, chame a operação novamente usando o valor de NextToken retornado pela solicitação anterior. Se você estiver chamando esta operação pela primeira vez ou quiser consultar todos os resultados, defina NextToken como uma string vazia.	xOfRU60sGEwN1OlFBIL8Ew==
Size	integer	Sim	O número de clientes a serem consultados. Valor máximo: 100.	100

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema da resposta.
RequestId	string	O ID da solicitação.	020F6A43-19E6-4B6E-B846-44EB31DF****
Code	integer	O código de status HTTP. O código de status 200 indica que a solicitação foi bem-sucedida. Outros códigos de status indicam que a solicitação falhou. Para obter uma lista de códigos de erro, consulte Códigos de erro.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. Valores válidos: true e false.	True
Message	string	A mensagem retornada.	operation success.
Data	object	Os dados retornados.
Results	array<object>	Os resultados retornados.
	object
ClientId	string	The client ID.	GID_TEST@@@test
Effect	string	Indicates whether to allow or deny access.	ALLOW
PermitAction	string	The authorized permissions.	CONNECT
NextToken	string	O token de paginação que é usado na próxima solicitação para recuperar uma nova página de resultados.	AAAAAZ0cM0HTqLXvgm7oMHWXcvc=

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "ClientId": "GID_TEST@@@test",
        "Effect": "ALLOW",
        "PermitAction": "CONNECT"
      }
    ],
    "NextToken": "AAAAAZ0cM0HTqLXvgm7oMHWXcvc="
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
404	ApiNotSupport	The specified API is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.