GetInstanceADAuthServer - - Centre de documentation Alibaba Cloud

Consulte les configurations d'authentification Active Directory (AD) d'une instance Bastionhost.

Description de l'opération

Remarques sur l'utilisation

Cette opération consulte les configurations d'authentification Active Directory (AD) d'une instance Bastionhost. Vous pouvez utiliser la fonctionnalité d'authentification AD de Bastionhost pour synchroniser les utilisateurs d'un serveur AD vers Bastionhost. Une fois la synchronisation terminée, les utilisateurs peuvent effectuer des opérations d'exploitation et de maintenance sur les serveurs via Bastionhost. Pour les opérations gérées au niveau de l'entreprise, vous pouvez également vous référer aux services gérés d'Alibaba Cloud.

Limites de QPS

La limite de requêtes par seconde (QPS) pour cette opération est de 10 par utilisateur. Si le nombre d'appels d'API dépasse cette limite, une limitation du débit est déclenchée, ce qui peut affecter votre activité. Appelez cette opération à une fréquence raisonnable.

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.

yundun-bastionhost:GetInstanceADAuthServer

get

*Instance.

acs:yundun-bastionhost:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance Bastionhost. Remarque Vous pouvez appeler l'opération DescribeInstances pour obtenir l'identifiant de l'instance.	bastionhost-cn-st220aw****
RegionId	string	Non	L'identifiant de la région de l'instance Bastionhost. Remarque Pour plus d'informations sur le mappage entre les identifiants de région et les noms de région, consultez la section Régions et zones.	cn-hangzhou
UserSourceId	string	Non

É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. Cet identifiant est un identificateur unique généré par Alibaba Cloud pour la requête et peut être utilisé pour résoudre les problèmes.	89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50
AD	object	Les configurations d'authentification Active Directory (AD).
Account	string	Le nom distinctif (DN) du compte du serveur.	cn=Manager,dc=test,dc=com
BaseDN	string	Le DN de base utilisé pour se connecter au serveur AD.	dc=test,dc=com
Domain	string	Le domaine sur le serveur AD.	domain
EmailMapping	string	Le nom du champ qui correspond à l'adresse e-mail de l'utilisateur sur le serveur AD.	emailAttr
Filter	string	La condition de filtrage pour les utilisateurs.	(&(objectClass=top))
IsSSL	boolean	Indique si le protocole SSL est pris en charge. Valeurs valides : true : pris en charge. false : non pris en charge.	true
MobileMapping	string	Le nom du champ qui correspond au numéro de téléphone mobile de l'utilisateur sur le serveur AD.	mobileAttr
NameMapping	string	Le nom du champ qui correspond au nom d'utilisateur sur le serveur AD.	nameAttr
HasPassword	boolean	Indique si un mot de passe est défini. Valeurs valides : true : un mot de passe est défini. false : aucun mot de passe n'est défini.	true
Port	integer	Le port du serveur.	389
Server	string	L'adresse du serveur.	192.168.XX.XX
StandbyServer	string	L'adresse du serveur de secours.	192.168.XX.XX
LatestSyncTime	integer	L'heure de la dernière synchronisation de l'instantané des utilisateurs.	0
SyncInterval	integer	L'intervalle de synchronisation automatique des instantanés des utilisateurs. Unité : heures. Valeurs valides : 0, et 4 à 168. Une valeur de 0 indique que la synchronisation automatique est désactivée et qu'aucune synchronisation n'est effectuée.	0
IsSyncEmailAttr	boolean	Indique si les adresses e-mail sont synchronisées. Une valeur true indique que les adresses e-mail sont synchronisées, et une valeur false indique que les adresses e-mail ne sont pas synchronisées.	true
IsSyncMobileAttr	boolean	Indique si les numéros de téléphone mobile sont synchronisés. Une valeur true indique que les numéros de téléphone mobile sont synchronisés, et une valeur false indique que les numéros de téléphone mobile ne sont pas synchronisés.	true
IsSyncNameAttr	boolean	Indique si les noms d'affichage sont synchronisés. Une valeur true indique que les noms d'affichage sont synchronisés, et une valeur false indique que les noms d'affichage ne sont pas synchronisés.	true
ServerName	string	Le nom du serveur d'authentification AD.	AD Server
IsSyncOuAsUserGroup	boolean	Indique si l'organisation à laquelle un utilisateur appartient est synchronisée en tant que groupe d'utilisateurs. Une valeur true indique que l'organisation est synchronisée en tant que groupe d'utilisateurs, et une valeur false indique que l'organisation n'est pas synchronisée en tant que groupe d'utilisateurs.	true
UserSourceId	string
IsDefault	boolean	Indique si le serveur est le serveur d'authentification AD par défaut. Une valeur true indique que le serveur est le serveur d'authentification AD par défaut, et une valeur false indique que le serveur n'est pas le serveur d'authentification AD par défaut.	true

Exemples

JSON format

{
  "RequestId": "89398CFB-4EB6-4C7E-BB3C-EF213AC8FA50",
  "AD": {
    "Account": "cn=Manager,dc=test,dc=com",
    "BaseDN": "dc=test,dc=com",
    "Domain": "domain",
    "EmailMapping": "emailAttr",
    "Filter": "(&(objectClass=top))",
    "IsSSL": true,
    "MobileMapping": "mobileAttr",
    "NameMapping": "nameAttr",
    "HasPassword": true,
    "Port": 389,
    "Server": "192.168.XX.XX",
    "StandbyServer": "192.168.XX.XX",
    "LatestSyncTime": 0,
    "SyncInterval": 0,
    "IsSyncEmailAttr": true,
    "IsSyncMobileAttr": true,
    "IsSyncNameAttr": true,
    "ServerName": "AD Server",
    "IsSyncOuAsUserGroup": true,
    "UserSourceId": "",
    "IsDefault": true
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter	The argument is invalid.
500	InternalError	An unknown error occurred.

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

Notes de version

Consultez Notes de version pour la liste complète.