すべてのプロダクト
Search

このプロダクト

    Data Management:GetTableTopology

    ドキュメントセンター

    Data Management:GetTableTopology

    最終更新日: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:GetTableTopology

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    TableGuid

    string

    必須

    Data Management (DMS) におけるテーブルの GUID。

    説明

    • ListLogicTables 操作を、ReturnGuid を true に設定して呼び出すことで、特定の論理データベース内の論理テーブルの GUID を照会できます。

    • ListTables 操作を、ReturnGuid を true に設定して呼び出すことで、特定の物理データベース内のテーブルの GUID を照会できます。

    IDB_L_308302.yuyang_test.test_ch
    Tid

    integer

    任意

    テナントの ID。

    説明

    DMS コンソールの右上隅にあるプロフィール画像にマウスを合わせると、テナントの ID を確認できます。詳細については、「テナント情報」トピックの「現在のテナントに関する情報を表示する」セクションをご参照ください。

    3***

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ。

    RequestId

    string

    リクエストの ID。

    F5ED6A40-F344-4C7D-A8F0-5685CA584CA7
    Success

    boolean

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

    true
    ErrorMessage

    string

    エラーメッセージ。

    UnknownError
    ErrorCode

    string

    エラーコード。

    UnknownError
    TableTopology

    object

    トポロジー情報。

    TableGuid

    string

    DMS におけるテーブルの GUID。

    IDB_L_308302.yuyang_test.test_ch
    TableName

    string

    テーブル名。

    test_ch
    TableTopologyInfoList

    array<object>

    テーブルのトポロジー情報。

    object

    テーブルのトポロジー情報。

    TableNameList

    string

    テーブル名の一覧。

    説明

    テーブル名はカンマ (,) で区切られます。

    test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005
    TableNameExpr

    string

    論理テーブル名の式。

    **

    説明 このパラメーターは、物理テーブルでは返されません。

    test_ch_[0000-0005]
    TableCount

    integer

    テーブル数。

    6
    DbId

    integer

    物理データベースの ID。

    43215
    DbSearchName

    string

    データベース検索に使用される名前。

    説明

    このパラメーターは、ビジネス開発用途での使用を推奨しません。パラメーター値の形式は、今後のバージョンで変更される可能性があります。

    yuyang_test@localhost:3306[yuyang_test_dev]
    InstanceId

    integer

    物理データベースが属するインスタンスの ID。

    4325325
    RegionId

    string

    インスタンスのリージョン ID。

    cn-hangzhou
    InstanceResourceId

    string

    インスタンスに関連付けられたリソースの ID。このリソースは、InstanceSource パラメーターで返されるデータベースインスタンスタイプに対応します。

    • RDS: ApsaraDB RDS インスタンスの ID。

    • ECS_OWN: ECS インスタンス上にデプロイされた自己管理データベースの ID。

    • PUBLIC_OWN: インターネット経由で接続される自己管理データベースインスタンスの場合、このパラメーターは空になります。

    • VPC_ID: 仮想プライベートクラウド (VPC) の ID。

    • GATEWAY: データベースゲートウェイの ID。

    rm-xxx
    InstanceSource

    string

    データベースインスタンスのタイプ。有効な値は以下のとおりです。

    • RDS: ApsaraDB RDS インスタンス。

    • ECS_OWN: ECS インスタンス上でデプロイされた自己管理データベース。

    • PUBLIC_OWN: インターネット経由で接続される自己管理データベースインスタンス。

    • VPC_ID: Express Connect 回線経由で接続される VPC 内の自己管理データベースインスタンス。

    • GATEWAY: データベースゲートウェイを介して接続されるデータベースインスタンス。

    RDS
    DbName

    string

    データベース名。

    yuyang_test
    DbType

    string

    データベースエンジン。

    mysql
    Logic

    boolean

    テーブルが論理テーブルであるかどうかを示します。有効な値は以下のとおりです。

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "F5ED6A40-F344-4C7D-A8F0-5685CA584CA7",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "TableTopology": {
    "TableGuid": "IDB_L_308302.yuyang_test.test_ch",
    "TableName": "test_ch",
    "TableTopologyInfoList": [
      {
        "TableNameList": "test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005",
        "TableNameExpr": "test_ch_[0000-0005]",
        "TableCount": 6,
        "DbId": 43215,
        "DbSearchName": "yuyang_test@localhost:3306[yuyang_test_dev]",
        "InstanceId": 4325325,
        "RegionId": "cn-hangzhou",
        "InstanceResourceId": "rm-xxx",
        "InstanceSource": "RDS",
        "DbName": "yuyang_test",
        "DbType": "mysql"
      }
    ],
    "Logic": true
  }
}

    エラーコード

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

    変更履歴

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