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

Detalles del índice.

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

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Puede llamar a la operación GetUserActiveTenant para obtener el ID del inquilino.	3***
SearchKey	string	No	La palabra clave para buscar bases de datos.	testdb
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página.	10
EnvType	string	No	El tipo de entorno de la base de datos. Para obtener más información, consulte Descripción del entorno de la instancia.	test
SearchRange	string	No	El alcance de los permisos. Valores válidos: HAS_PERMSSION: bases de datos sobre las que usted tiene permisos. OWNER: bases de datos que usted posee. MY_FOCUS: bases de datos que usted sigue. UNKNOWN: todas las bases de datos.	HAS_PERMSSION
SearchTarget	string	No	El objetivo de la búsqueda. Valores válidos: DB: todas las bases de datos, incluidas las bases de datos físicas y lógicas. SINGLE_DB: bases de datos físicas. LOGIC_DB: bases de datos lógicas.	SINGLE_DB
DbType	string	No	El tipo de motor de base de datos. Para obtener más información sobre los valores válidos, consulte Parámetro DbType.	MYSQL
RealLoginUserUid	string	No	El método para ordenar los resultados de la consulta. Valores válidos: LAST_ACTIVE_TIME: ordena los resultados por la última hora de actividad. DB_NAME: ordena los resultados por el nombre de la base de datos.

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
TotalCount	integer	El número total de entradas que cumplen con los criterios de filtro.	1
RequestId	string	El ID de la solicitud.	E0D21075-CD3E-4D98-8264-FD8AD04A63B6
SearchDatabaseList	object
SearchDatabase	array<object>	Una lista de bases de datos.
	array<object>	Los detalles de las bases de datos.
DatabaseId	string	El ID de la base de datos.	2528****
Host	string	El endpoint que se utiliza para conectarse a la base de datos.	rm-xxxx.mysql.rds.aliyuncs.com
DbaId	string	El ID del administrador de bases de datos (DBA) de la instancia.	10****
SchemaName	string	El nombre de la base de datos.	test
Logic	boolean	Indica si la base de datos es una base de datos lógica. Valores válidos: true: La base de datos es una base de datos lógica. false: La base de datos no es una base de datos lógica.	false
DatalinkName	string	El nombre del vínculo de base de datos para consultas entre bases de datos.	datalink_name
Port	integer	El puerto que se utiliza para conectarse a la base de datos.	3306
EnvType	string	El tipo de entorno de la instancia. Para obtener más información, consulte Entornos de instancia.	test
Sid	string	El ID del sistema (SID) de la instancia.	testSid
OwnerIdList	object
OwnerIds	array	Los ID de los propietarios de la base de datos.
	string	El ID de un propietario de la base de datos.	1
Encoding	string	El conjunto de caracteres que se utiliza en la base de datos.	utf8
DbType	string	El tipo de la base de datos.	mysql
OwnerNameList	object
OwnerNames	array	Los apodos de los propietarios de la base de datos.
	string	El apodo de un propietario de la base de datos.	user1
SearchName	string	El nombre que se utiliza para buscar la base de datos.	test@xxx.xxx.xxx.xxx:3306
Alias	string	El alias de la base de datos.	test_rds
CatalogName	string	El nombre del catálogo de la base de datos. Nota Para bases de datos PostgreSQL, se devuelve el nombre de la base de datos.	dmstest
ErrorCode	string	El código de error que se devuelve si la solicitud falla.	UnknownError
ErrorMessage	string	El mensaje de error que se devuelve si la solicitud falla.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "TotalCount": 1,
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList": {
    "SearchDatabase": [
      {
        "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": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user1"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306",
        "Alias": "test_rds",
        "CatalogName": "dmstest"
      }
    ]
  },
  "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.