すべてのプロダクト
Search

このプロダクト

    Data Management:GetTableDBTopology

    ドキュメントセンター

    Data Management:GetTableDBTopology

    最終更新日:Mar 21, 2026

    データテーブルのトポロジーを照会します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:GetTableDBTopology

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID。

    説明

    テナント ID を表示するには、Data Management (DMS) コンソールの右上隅にあるプロフィール画像にポインターを合わせます。詳細については、「DMS テナントの管理」をご参照ください。

    3***
    TableGuid

    string

    必須

    DMS 内のテーブルの GUID。

    説明

    • テーブルが属するデータベースが論理データベースの場合、ListLogicTables 操作を呼び出して GUID を取得できます。ReturnGuid パラメーターの値を true に設定する必要があります。

    • テーブルが属するデータベースが物理データベースの場合、ListTables 操作を呼び出して GUID を取得できます。ReturnGuid パラメーターの値を true に設定する必要があります。

    IDB_L_9032.db-test.yuyang_test

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエストの ID。

    853F7FD4-D922-4EFB-931C-D253EF159E06
    DBTopology

    object

    データテーブルのトポロジー。

    TableName

    string

    テーブルの名前。

    説明

    • 論理テーブルが照会された場合、論理テーブルの名前が返されます。

    • 物理テーブルが照会された場合、物理テーブルの名前が返されます。

    yuyang_test
    DataSourceList

    array<object>

    データソース。

    array<object>

    応答のスキーマ。

    Sid

    string

    データソースのシステム ID (SID)。

    def
    Host

    string

    データソースのエンドポイント。

    xxx.mysql.polardb.rds.aliyuncs.com
    DbType

    string

    データベースのタイプ。このパラメーターの有効な値の詳細については、「DbType パラメーター」をご参照ください。

    MySQL
    DatabaseList

    array<object>

    物理データベース。

    array<object>

    応答のスキーマ。

    DbId

    string

    データベースの ID。

    489347
    DbName

    string

    データベースの名前。

    db-test
    DbType

    string

    データベースのタイプ。このパラメーターの有効な値の詳細については、「DbType パラメーター」をご参照ください。

    MySQL
    TableList

    array<object>

    物理テーブル。

    object

    応答のスキーマ。

    TableName

    string

    物理テーブルの名前。

    151977812
    TableType

    string

    テーブルのタイプ。これは予約済みのパラメーターです。

    yuyang_test_0000
    TableId

    string

    テーブルの ID。

    NORMAL
    EnvType

    string

    データベースが属する環境のタイプ。有効な値：

    • product：本番環境

    • dev：開発環境

    • pre：プレリリース環境

    • test：テスト環境

    • sit：システム統合テスト (SIT) 環境

    • uat：ユーザー受け入れテスト (UAT) 環境

    • pet：ストレステスト環境

    • stag：ステージング環境

    説明

    詳細については、「インスタンスの環境タイプを変更する」をご参照ください。

    pre
    Port

    integer

    データソースへの接続に使用されるポート。

    3306
    TableGuid

    string

    DMS 内のテーブルの GUID。

    IDB_L_9032.db-test.yuyang_test
    ErrorCode

    string

    エラーコード。

    UnknownError
    ErrorMessage

    string

    エラーメッセージ。

    UnknownError
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "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
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。