ListDatabases - - Centre de documentation Alibaba Cloud

Invoque ListDatabases pour récupérer la liste des bases de données d'une instance.

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

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Tid	integer	Non	L'identifiant du locataire. Remarque Passez la souris sur la photo de profil dans le coin supérieur droit pour afficher l'identifiant du locataire. Pour plus d'informations, consultez Afficher les informations du locataire.	3***
InstanceId	string	Oui	L'identifiant de l'instance. Vous pouvez l'obtenir à partir de l'identifiant de l'instance dans les informations d'instance renvoyées par l'API ListInstances. Il ne s'agit pas de l'identifiant de l'instance RDS.	12***
PageNumber	integer	Non	Le numéro de page.	1
PageSize	integer	Non	Le nombre d'enregistrements par page.	10
SearchKey	string	Non

Éléments de réponse

Élément	Type	Description	Exemple
	object
TotalCount	integer	Le nombre de bases de données de l'instance.	1
RequestId	string	L'identifiant de la requête.	5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseList	object
Database	array<object>	La liste des détails des bases de données.
	array<object>
DatabaseId	string	The database ID.	1
Host	string	The endpoint of the instance to which the database belongs.	xxx.xxx.xxx.xxx
CatalogName	string	The database catalog name.	1
DbaName	string	The nickname of the DBA to whom the database belongs.	dba_user
State	string	The database status. Values and descriptions are as follows: NORMAL: Normal DISABLE: Disabled OFFLINE: Offline NOT_EXIST: Does not exist	NORMAL
DbaId	string	The DBA ID.	1
SchemaName	string	The database name.	test
InstanceId	string	The ID of the instance to which the database belongs.	1
Port	integer	The connection port of the instance to which the database belongs.	3306
EnvType	string	The environment type to which the database belongs.	dev
Sid	string	The SID of the instance to which the database belongs.	test
OwnerIdList	object
OwnerIds	array	The list of database owner IDs.
	string	The database owner ID.	1
Encoding	string	The database encoding.	utf-8
DbType	string	The database type.	mysql
OwnerNameList	object
OwnerNames	array	The list of database owner nicknames.
	string	The database owner nickname.	owner_name
SearchName	string	The name used to search for the database.	test@xxx.xxx.xxx.xxx:3306
ErrorCode	string	Le code d'erreur.	UnknownError
ErrorMessage	string	Le message d'erreur.	UnknownError
Success	boolean	Indique si la requête a réussi.	true

Exemples

JSON format

{
  "TotalCount": 1,
  "RequestId": "5541CDA6-F674-435C-81BD-40C2FB926CE3",
  "DatabaseList": {
    "Database": [
      {
        "DatabaseId": "1",
        "Host": "xxx.xxx.xxx.xxx",
        "CatalogName": "1",
        "DbaName": "dba_user",
        "State": "NORMAL",
        "DbaId": "1",
        "SchemaName": "test",
        "InstanceId": "1",
        "Port": 3306,
        "EnvType": "dev",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf-8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "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.