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

Consulta a autenticação de identidade personalizada.

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

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****
Username	string	Não	O nome de usuário.	test
IdentityType	string	Não	O tipo de identidade.	USER
ClientId	string	Não	O ID de cliente do dispositivo. Você pode especificar este parâmetro quando o tipo de identidade for CLIENT.	GID_test@@@test
NextToken	string	Não	O token que marca a posição final da consulta atual. Você pode passar este token como um parâmetro na próxima chamada para continuar a paginação. Se esta for a primeira chamada ou a última página for retornada, o valor será uma string vazia.	eyJhY2NvdW50IjoiMTM4MTcxODk3NDQzMjQ1OSIsImV2ZW50SWQiOiJGMkUxOUE3QS1FM0Q0LTVCOEYtQkU4OS1CNkMyM0RBM0UyRjIiLCJsb2dJZCI6IjY2LTEzODE3MTg5NzQ0MzI0NTkiLCJydyI6IlciLCJ0aW1lIjoxNjc4MzI2MTI1MDAwfQ
Size	integer	Sim	O número de entradas a serem consultadas. Valor máximo: 100.	100

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	11568B5B-13A8-4E72-9DBA-3A14F7D3****
Code	integer	O código de resposta. 200: A solicitação foi bem-sucedida. Outros códigos indicam erros. Para obter mais informações sobre códigos de erro, consulte Códigos de erro.	200
Success	boolean	Indica se a solicitação foi bem-sucedida. true: A solicitação foi bem-sucedida. false: A solicitação falhou.	True
Message	string	As informações adicionais.	operation success.
Data	object	O resultado da consulta.
Results	array<object>	Os dados retornados.
	object	Os dados retornados.
Username	string	The username.	test
Secret	string	The secret key.	62a5916d71767185b48907d85c2efa****
IdentityType	string	The identity type. USER: Username only. CLIENT: Specific to a client.	USER
ClientId	string	The client ID of the device when the identity type is CLIENT.	GID_ICP@@@4d378084
SignMode	string	The signature verification mode. ORIGIN: Original value comparison, which compares the password with the secret. SIGNED: The HmacSHA1 signature is calculated for the clientId using the secret for verification, and then the password is compared.	SIGNED
NextToken	string	Se mais resultados estiverem disponíveis, um NextToken será retornado.	AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "11568B5B-13A8-4E72-9DBA-3A14F7D3****",
  "Code": 200,
  "Success": true,
  "Message": "operation success.",
  "Data": {
    "Results": [
      {
        "Username": "test",
        "Secret": "62a5916d71767185b48907d85c2efa****",
        "IdentityType": "USER",
        "ClientId": "GID_ICP@@@4d378084",
        "SignMode": "SIGNED"
      }
    ],
    "NextToken": "AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
400	InstancePermissionCheckFailed	An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.
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.