QueryCustomAuthIdentity - - Centre de documentation Alibaba Cloud

Consulte l'authentification d'identité personnalisée.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

mq:QueryCustomAuthIdentity

get

*Instance

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance ApsaraMQ for MQTT.	post-111****
Username	string	Non	Le nom d'utilisateur.	test
IdentityType	string	Non	Le type d'identité.	USER
ClientId	string	Non	L'identifiant client de l'appareil. Vous pouvez spécifier ce paramètre lorsque le type d'identité est CLIENT.	GID_test@@@test
NextToken	string	Non	Le jeton qui marque la position de fin de la requête en cours. Vous pouvez transmettre ce jeton en tant que paramètre lors du prochain appel pour continuer la pagination. S'il s'agit du premier appel ou si la dernière page est renvoyée, la valeur est une chaîne vide.	eyJhY2NvdW50IjoiMTM4MTcxODk3NDQzMjQ1OSIsImV2ZW50SWQiOiJGMkUxOUE3QS1FM0Q0LTVCOEYtQkU4OS1CNkMyM0RBM0UyRjIiLCJsb2dJZCI6IjY2LTEzODE3MTg5NzQ0MzI0NTkiLCJydyI6IlciLCJ0aW1lIjoxNjc4MzI2MTI1MDAwfQ
Size	integer	Oui	Le nombre d'entrées à interroger. Valeur maximale : 100.	100

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
RequestId	string	L'identifiant de la requête.	11568B5B-13A8-4E72-9DBA-3A14F7D3****
Code	integer	Le code de réponse. 200 : la requête a réussi. Les autres codes indiquent des erreurs. Pour plus d'informations sur les codes d'erreur, consultez Codes d'erreur.	200
Success	boolean	Indique si la requête a réussi. true : la requête a réussi. false : la requête a échoué.	True
Message	string	Les informations supplémentaires.	Opération réussie
Data	object	Le résultat de la requête.
Results	array<object>	Les données renvoyées.
	object	Les données renvoyées.
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	Si d'autres résultats sont disponibles, un NextToken est renvoyé.	AAAAAXA+GzVqTutYpgkFjBrchKzuvSbpuTqtt6OF9tsC9QnJ

Exemples

JSON format

{
  "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"
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
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.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.