SearchDatabase - - Centro de documentación de Alibaba Cloud

Consulta la información de las bases de datos.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que llame a esta operación en OpenAPI Explorer. OpenAPI Explorer genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	SearchDatabase	La operación que desea ejecutar. Establezca el valor en SearchDatabase.
Tid	Long	Sí	3***	El ID del inquilino. Llame a la operación GetUserActiveTenant para obtener este ID.
SearchKey	String	Sí	testdb	Palabra clave para buscar bases de datos.
PageNumber	Integer	Sí	1	Número de página a devolver.
PageSize	Integer	No	10	Número de entradas a devolver por página.
EnvType	String	No	test	Tipo de entorno al que pertenece la base de datos. Para obtener más información, consulte Cambiar el tipo de entorno de una instancia.
SearchRange	String	No	HAS_PERMSSION	Rango de consulta basado en permisos. Valores válidos: HAS_PERMSSION: busca bases de datos sobre las cuales el usuario actual tiene permisos. OWNER: busca bases de datos propiedad del usuario actual. MY_FOCUS: busca bases de datos que sigue el usuario actual. UNKNOWN: busca todas las bases de datos.
SearchTarget	String	No	SINGLE_DB	Categoría de la base de datos. Valores válidos: DB: base de datos única o lógica. SINGLE_DB: base de datos única. LOGIC_DB: base de datos lógica.
DbType	String	No	MYSQL	Tipo de base de datos. Para consultar los valores válidos de este parámetro, revise Parámetro DbType.
RegionId	String	No	cn-hangzhou	ID de la región donde está activado Data Management (DMS). Para consultar los valores válidos de este parámetro, revise Parámetro RegionID.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
TotalCount	Long	1	Número total de entradas devueltas.
RequestId	String	E0D21075-CD3E-4D98-8264-FD8AD04A63B6	ID de la solicitud.
SearchDatabaseList	Array of SearchDatabase		Información de las bases de datos.
SearchDatabase
DatabaseId	String	2528****	ID de la base de datos.
Host	String	rm-xxxx.mysql.rds.aliyuncs.com	Endpoint de la instancia donde reside la base de datos.
DbaId	String	10****	ID del usuario que asume el rol de administrador de base de datos (DBA).
SchemaName	String	test	Nombre de la base de datos.
Logic	Boolean	false	Indica si la base de datos es lógica. Valores válidos: true: La base de datos es lógica. false: La base de datos no es lógica.
DatalinkName	String	datalink_name	Nombre del enlace de datos para consultas entre bases de datos.
Port	Integer	3306	Puerto de la instancia donde reside la base de datos.
EnvType	String	test	Tipo de entorno al que pertenece la base de datos. Para obtener más información, consulte Cambiar el tipo de entorno de una instancia.
Sid	String	testSid	ID del sistema (Sid) de la instancia donde reside la base de datos.
OwnerIdList	Array of String	1	ID de los propietarios de la base de datos.
Encoding	String	utf8	Método de codificación de la base de datos.
DbType	String	mysql	Tipo de base de datos.
OwnerNameList	Array of String	user1	Apodos de los propietarios de la base de datos.
SearchName	String	test@xxx.xxx.xxx.xxx:3306	Nombre utilizado para buscar la base de datos.
Alias	String	test_rds	Alias de la base de datos.
ErrorCode	String	UnknownError	Código de error devuelto.
ErrorMessage	String	UnknownError	Mensaje de error devuelto.
Success	Boolean	true	Indica si la solicitud se completó correctamente. Valores válidos: true: La solicitud se completó correctamente. false: La solicitud falló.

Ejemplos

Solicitud de ejemplo

http(s)://dms-enterprise.aliyuncs.com/?Action=SearchDatabase
&Tid=3***
&SearchKey=testdb
&PageNumber=1
&PageSize=10
&EnvType=test
&SearchRange=HAS_PERMSSION
&SearchTarget=SINGLE_DB
&DbType=MYSQL
&<Common request parameters>

Respuestas correctas de ejemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchDatabaseResponse>
    <TotalCount>1</TotalCount>
    <RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId>
    <SearchDatabaseList>
        <DatabaseId>2528****</DatabaseId>
        <Host>rm-xxxx.mysql.rds.aliyuncs.com</Host>
        <DbaId>10****</DbaId>
        <SchemaName>test</SchemaName>
        <Logic>false</Logic>
        <DatalinkName>datalink_name</DatalinkName>
        <Port>3306</Port>
        <EnvType>test</EnvType>
        <Sid>testSid</Sid>
        <OwnerIdList>1</OwnerIdList>
        <Encoding>utf8</Encoding>
        <DbType>mysql</DbType>
        <OwnerNameList>user1</OwnerNameList>
        <SearchName>test@xxx.xxx.xxx.xxx:3306</SearchName>
        <Alias>test_rds</Alias>
    </SearchDatabaseList>
    <Success>true</Success>
</SearchDatabaseResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList" : [ {
    "DatabaseId" : "2528****",
    "Host" : "rm-xxxx.mysql.rds.aliyuncs.com",
    "DbaId" : "10****",
    "SchemaName" : "test",
    "Logic" : false,
    "DatalinkName" : "datalink_name",
    "Port" : 3306,
    "EnvType" : "test",
    "Sid" : "testSid",
    "OwnerIdList" : [ "1" ],
    "Encoding" : "utf8",
    "DbType" : "mysql",
    "OwnerNameList" : [ "user1" ],
    "SearchName" : "test@xxx.xxx.xxx.xxx:3306",
    "Alias" : "test_rds"
  } ],
  "Success" : true
}

Códigos de error

Para obtener una lista de códigos de error, visite el Centro de errores de API.