全部產品
Search
文件中心

OpenSearch:ListDatabases - 展示已有資料庫

更新時間:Oct 15, 2025

展示已有的資料庫。

介面說明

方法

GET

URI

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

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

searchengine:ListDatabases

list

*Instance

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

請求文法

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

路徑參數

名稱

類型

必填

描述

樣本值

instanceId

string

執行個體 id

ha-cn-pl32rf0****

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱

類型

描述

樣本值

object

requestId

string

請求 ID。

E45380E8-994A-5402-9806-F114B3295FCF

result

object

返回結果。

databases

array<object>

資料庫資訊列表

array<object>

資料庫資訊列表

database

string

資料庫名稱

general

sqlInstances

array<object>

sql 執行個體資訊

object

sql 執行個體資訊

id

integer

主鍵 id

12190

name

string

sql 執行個體名稱

general

type

string

table, instance, template, function

instance

parent

integer

父任務 id。

-1

children

array

子目錄資訊

any

子目錄資訊

1

isDir

integer

是否為目錄。取值:-true:是-false:否

true

instanceId

integer

執行個體 id

1

templateId

integer

模板 ID。

1

templates

array<object>

模板資訊

object

模版資訊

id

integer

主鍵 id

1

name

string

模版名稱

c26_schema

type

string

table, instance, template, function

template

parent

integer

父節點 id。

-1

children

array

子目錄資訊

any

子目錄資訊

1

isDir

integer

是否為目錄。取值:-true:是-false:否

true

instanceId

integer

執行個體 id

1

templateId

integer

模板 ID。

1

functions

object

函數資訊。

array<object>

函數資訊。

object

函數資訊。

name

string

函數名稱

test

signatures

string

簽名

gfasdds2****2wfrkv

tables

array<object>

表資訊。

object

表資訊。

id

integer

主鍵 id

56

name

string

表名

general

type

string

table, instance, template, function

table

parent

integer

父節點 id。

-1

children

array

子目錄資訊

any

子目錄資訊

1

isDir

integer

是否為目錄。取值:-true:是-false:否

true

instanceId

integer

執行個體 ID

1

templateId

integer

模板 ID。

1

樣本

正常返回樣本

JSON格式

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "databases": [
      {
        "database": "general",
        "sqlInstances": [
          {
            "id": 12190,
            "name": "general",
            "type": "instance",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ],
        "templates": [
          {
            "id": 1,
            "name": "c26_schema",
            "type": "template",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ],
        "functions": {
          "key": [
            {
              "name": "test",
              "signatures": "gfasdds2****2wfrkv"
            }
          ]
        },
        "tables": [
          {
            "id": 56,
            "name": "general",
            "type": "table",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ]
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情