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

Consulta os clientes que solicitaram credenciais de acesso no modo de autenticação de certificado único por dispositivo em uma instância do ApsaraMQ for MQTT.

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

list

*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 Cloud Message Queue for MQTT, que deve corresponder ao ID real da instância usado pelo cliente. Você pode obter esse ID na página Detalhes da instância no console.	mqtt-xxxxxxxx
GroupId	string	Sim	O ID do grupo do Cloud Message Queue for MQTT.	GID_xxx
PageNo	string	Não	Indica o número da página dos resultados retornados. A página inicial é contada a partir de 1.	1
PageSize	string	Sim	O número máximo de registros de consulta a serem exibidos por página. Intervalo de valores: 1 a 100.	100
NextToken	string	Não	O token para iniciar a consulta da próxima página.	FFdXXXXXWa

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	Parâmetro público. Cada ID de solicitação é único e pode ser usado para solução e localização de problemas.	020F6A43-19E6-4B6E-B846-44EB31DF****
DeviceCredentialClientIdList	object	Retorna a lista de informações.
Total	string	O número total de resultados da consulta.	10
ClientIdList	array	A lista de clientes.
	string	O ID do cliente.	GID_test@@@pub-1
PageNo	string	O número da página atual dos registros de consulta retornados.	1
PageSize	string	O número máximo de resultados a serem exibidos por página.	100
NextToken	string	Indica se há um token para a próxima consulta. Valores válidos: Para a primeira consulta e quando não houver próxima consulta, este campo não precisa ser preenchido. Se houver uma próxima consulta, o valor deve ser o NextToken retornado da chamada de API anterior.	634dxxxxx75b5f

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
  "DeviceCredentialClientIdList": {
    "Total": "10",
    "ClientIdList": [
      "GID_test@@@pub-1"
    ],
    "PageNo": "1",
    "PageSize": "100",
    "NextToken": "634dxxxxx75b5f"
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	ApplyTokenOverFlow	You have applied for tokens too many times. Please try again later.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.
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	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.
400	PermissionCheckFailed	An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
400	DeviceCredentialNotFound	Device Credential Not Found.Check if the device certificate is registered.
400	DeviceCredentialNumExceed	The number of device credentia exceeds the limit. Please revoke unused device certificates.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.
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.