QueryCustomAuthConnectBlack - - Centre de documentation Alibaba Cloud

Consulte un identifiant de client dans une liste noire de connexions.

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

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****
ClientId	string	Non	L'identifiant du client à consulter.	GID_test@@@test
NextToken	string	Non	Le jeton qui marque la position de fin de la page précédente renvoyée. Pour obtenir le lot de données suivant, appelez à nouveau l'opération en utilisant la valeur de NextToken renvoyée par la requête précédente. Si vous appelez cette opération pour la première fois ou si vous souhaitez consulter tous les résultats, définissez NextToken sur une chaîne vide.	xOfRU60sGEwN1OlFBIL8Ew==
Size	integer	Oui	Le nombre de clients à consulter. Valeur maximale : 100.	100

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le schéma de la réponse.
RequestId	string	L'identifiant de la requête.	020F6A43-19E6-4B6E-B846-44EB31DF****
Code	integer	Le code d'état HTTP. Le code d'état 200 indique que la requête a réussi. Les autres codes d'état indiquent que la requête a échoué. Pour obtenir la liste des codes d'erreur, consultez Codes d'erreur.	200
Success	boolean	Indique si la requête a réussi. Valeurs valides : true et false.	True
Message	string	Le message renvoyé.	operation success
Data	object	Les données renvoyées.
Results	array<object>	Les résultats renvoyés.
	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	Le jeton de pagination utilisé dans la requête suivante pour récupérer une nouvelle page de résultats.	AAAAAZ0cM0HTqLXvgm7oMHWXcvc=

Exemples

JSON format

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

Codes d'erreur

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

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

Notes de version

Consultez Notes de version pour la liste complète.