すべてのプロダクト
Search

このプロダクト

    :GetSqlInstance

    ドキュメントセンター

    :GetSqlInstance

    最終更新日:Jun 17, 2026

    SQL インスタンス情報を取得します。

    操作説明

    メソッド

    GET

    URI

    /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId}

    インスタンスの ID、データベース名、および SQL インスタンスの ID を指定して、SQL インスタンス情報を取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:GetSqlInstance

    get

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエスト構文

    GET /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/sql-instances/{sqlInstanceId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****
    database

    string

    必須

    データベース名。

    general
    sqlInstanceId

    integer

    必須

    SQL インスタンス ID。

    5978

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    version

    integer

    任意

    インスタンスのバージョン。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    10D5E615-69F7-5F49-B850-00169ADE513C
    result

    object

    返された結果。

    gmtCreate

    string

    作成時間。

    1719220182844
    gmtModified

    string

    変更時間。

    1719221186114
    instanceId

    integer

    インスタンス ID。

    ha-cn-pl32rf0****
    version

    integer

    バージョン番号。

    1
    comment

    string

    備考。

    init version
    relatedTemplateId

    integer

    テンプレート ID。

    1
    content

    string

    SQL コンテンツ。

    select * from test
    kvpairs

    string

    キーと値のペアの解析結果。

    {\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
    dynamicParams

    string

    動的拡張パラメーター。

    {\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
    templateParams

    string

    テンプレートパラメーター。

    {\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
    staticParams

    string

    静的パラメーター。

    {\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}
    combineParams

    string

    結合パラメーター。

    {\"trace\":\"INFO\",\"databaseName\":\"general\",\"iquan.plan.cache.enable\":true,\"iquan.plan.prepare.level\":\"jni.post.optimize\",\"urlencode_data\":false,\"formatType\":\"string\",\"timeout\":1000}

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {
    "gmtCreate": "1719220182844",
    "gmtModified": "1719221186114",
    "instanceId": 0,
    "version": 1,
    "comment": "init version",
    "relatedTemplateId": 1,
    "content": "select * from test",
    "kvpairs": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "dynamicParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "templateParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "staticParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}",
    "combineParams": "{\\\"trace\\\":\\\"INFO\\\",\\\"databaseName\\\":\\\"general\\\",\\\"iquan.plan.cache.enable\\\":true,\\\"iquan.plan.prepare.level\\\":\\\"jni.post.optimize\\\",\\\"urlencode_data\\\":false,\\\"formatType\\\":\\\"string\\\",\\\"timeout\\\":1000}"
  }
}

    エラーコード

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

    変更履歴

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