すべてのプロダクト
Search

このプロダクト

    Data Management:SearchDatabase

    ドキュメントセンター

    Data Management:SearchDatabase

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

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID。テナント ID を取得するには、GetUserActiveTenant 操作を呼び出します。

    3***
    SearchKey

    string

    任意

    データベースを検索するためのキーワード。

    testdb
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1ページあたりのエントリ数。

    10
    EnvType

    string

    任意

    データベースの環境タイプ。詳細については、「インスタンス環境の説明」をご参照ください。

    test
    SearchRange

    string

    任意

    権限スコープ。有効な値は次のとおりです。

    • HAS_PERMSSION: 権限を持つデータベース。

    • OWNER: 所有するデータベース。

    • MY_FOCUS: フォローしているデータベース。

    • UNKNOWN: すべてのデータベース。

    HAS_PERMSSION
    SearchTarget

    string

    任意

    検索対象。有効な値は次のとおりです。

    • DB: 物理データベースと論理データベースを含むすべてのデータベース。

    • SINGLE_DB: 物理データベース。

    • LOGIC_DB: 論理データベース。

    SINGLE_DB
    DbType

    string

    任意

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

    MYSQL
    RealLoginUserUid

    string

    任意

    クエリ結果のソート方法。有効な値は次のとおりです。

    • LAST_ACTIVE_TIME: 最終アクティブ時間で結果をソートします。

    • DB_NAME: データベース名で結果をソートします。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    フィルター条件に一致するエントリの総数。

    1
    RequestId

    string

    リクエスト ID。

    E0D21075-CD3E-4D98-8264-FD8AD04A63B6
    SearchDatabaseList

    object

    SearchDatabase

    array<object>

    データベースのリスト。

    array<object>

    データベースの詳細。

    DatabaseId

    string

    データベース ID。

    2528****
    Host

    string

    データベースへの接続に使用されるエンドポイント。

    rm-xxxx.mysql.rds.aliyuncs.com
    DbaId

    string

    インスタンスのデータベース管理者 (DBA) の ID。

    10****
    SchemaName

    string

    データベース名。

    test
    Logic

    boolean

    データベースが論理データベースであるかどうかを示します。有効な値は次のとおりです。

    • true: データベースは論理データベースです。

    • false: データベースは論理データベースではありません。

    false
    DatalinkName

    string

    クロスデータベースクエリ用のデータベースリンク名。

    datalink_name
    Port

    integer

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

    3306
    EnvType

    string

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

    test
    Sid

    string

    インスタンスのシステム ID (SID)。

    testSid
    OwnerIdList

    object

    OwnerIds

    array

    データベース所有者の ID。

    string

    データベース所有者の ID。

    1
    Encoding

    string

    データベースで使用される文字セット。

    utf8
    DbType

    string

    データベースのタイプ。

    mysql
    OwnerNameList

    object

    OwnerNames

    array

    データベース所有者のニックネーム。

    string

    データベース所有者のニックネーム。

    user1
    SearchName

    string

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

    test@xxx.xxx.xxx.xxx:3306
    Alias

    string

    データベースのエイリアス。

    test_rds
    CatalogName

    string

    データベースカタログ名。

    説明

    PostgreSQL データベースの場合、データベース名が返されます。

    dmstest
    ErrorCode

    string

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

    UnknownError
    ErrorMessage

    string

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

    UnknownError
    Success

    boolean

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

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList": {
    "SearchDatabase": [
      {
        "DatabaseId": "2528****",
        "Host": "rm-xxxx.mysql.rds.aliyuncs.com",
        "DbaId": "10****",
        "SchemaName": "test",
        "Logic": false,
        "DatalinkName": "datalink_name",
        "Port": 3306,
        "EnvType": "test",
        "Sid": "testSid",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user1"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306",
        "Alias": "test_rds",
        "CatalogName": "dmstest"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    エラーコード

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

    変更履歴

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