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

Consulta la topología de una tabla de datos.

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

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 Gestionar inquilinos de DMS.	3***
TableGuid	string	Sí	El GUID de la tabla en DMS. Nota Si la base de datos a la que pertenece la tabla es una base de datos lógica, puede llamar a la operación ListLogicTables para obtener el GUID. El valor del parámetro ReturnGuid debe establecerse en true. Si la base de datos a la que pertenece la tabla es una base de datos física, puede llamar a la operación ListTables para obtener el GUID. El valor del parámetro ReturnGuid debe establecerse en true.	IDB_L_9032.db-test.yuyang_test

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El esquema de la respuesta.
RequestId	string	El ID de la solicitud.	853F7FD4-D922-4EFB-931C-D253EF159E06
DBTopology	object	La topología de la tabla de datos.
TableName	string	El nombre de la tabla. Nota Si se consulta una tabla lógica, se devuelve el nombre de la tabla lógica. Si se consulta una tabla física, se devuelve el nombre de la tabla física.	yuyang_test
DataSourceList	array<object>	Los orígenes de datos.
	array<object>	El esquema de la respuesta.
Sid	string	El ID del sistema (SID) del origen de datos.	def
Host	string	El endpoint del origen de datos.	xxx.mysql.polardb.rds.aliyuncs.com
DbType	string	El tipo de la base de datos. Para obtener más información sobre los valores válidos de este parámetro, consulte Parámetro DbType.	MySQL
DatabaseList	array<object>	Las bases de datos físicas.
	array<object>	El esquema de la respuesta.
DbId	string	El ID de la base de datos.	489347
DbName	string	El nombre de la base de datos.	db-test
DbType	string	El tipo de la base de datos. Para obtener más información sobre los valores válidos de este parámetro, consulte Parámetro DbType.	MySQL
TableList	array<object>	Las tablas físicas.
	object	El esquema de la respuesta.
TableName	string	El nombre de la tabla física.	151977812
TableType	string	El tipo de la tabla. Este es un parámetro reservado.	yuyang_test_0000
TableId	string	El ID de la tabla.	NORMAL
EnvType	string	El tipo de entorno al que pertenece la base de datos. Valores válidos: product: entorno de producción dev: entorno de desarrollo pre: entorno de prelanzamiento test: entorno de pruebas sit: entorno de pruebas de integración del sistema (SIT) uat: entorno de pruebas de aceptación del usuario (UAT) pet: entorno de pruebas de estrés stag: entorno de preparación Nota Para obtener más información, consulte Cambiar el tipo de entorno de una instancia.	pre
Port	integer	El puerto que se utiliza para conectarse al origen de datos.	3306
TableGuid	string	El GUID de la tabla en DMS.	IDB_L_9032.db-test.yuyang_test
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

{
  "RequestId": "853F7FD4-D922-4EFB-931C-D253EF159E06",
  "DBTopology": {
    "TableName": "yuyang_test",
    "DataSourceList": [
      {
        "Sid": "def",
        "Host": "xxx.mysql.polardb.rds.aliyuncs.com",
        "DbType": "MySQL",
        "DatabaseList": [
          {
            "DbId": "489347",
            "DbName": "db-test",
            "DbType": "MySQL",
            "TableList": [
              {
                "TableName": "151977812",
                "TableType": "yuyang_test_0000",
                "TableId": "NORMAL"
              }
            ],
            "EnvType": "pre"
          }
        ],
        "Port": 3306
      }
    ],
    "TableGuid": "IDB_L_9032.db-test.yuyang_test"
  },
  "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.