GetDatabase - - Centre de documentation Alibaba Cloud

Obtient les détails d'une base de données spécifié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.

dms:GetDatabase

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Vous pouvez appeler l'API GetUserActiveTenant pour obtenir cet identifiant.	-1
Host	string	Oui	Le point de terminaison de la base de données.	192.168.XX.XX
Port	integer	Oui	Le port de connexion à la base de données.	3306
Sid	string	Non	Le SID de la base de données. Remarque Le SID de la base de données est l'identifiant unique d'une base de données Oracle.	test_sid
SchemaName	string	Oui	Le nom de la base de données.	mysql
RealLoginUserUid	string	Non	Aucun.

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	3CDB8601-AD74-4A47-8114-08E08CD6****
Database	object	Les détails de la base de données.
DatabaseId	string	L'identifiant de la base de données.	984****
Host	string	Le point de terminaison de la base de données.	192.168.XX.XX
CatalogName	string	Le nom du catalogue de la base de données.	def
DbaName	string	Le pseudonyme du DBA.	dba_name
State	string	L'état de la base de données. Valeurs valides : NORMAL : La base de données est en cours d'exécution. DISABLED : La base de données est désactivée. OFFLINE : La base de données est hors ligne. NOT_EXIST : La base de données n'existe pas.	NORMAL
DbaId	string	L'identifiant utilisateur du DBA.	27****
SchemaName	string	Le nom du schéma.	mysql
InstanceId	string	L'identifiant de l'instance.	149****
Port	integer	Le port utilisé pour se connecter à la base de données.	3306
EnvType	string	Le type d'environnement de la base de données. Valeurs valides : product : production dev : développement pre : pré-version test : test sit : test d'intégration système (SIT) uat : test d'acceptation utilisateur (UAT) pet : test de performance stag : préproduction	product
Sid	string	Le SID de la base de données. Remarque Ce paramètre est renvoyé uniquement pour les bases de données Oracle.	test_sid
OwnerIdList	object	Les identifiants des propriétaires de la base de données.
OwnerIds	array	A list of User IDs of the database owner.
	string	The user ID of a database owner.	27****
Encoding	string	Le jeu de caractères.	utf8mb4
DbType	string	Le type de moteur de base de données. Pour plus d'informations, consultez la description du paramètre DbType.	mysql
OwnerNameList	object	Les pseudonymes des propriétaires de la base de données.
OwnerNames	array	List of Database Owner nicknames.
	string	The nickname of a database owner.	test
SearchName	string	Le nom utilisé pour rechercher la base de données.	mysql@192.168.XX.XX:3306
InstanceAlias	string	L'alias de l'instance.	test
ErrorCode	string	Le code d'erreur.	UnknownError
ErrorMessage	string	Le message d'erreur.	Une erreur inconnue s'est produite
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

Exemples

JSON format

{
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "Success": true
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.