ListDatabases - Data Management - Centro de documentación de Alibaba Cloud

Invoca ListDatabases para obtener la lista de bases de datos de una instancia.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

dms:ListDatabases

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Nota Pase el cursor sobre la imagen de perfil en la esquina superior derecha para ver el ID del inquilino. Para obtener más información, consulte Ver información del inquilino.	3***
InstanceId	string	Sí	El ID de la instancia. Obténgalo del ID de instancia en la información de la instancia devuelta por la API ListInstances. Este no es el ID de instancia de RDS.	12***
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de registros por página.	10
SearchKey	string	No

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalCount	integer	El número de bases de datos en la instancia.	1
RequestId	string	El ID de la solicitud.	5541CDA6-F674-435C-81BD-40C2FB926CE3
DatabaseList	object
Database	array<object>	La lista de detalles de las bases de datos.
	array<object>
DatabaseId	string	El ID de la base de datos.	1
Host	string	El endpoint de la instancia a la que pertenece la base de datos.	xxx.xxx.xxx.xxx
CatalogName	string	El nombre del catálogo de la base de datos.	1
DbaName	string	El apodo del DBA al que pertenece la base de datos.	dba_user
State	string	El estado de la base de datos. Los valores y sus descripciones son los siguientes: NORMAL: Normal DISABLE: Deshabilitada OFFLINE: Fuera de línea NOT_EXIST: No existe	NORMAL
DbaId	string	El ID del DBA.	1
SchemaName	string	El nombre de la base de datos.	test
InstanceId	string	El ID de la instancia a la que pertenece la base de datos.	1
Port	integer	El puerto de conexión de la instancia a la que pertenece la base de datos.	3306
EnvType	string	El tipo de entorno al que pertenece la base de datos.	dev
Sid	string	El SID de la instancia a la que pertenece la base de datos.	test
OwnerIdList	object
OwnerIds	array	La lista de ID de propietarios de la base de datos.
	string	El ID del propietario de la base de datos.	1
Encoding	string	La codificación de la base de datos.	utf-8
DbType	string	El tipo de base de datos.	mysql
OwnerNameList	object
OwnerNames	array	La lista de apodos de los propietarios de la base de datos.
	string	El apodo del propietario de la base de datos.	owner_name
SearchName	string	El nombre utilizado para buscar la base de datos.	test@xxx.xxx.xxx.xxx:3306
ErrorCode	string	El código de error.	UnknownError
ErrorMessage	string	El mensaje de error.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.