Tous les produits
Search
Centre de documentation

:ListDatabases

Dernière mise à jour :Aug 09, 2026

Appelez cette opération pour consulter les informations détaillées des bases de données d'une instance spécifiée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. Vous pouvez y rechercher des opérations API, les appeler et générer dynamiquement des exemples de code SDK.

Paramètres de requête

Parameter Type Required Example Description
Action String Yes ListDatabases

Opération à effectuer. Définissez la valeur sur ListDatabases.

InstanceId String Yes 1

ID de l'instance. Récupérez cette valeur à partir de l'ID d'instance renvoyé par l'opération ListInstances. Vérifiez qu'il ne s'agit pas de l'ID d'une instance RDS.

PageNumber Integer Yes 1

Numéro de la page renvoyée.

Tid Long Yes -1

ID du locataire (tenant).

Remarque L'ID du locataire est extrait de l'ID affiché lorsque vous placez le pointeur sur votre photo de profil. Pour plus d'informations, consultez la rubrique Afficher les informations du locataire .
PageSize Integer No 10

Nombre d'entrées à renvoyer par page.

Paramètres de réponse

Parameter Type Sample response Description
DatabaseList Array of Database

Détails relatifs à une base de données.

Database
CatalogName String 1

Nom du catalogue de la base de données.

DatabaseId String 1

ID de la base de données.

DbType String mysql

Type de l'instance de base de données.

DbaId String 1

ID de l'administrateur de base de données (DBA).

DbaName String dba_user

Pseudonyme du DBA.

Encoding String utf-8

Format d'encodage de la base de données.

EnvType String dev

Type d'environnement auquel appartient la base de données.

Host String xxx.xxx.xxx.xxx

Endpoint de l'instance à laquelle appartient la base de données.

InstanceId String 1

ID de l'instance à laquelle appartient la base de données.

OwnerIdList List 1

ID d'un propriétaire de base de données.

OwnerNameList List owner_name

Pseudonyme d'un propriétaire de base de données.

Port Integer 3306

Port de connexion de l'instance à laquelle appartient la base de données.

SchemaName String test

Nom de la base de données.

SearchName String test@xxx.xxx.xxx.xxx:3306

Nom de recherche de la base de données.

Sid String test

ID système (SID) de l'instance à laquelle appartient la base de données.

State String NORMAL

Statut de la base de données. Valeurs possibles :

  • NORMAL : la base de données est normale.
  • DISABLE : 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.
ErrorCode String UnknownError

Codes d'erreur.

ErrorMessage String UnknownError

Message d'erreur en cas d'échec.

RequestId String 5541CDA6-F674-435C-81BD-40C2FB926CE3

ID de la requête.

Success Boolean true

Indique si l'appel a réussi.

TotalCount Long 1

Nombre de bases de données dans l'instance.

Exemples

Exemple de requête


     http(s)://[Endpoint]/? Action=ListDatabases &InstanceId=1 &PageNumber=1 &Tid=-1 &<common request parameters> 
   

Exemples de réponses réussies

XML format


     <TotalCount> 1 </TotalCount> <RequestId> 5541CDA6-F674-435C-81BD-40C2FB926CE3 </RequestId> <Success> true </Success> <DatabaseList> <Database> <Encoding> utf8 </Encoding> <Host> pc-xxx.rwlb.rds.aliyuncs.com </Host> <InstanceId> 24710 </InstanceId> <DbType> polardb </DbType> <EnvType> product </EnvType> <OwnerIdList> <OwnerIds> 88653 </OwnerIds> </OwnerIdList> <DbaId> 104442 </DbaId> <OwnerNameList> <OwnerNames> dmstest </OwnerNames> </OwnerNameList> <Port> 3306 </Port> <DatabaseId> 116366 </DatabaseId> <State> NORMAL </State> <SearchName> xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306 [xxx_test] </SearchName> <DbaName> xxx [account] </DbaName> <SchemaName> xxx_test </SchemaName> </Database> </DatabaseList> 
   

JSON


     {"TotalCount": 1, "RequestId": "5541CDA6-F674-435C-81BD-40C2FB926CE3", "Success": true, "DatabaseList": { "Database": [ { "Encoding": "utf8", "Host": "pc-xxx.rwlb.rds.aliyuncs.com", "InstanceId": 24710, "DbType": "polardb", "EnvType": "product", "OwnerIdList": { " OwnerIds ": [ 88653 ] }, " DbaId ": 104442, " OwnerNameList ": { " OwnerNames ": [ " dmstest " ] }, " Port ": 3306, " DatabaseId ": 116366," State ": " NORMAL ", " SearchName ": 3306" xxx_test@pc-xxx.rwlb.rds.aliyuncs.com: [xxx_xxtest] "DbaName": "xxx [Ram user]", "SchemaName": "xxx_test" } ] } } 
   

Codes d'erreur

Pour plus d'informations sur les codes d'erreur, consultez le centre d'erreurs.