すべてのプロダクト
Search

このプロダクト

    Data Management:GetDatabase

    ドキュメントセンター

    Data Management:GetDatabase

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

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナントの ID。 GetUserActiveTenant API を呼び出してこの ID を取得できます。

    -1
    Host

    string

    必須

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

    192.168.XX.XX
    Port

    integer

    必須

    データベース接続ポート。

    3306
    Sid

    string

    任意

    データベースの SID。

    説明

    データベース SID は、Oracle データベースの一意の識別子です。

    test_sid
    SchemaName

    string

    必須

    データベース名。

    mysql
    RealLoginUserUid

    string

    任意

    なし。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    3CDB8601-AD74-4A47-8114-08E08CD6****
    Database

    object

    データベースの詳細。

    DatabaseId

    string

    データベース ID。

    984****
    Host

    string

    データベースエンドポイント。

    192.168.XX.XX
    CatalogName

    string

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

    def
    DbaName

    string

    DBA のニックネーム。

    dba_name
    State

    string

    データベースの状態。有効な値：

    • NORMAL：データベースは実行中です。

    • DISABLED：データベースは無効です。

    • OFFLINE：データベースはオフラインです。

    • NOT_EXIST：データベースは存在しません。

    NORMAL
    DbaId

    string

    DBA のユーザー ID。

    27****
    SchemaName

    string

    スキーマ名。

    mysql
    InstanceId

    string

    インスタンス ID。

    149****
    Port

    integer

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

    3306
    EnvType

    string

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

    • product：本番環境

    • dev：開発環境

    • pre：プレリリース環境

    • test：テスト環境

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

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

    • pet：パフォーマンステスト

    • stag：ステージング環境

    product
    Sid

    string

    データベースの SID。

    説明

    このパラメーターは、Oracle データベースの場合にのみ返されます。

    test_sid
    OwnerIdList

    object

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

    OwnerIds

    array

    データベース所有者のユーザー ID のリスト。

    string

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

    27****
    Encoding

    string

    文字セット。

    utf8mb4
    DbType

    string

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

    mysql
    OwnerNameList

    object

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

    OwnerNames

    array

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

    string

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

    test
    SearchName

    string

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

    mysql@192.168.XX.XX:3306
    InstanceAlias

    string

    インスタンスのエイリアス。

    test
    ErrorCode

    string

    エラーコード。

    UnknownError
    ErrorMessage

    string

    エラーメッセージ。

    An unknown error occurred.
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

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

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

    true

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "Success": true
}

    エラーコード

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

    変更履歴

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