Todos os produtos
Search
Central de documentação

:GetTableTopology

Última atualização: Jul 08, 2026

Chame a operação GetTableTopology para obter a topologia de uma tabela de dados.

Depuração

Teste esta operação no OpenAPI Explorer sem calcular a assinatura. Após a execução bem-sucedida, o OpenAPI Explorer gera automaticamente exemplos de código do SDK.

Parâmetros da solicitação

Name Type Required Example Description
Action String Yes GetTableTopology

Ação a executar. Defina o valor como GetTableTopology.

TableGuid String Yes IDB_L_308302.yuyang_test.test_ch

Identificador globalmente exclusivo (GUID) da tabela no DMS.

Nota
  • Bancos de dados lógicos: chame a operação ListLogicTables e defina o parâmetro ReturnGuid como true.
  • Bancos de dados físicos: chame a operação ListTables e defina o parâmetro ReturnGuid como true.
Tid Long No 3***

ID do locatário.

Nota Para obter o ID do locatário, passe o mouse sobre a foto de perfil no canto superior direito do console do DMS. Para mais informações, consulte Visualizar informações do locatário.

Dados retornados

Name Type Example Description
RequestId String F5ED6A40-F344-4C7D-A8F0-5685CA584CA7

ID da solicitação.

Success Boolean true

Indica se a solicitação foi bem-sucedida.

ErrorMessage String UnknownError

Mensagem de erro.

ErrorCode String UnknownError

Código de erro.

TableTopology Object

Informações de topologia.

TableGuid String IDB_L_308302.yuyang_test.test_ch

GUID da tabela no DMS.

TableName String test_ch

Nome da tabela.

TableTopologyInfoList Array of TableTopologyInfo

Lista de informações de topologia da tabela.

TableNameList String test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005

Lista de nomes de tabelas.

Nota Separe os itens com vírgulas.
TableNameExpr String test_ch_[0000-0005]

Expressão do nome da tabela lógica.

Nota Parâmetro não retornado para tabelas físicas.
TableCount Long 6

Número de tabelas.

DbId Long 43215

ID do banco de dados físico.

DbSearchName String yuyang_test@localhost:3306[yuyang_test_dev]

Nome de pesquisa do banco de dados.

InstanceId Long 4325325

ID da instância à qual o banco de dados físico pertence.

RegionId String cn-hangzhou

ID da região da instância.

InstanceResourceId String rm-xxx

ID do recurso da instância. Valores válidos:

  • RDS: ID de uma instância ApsaraDB RDS.
  • ECS_OWN: ID de uma instância ECS.
  • PUBLIC_OWN: vazio.
  • VPC_ID: ID de uma VPC.
  • GATEWAY: ID de uma instância Database Gateway.
InstanceSource String RDS

source da instância. Valores válidos:

  • RDS: instância ApsaraDB RDS.
  • ECS_OWN: banco de dados autogerenciado hospedado em uma instância ECS.
  • PUBLIC_OWN: banco de dados autogerenciado conectado pela Internet.
  • VPC_ID: banco de dados em um IDC conectado por linha dedicada em uma VPC.
  • GATEWAY: instância Database Gateway.
DbName String yuyang_test

Nome do banco de dados.

DbType String mysql

Tipo do banco de dados.

Logic Boolean true

Indica se a tabela é lógica. Valores válidos:

  • true: Sim
  • false: Não

Exemplos

Exemplo de solicitação

http(s)://dms-enterprise.aliyuncs.com/?Action=GetTableTopology
&TableGuid=IDB_L_308302.yuyang_test.test_ch
&<Common request parameters>

Exemplos de resposta bem-sucedida

Formato XML

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

<GetTableTopologyResponse>
    <RequestId>7A7F0E34-8E21-4CF7-93C8-27212B122145</RequestId>
    <TableTopology>
        <TableName>big_table</TableName>
        <TableGuid>IDB_279000000.film.big_table</TableGuid>
        <Logic>false</Logic>
        <TableTopologyInfoList>
            <DbSearchName>film@rm-uf00000000240000l.mysql.rds.aliyuncs.com:3306[nissi go]</DbSearchName>
            <InstanceSource>RDS</InstanceSource>
            <InstanceResourceId>rm-uf00000000240000l</InstanceResourceId>
            <InstanceId>1000000</InstanceId>
            <TableNameList>big_table</TableNameList>
            <TableCount>1</TableCount>
            <DbId>4000000</DbId>
            <DbName>film</DbName>
            <RegionId>cn-shanghai</RegionId>
            <DbType>mysql</DbType>
        </TableTopologyInfoList>
    </TableTopology>
    <Success>true</Success>    
</GetTableTopologyResponse>

Formato JSON

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

{
  "RequestId" : "7A7F0E34-8E21-4CF7-93C8-27212B122145",
  "TableTopology" : {
    "TableName" : "big_table",
    "TableGuid" : "IDB_279000000.film.big_table",
    "Logic" : false,
    "TableTopologyInfoList" : [ {
      "DbSearchName" : "film@rm-uf00000000240000l.mysql.rds.aliyuncs.com:3306[nissi go]",
      "InstanceSource" : "RDS",
      "InstanceResourceId" : "rm-uf00000000240000l",
      "InstanceId" : 1000000,
      "TableNameList" : "big_table",
      "TableCount" : 1,
      "DbId" : 4000000,
      "DbName" : "film",
      "RegionId" : "cn-shanghai",
      "DbType" : "mysql"
    } ]
  },
  "Success" : true
}

Códigos de erro

Para mais informações sobre códigos de erro, consulte a Central de Erros.