すべてのプロダクト
Search

このプロダクト

    Data Management:SearchTable

    ドキュメントセンター

    Data Management:SearchTable

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID です。

    説明

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

    1
    SearchKey

    string

    任意

    テーブルを照会するためのキーワードです。

    test
    PageNumber

    integer

    任意

    返されるページ番号です。

    1
    PageSize

    integer

    任意

    各ページに返されるエントリ数です。

    10
    EnvType

    string

    任意

    データベースが属する環境の種類です。詳細については、「インスタンスの環境タイプを変更する」をご参照ください。

    PRODUCT
    SearchRange

    string

    任意

    照会対象のテーブルの範囲です。有効な値は以下のとおりです。

    • HAS_PERMSSION：現在のアカウントが権限を持つテーブル

    • OWNER：現在のアカウントが所有するテーブル

    • MY_FOCUS：現在のアカウントがフォローしているテーブル

    • UNKNOWN：すべてのテーブル

    OWNER
    SearchTarget

    string

    任意

    照会対象のテーブルの種類です。有効な値は以下のとおりです。

    • TABLE：物理テーブルおよび論理テーブル

    • SINGLE_TABLE：物理テーブル

    • LOGIC_TABLE：論理テーブル

    LOGIC_TABLE
    DbType

    string

    任意

    データベースの種類です。有効な値は以下のとおりです。

    • MySQL

    • SQLServer

    • PostgreSQL

    • Oracle

    • DRDS

    • OceanBase

    • Mongo

    • Redis

    MySQL
    ReturnGuid

    boolean

    任意

    各テーブルの GUID を返すかどうかを指定します。

    false

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    SearchTableList

    object

    SearchTable

    array<object>

    テーブルの詳細情報です。

    array<object>

    TableId

    string

    テーブルの ID です。

    1
    Description

    string

    テーブルの説明文です。

    test
    DatabaseId

    string

    テーブルが属するデータベースの ID です。

    1
    Encoding

    string

    テーブルのエンコード形式です。

    utf8
    DBSearchName

    string

    テーブルが属するデータベースを検索するために使用する名前です。

    test
    EnvType

    string

    データベースが属する環境の種類です。

    test
    DbType

    string

    データベースの種類です。有効な値は以下のとおりです。

    • MySQL

    • SQLServer

    • PostgreSQL

    • Oracle

    • DRDS

    • OceanBase

    • Mongo

    • Redis

    mysql
    TableName

    string

    テーブルの名前です。

    test_table
    TableGuid

    string

    テーブルの GUID です。

    IDB_L_9032.db-test.yuyang_test
    TableSchemaName

    string

    テーブルが属するデータベースの名前です。

    test@xxx.xxx.xxx.xxx:3306
    DbName

    string

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

    test
    OwnerNameList

    object

    OwnerNames

    array

    テーブルオーナーのニックネームです。

    string

    テーブルオーナーのニックネームです。

    user
    Logic

    boolean

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

    • true：論理テーブルです。

    • false：論理テーブルではありません。

    false
    OwnerIdList

    object

    OwnerIds

    array

    テーブルオーナーの ID です。

    string

    テーブルオーナーの ID です。

    1
    Engine

    string

    テーブルのエンジンです。

    innodb
    TotalCount

    integer

    返されるエントリの合計数です。

    1
    RequestId

    string

    リクエストの ID です。

    1489257F-1B5D-4B5B-89EF-923C12CEEBD1
    ErrorCode

    string

    リクエストが失敗した場合に返されるエラーコードです。

    UnknownError
    ErrorMessage

    string

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

    UnknownError
    Success

    boolean

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "SearchTableList": {
    "SearchTable": [
      {
        "TableId": "1",
        "Description": "test",
        "DatabaseId": "1",
        "Encoding": "utf8",
        "DBSearchName": "test",
        "EnvType": "test",
        "DbType": "mysql",
        "TableName": "test_table",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "DbName": "test",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "Logic": false,
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Engine": "innodb"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    エラーコード

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

    変更履歴

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