GetGatewayAuthConsumerDetail - - Centre de documentation Alibaba Cloud

Consulte les détails du consommateur sur lequel une passerelle effectue des opérations d'authentification.

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.

mse:GetGatewayAuthConsumerDetail

get

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
GatewayUniqueId	string	Oui	L'identifiant unique de la passerelle.	gw-1a4ab101d5924b6f92c5ec98a84*****
Id	integer	Oui	L'identifiant du consommateur.	120
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : zh : chinois en : anglais	zh

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les paramètres de réponse.
RequestId	string	L'identifiant de la requête.	316F5F64-F73D-42DC-8632-01E308B6****
Success	boolean	Indique si la requête a réussi. Valeurs valides : `true` : la requête a réussi. `false` : la requête a échoué.	true
Code	integer	Le code d'état. La valeur 200 est renvoyée si la requête réussit.	200
ErrorCode	string	Le code d'erreur renvoyé.	mse-100-000
HttpStatusCode	integer	Le code d'état HTTP renvoyé.	200
Message	string	Le message d'erreur renvoyé.	La requête a été traitée avec succès
DynamicCode	string	La partie dynamique du message d'erreur.	code
DynamicMessage	string	La partie dynamique du message d'erreur. Ce paramètre est utilisé pour remplacer la variable %s dans le paramètre ErrMessage. Remarque Si la valeur renvoyée du paramètre ErrMessage est La valeur du paramètre d'entrée %s n'est pas valide et que la valeur renvoyée du paramètre DynamicMessage est DtsJobId, le paramètre DtsJobId spécifié n'est pas valide.	Le paramètre spécifié n'est pas valide
Data	object	Les données renvoyées.
Id	integer	L'identifiant du consommateur.	12
Name	string	Le nom du consommateur.	test
ConsumerStatus	boolean	L'état du consommateur. Valeurs valides : true : activé false : désactivé	true
PrimaryUser	string	Le créateur.	123
GatewayUniqueId	string	L'identifiant unique de la passerelle.	gw-7ea3da97b96543e19f6c597cd4a9****
Type	string	Le type d'authentification. Valeurs valides : JWT	JWT
GmtCreate	string	L'heure à laquelle l'enregistrement d'authentification du consommateur a été créé.	2031-03-30 02:35:12
GmtModified	string	L'heure à laquelle l'enregistrement d'authentification du consommateur a été modifié.	2023-02-01 14:17:57
Description	string	La description.	Description
EncodeType	string	Le type de chiffrement. Valeurs valides : RSA OCT	RSA
Jwks	string	La clé publique JWT. Le format JSON est pris en charge.	{ "keys": [ { "e": "AQAB", "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ", "kty": "RSA", "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ" } ] }
TokenName	string	Les noms des paramètres requis pour vérifier chaque jeton. Par défaut, chaque jeton est préfixé par Bearer et stocké dans l'en-tête Authorization, par exemple `Authorization: Bearer <Contenu d'un jeton>`.	Authorization
TokenPass	boolean	Indique si la transmission transparente doit être activée.	true
TokenPosition	string	Les positions des paramètres requis pour vérifier chaque jeton. Par défaut, chaque jeton est préfixé par Bearer et stocké dans l'en-tête Authorization, par exemple `Authorization: Bearer <Contenu d'un jeton>`.	HEADER
TokenPrefix	string	Les préfixes des paramètres requis pour vérifier chaque jeton. Par défaut, chaque jeton est préfixé par Bearer et stocké dans l'en-tête Authorization, par exemple `Authorization: Bearer <Contenu d'un jeton>`.	Bearer
KeyName	string	Le nom de la clé utilisée pour l'authentification d'identité basée sur JWT.	iss
KeyValue	string	La valeur de la clé utilisée pour l'authentification d'identité basée sur JWT.	abcd
ResourceList	array<object>	La liste des ressources.
	object	La liste des ressources.
Id	integer	The ID of the authorized resource for the consumer.	16
ConsumerId	integer	The consumer ID.	123
RouteId	integer	The ID of the route.	3458
RouteName	string	The name of the route.	test
ResourceStatus	boolean	The resource authorization state. Valid values: true: Resource authorization is enabled. false: Resource authorization is disabled.	true
GatewayUniqueId	string	The unique ID of the gateway.	gw-4822033a8513496fa10f05c934f*****
GmtCreate	string	The time when the resource associated with the consumer authentication record was created.	2022-12-06 01:38:03
GmtModified	string	The time when the resource associated with the consumer authentication record was modified.	2022-12-06 01:38:03

Exemples

JSON format

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "Success": true,
  "Code": 200,
  "ErrorCode": "mse-100-000",
  "HttpStatusCode": 200,
  "Message": "The request is processed successfully.",
  "DynamicCode": "code",
  "DynamicMessage": "The specified parameter is invalid.",
  "Data": {
    "Id": 12,
    "Name": "test",
    "ConsumerStatus": true,
    "PrimaryUser": "123",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597cd4a9****",
    "Type": "JWT",
    "GmtCreate": "2023-02-01 14:17:57",
    "GmtModified": "2023-03-01 14:17:57",
    "Description": "Description",
    "EncodeType": "RSA",
    "Jwks": "{\n      \"keys\": [\n            {\n                  \"e\": \"AQAB\",\n                  \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n                  \"kty\": \"RSA\",\n                  \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n            }\n      ]\n}",
    "TokenName": "Authorization",
    "TokenPass": true,
    "TokenPosition": "HEADER",
    "TokenPrefix": "Bearer ",
    "KeyName": "iss",
    "KeyValue": "abcd",
    "ResourceList": [
      {
        "Id": 16,
        "ConsumerId": 123,
        "RouteId": 3458,
        "RouteName": "test",
        "ResourceStatus": true,
        "GatewayUniqueId": "gw-4822033a8513496fa10f05c934f*****",
        "GmtCreate": "2022-12-06 01:38:03",
        "GmtModified": "2022-12-06 01:38:03"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

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

Notes de version

Consultez Notes de version pour la liste complète.