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

Consulta información detallada sobre tablas.

Descripción de la operación

Esta operación solo se puede invocar para instancias de base de datos administradas en el modo Colaboración de seguridad.

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

get

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Tid	integer	No	El ID del inquilino. Nota Para ver el ID del inquilino, pase el puntero sobre la imagen de perfil en la esquina superior derecha de la consola de Data Management (DMS). Para obtener más información, consulte la sección Ver información sobre el inquilino actual del tema "Administrar inquilinos de DMS".	1
SearchKey	string	No	La palabra clave que se utiliza para consultar tablas.	test
PageNumber	integer	No	El número de la página a devolver.	1
PageSize	integer	No	El número de entradas a devolver en cada página.	10
EnvType	string	No	El tipo de entorno al que pertenecen las bases de datos. Para obtener más información, consulte Cambiar el tipo de entorno de una instancia.	PRODUCT
SearchRange	string	No	El alcance de las tablas que desea consultar. Valores válidos: HAS_PERMSSION: las tablas sobre las que la cuenta actual tiene permisos. OWNER: las tablas propiedad de la cuenta actual. MY_FOCUS: las tablas que sigue la cuenta actual. UNKNOWN: todas las tablas.	OWNER
SearchTarget	string	No	El tipo de tabla que desea consultar. Valores válidos: TABLE: tablas físicas y lógicas SINGLE_TABLE: tablas físicas LOGIC_TABLE: tablas lógicas	LOGIC_TABLE
DbType	string	No	El tipo de base de datos. Valores válidos: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	MySQL
ReturnGuid	boolean	No	Especifica si se debe devolver el GUID de cada tabla.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
SearchTableList	object
SearchTable	array<object>	Los detalles de las tablas.
	array<object>
TableId	string	El ID de la tabla.	1
Description	string	La descripción de la tabla.	test
DatabaseId	string	El ID de la base de datos a la que pertenece la tabla.	1
Encoding	string	El formato de codificación de la tabla.	utf8
DBSearchName	string	El nombre que se utiliza para buscar la base de datos a la que pertenece la tabla.	test
EnvType	string	El tipo de entorno al que pertenece la base de datos.	test
DbType	string	El tipo de base de datos. Valores válidos: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	mysql
TableName	string	El nombre de la tabla.	test_table
TableGuid	string	El GUID de la tabla.	IDB_L_9032.db-test.yuyang_test
TableSchemaName	string	El nombre de la base de datos a la que pertenece la tabla.	test@xxx.xxx.xxx.xxx:3306
DbName	string	El nombre de la base de datos.	test
OwnerNameList	object
OwnerNames	array	Los apodos de los propietarios de la tabla.
	string	El apodo del propietario de la tabla.	user
Logic	boolean	Indica si la tabla es una tabla lógica. Valores válidos: true: La tabla es una tabla lógica. false: La tabla no es una tabla lógica.	false
OwnerIdList	object
OwnerIds	array	Los ID de los propietarios de la tabla.
	string	El ID del propietario de la tabla.	1
Engine	string	El motor de la tabla.	innodb
TotalCount	integer	El número total de entradas devueltas.	1
RequestId	string	El ID de la solicitud.	1489257F-1B5D-4B5B-89EF-923C12CEEBD1
ErrorCode	string	El código de error devuelto si la solicitud falló.	UnknownError
ErrorMessage	string	El mensaje de error devuelto si la solicitud falló.	UnknownError
Success	boolean	Indica si la solicitud se realizó correctamente.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "SearchTableList": {
    "SearchTable": [
      {
        "TableId": "1",
        "Description": "test",
        "DatabaseId": "1",
        "Encoding": "utf8",
        "DBSearchName": "test",
        "EnvType": "test",
        "DbType": "mysql",
        "TableName": "test_table",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "DbName": "test",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "Logic": false,
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Engine": "innodb"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "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.