Todos los productos
Search
Centro de documentos

:ListDatabases

Última actualización: Sep 03, 2026

Llame a esta operación para consultar información detallada de las bases de datos en una instancia específica.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación en OpenAPI Explorer. Puede usar OpenAPI Explorer para buscar operaciones de API, llamar a operaciones de API y generar dinámicamente código de ejemplo del SDK.

Parámetros de solicitud

Parámetro Tipo Obligatorio Ejemplo Descripción
Action String Sí ListDatabases

La operación que desea ejecutar. Establezca el valor en ListDatabases.

InstanceId String Sí 1

El ID de la instancia. Debe obtenerlo del ID de instancia devuelto por la operación ListInstances. Asegúrese de que el valor no sea el ID de una instancia de RDS.

PageNumber Integer Sí 1

El número de la página devuelta.

Tid Long Sí -1

El ID del inquilino.

Nota El ID de inquilino se obtiene del ID de inquilino que se muestra al pasar el puntero sobre su foto de perfil. Para más información, consulte Consultar información del inquilino .
PageSize Integer No 10

El número de entradas a devolver en cada página.

Parámetros de respuesta

Parámetro Tipo Respuesta de ejemplo Descripción
DatabaseList Array of Database

Los detalles de la base de datos.

Database
CatalogName String 1

El nombre del catálogo de la base de datos.

DatabaseId String 1

El ID de la base de datos.

DbType String mysql

El tipo de la instancia de base de datos.

DbaId String 1

El ID del administrador de la base de datos (DBA).

DbaName String dba_user

El apodo del DBA.

Encoding String utf-8

El formato de codificación de la base de datos.

EnvType String dev

El tipo de entorno al que pertenece la base de datos.

Host String xxx.xxx.xxx.xxx

El endpoint de la instancia a la que pertenece la base de datos.

InstanceId String 1

El ID de la instancia a la que pertenece la base de datos.

OwnerIdList List 1

El ID de un propietario de la base de datos.

OwnerNameList List owner_name

El apodo de un propietario de la base de datos.

Port Integer 3306

El puerto de conexión de la instancia a la que pertenece la base de datos.

SchemaName String test

El nombre de la base de datos.

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

El nombre de consulta de la base de datos.

Sid String test

El ID del sistema (SID) de la instancia a la que pertenece la base de datos.

State String NORMAL

El estado de la base de datos. Valores válidos:

  • NORMAL: La base de datos es normal.
  • DISABLE: La base de datos está deshabilitada.
  • OFFLINE: La base de datos está sin conexión.
  • NOT_EXIST: La base de datos no existe.
ErrorCode String UnknownError

Los códigos de error.

ErrorMessage String UnknownError

El mensaje de error del fallo.

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

El ID de la solicitud.

Success Boolean true

Indica si la llamada fue exitosa.

TotalCount Long 1

El número de bases de datos en la instancia.

Ejemplos

Solicitud de ejemplo

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

Respuestas exitosas de ejemplo

Formato XML

     <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" } ] } } 
   

Códigos de error

Para más información sobre los códigos de error, consulte el centro de errores.