すべてのプロダクト
Search

このプロダクト

    Data Management:GetDBTopology

    ドキュメントセンター

    Data Management:GetDBTopology

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    LogicDbId

    integer

    必須

    論理データベースの ID です。ListLogicDatabases または SearchDatabase 操作を呼び出して、論理データベースの ID を照会できます。

    134325
    Tid

    integer

    任意

    テナントの ID です。

    説明

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

    43215

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答のスキーマ

    RequestId

    string

    リクエストの ID です。

    C5B8E84B-42B6-4374-AD5A-6264E1753378
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値は次のとおりです：

    • true：リクエストは成功です。

    • false：リクエストは失敗です。

    true
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    ErrorCode

    string

    エラーコードです。

    UnknownError
    DBTopology

    object

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

    LogicDbId

    integer

    論理データベースの ID です。

    1234
    LogicDbName

    string

    論理データベース名です。

    logic_db_test
    SearchName

    string

    保存済みのクイック検索の名前です。

    logic_db_test
    Alias

    string

    アクセスポイントのエイリアスです。

    logic_db_test
    DbType

    string

    データベースエンジンのタイプです。

    polardb
    EnvType

    string

    データベースインスタンスがデプロイされている環境のタイプです。有効な値は次のとおりです：

    • product：本番環境

    • dev：開発環境

    • pre：プレリリース環境

    • test：テスト環境

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

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

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

    • stag：ステージング環境

    dev
    DBTopologyInfoList

    array<object>

    データベース分割トポロジー情報のリストです。

    object

    DbId

    integer

    スキーマ設計が実行されるデータベースの ID です。

    423532
    SchemaName

    string

    論理データベースの名前です。

    説明

    データベースが PostgreSQL データベースの場合、このパラメーターの値はデータベーススキーマの名前になります。

    db_test@rm-xxx:3306
    CatalogName

    string

    データベースが属するカタログの名前です。

    説明

    データベースが PostgreSQL データベースの場合、このパラメーターの値はデータベースの名前になります。

    def
    SearchName

    string

    クイック検索の名前です。

    db_test
    DbType

    string

    データベースエンジンのタイプです。

    polardb
    EnvType

    string

    データベースが属する環境のタイプです。有効な値は次のとおりです：

    • product：本番環境

    • dev：開発環境

    • pre：ステージング環境

    • test：テスト環境

    • sit：SIT 環境

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

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

    • stag：STAG 環境

    dev
    InstanceId

    integer

    インスタンスの ID です。ListInstances 操作を呼び出すと、有効な値が返されます。このインスタンス ID は、RDS インスタンスの ID ではありません。

    4325325
    RegionId

    string

    インスタンスが存在するリージョンの ID です。

    cn-hangzhou
    InstanceResourceId

    string

    インスタンスリソース ID です。

    rm-xxx
    InstanceSource

    string

    データベースインスタンスのソースです。有効な値は次のとおりです：

    • PUBLIC_OWN：インターネット上にデプロイされた自己管理データベースインスタンス

    • RDS：ApsaraDB RDS インスタンス

    • ECS_OWN：Elastic Compute Service (ECS) インスタンスにデプロイされた自己管理データベース

    • VPC_IDC：Virtual Private Cloud (VPC) 経由で接続されたデータセンターにデプロイされた自己管理データベースインスタンス

    RDS

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "C5B8E84B-42B6-4374-AD5A-6264E1753378",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "DBTopology": {
    "LogicDbId": 1234,
    "LogicDbName": "logic_db_test",
    "SearchName": "logic_db_test",
    "Alias": "logic_db_test",
    "DbType": "polardb",
    "EnvType": "dev",
    "DBTopologyInfoList": [
      {
        "DbId": 423532,
        "SchemaName": "db_test@rm-xxx:3306",
        "CatalogName": "def",
        "SearchName": "db_test",
        "DbType": "polardb",
        "EnvType": "dev",
        "InstanceId": 4325325,
        "RegionId": "cn-hangzhou",
        "InstanceResourceId": "rm-xxx",
        "InstanceSource": "RDS"
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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