ListDatabases - 擷取資料庫列表

更新時間:
Copy as MD

擷取資料湖中資料庫列表,分頁查詢,可以根據資料庫名稱匹配。

調試

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

調試

授權資訊

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

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

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

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dlf:ListDatabases

list

*全部資源

*

請求文法

GET /api/metastore/catalogs/databases/list HTTP/1.1

請求參數

名稱

類型

必填

描述

樣本值

CatalogId

string

資料庫分類命名空間,預設填寫主帳號 Uid

1344371

NamePattern

string

資料庫名稱匹配的Regex,全部匹配則傳入.*

.*

NextPageToken

string

翻頁 token,由結果返回,如第一頁可傳入""

2cb472ec1bf84f8d92f9c4baa0d21c19aa!

PageSize

integer

每頁大小

10

  • NamePattern,待查詢的 db 名稱,支援**.***匹配,.表示匹配一個字元,*表示匹配 n 個字元

  • NextPageToken:分頁的開始位置,第一次填寫Null 字元串,後續的填寫上一次的 response 中返回的 NextPageToken,如果返回的 NextPageToken 為空白字串,那麼說明無資料了。

  • pagesize:一次返回的個數。

返回參數

名稱

類型

描述

樣本值

object

返回體

Code

string

狀態原因

OK

Databases

array

中繼資料庫列表

[{"name":"test"}]

Database

中繼資料庫查詢結果

Message

string

提示相關錯誤資訊

.

NextPageToken

string

翻頁 token

2cb472ec1bf84f8d92f9c4baa0d21c19aa

RequestId

string

請求 ID

558D764F-8C55-49CA-BF38-80EA532FC08F

Success

boolean

是否成功

true

Code 錯誤碼說明
InternalError:其他類型錯誤,請參考 Message 提示

樣本

正常返回樣本

JSON格式

{
  "Code": "OK",
  "Databases": [
    {
      "CreateTime": 1608707407,
      "Description": "this is a hive database",
      "LocationUri": "/hdfs/hivedb/data",
      "Name": "database_test",
      "OwnerName": "zhangsan",
      "OwnerType": "USER",
      "Parameters": {
        "key": "key"
      },
      "Privileges": {
        "GroupPrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        },
        "RolePrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        },
        "UserPrivileges": {
          "key": [
            {
              "CreateTime": 1606226844,
              "GrantOption": true,
              "Grantor": "Grantor",
              "GrantorType": "GrantorType",
              "Privilege": "Privilege"
            }
          ]
        }
      },
      "UpdateTime": 1608707407,
      "CreatedBy": "root"
    }
  ],
  "Message": ".",
  "NextPageToken": "2cb472ec1bf84f8d92f9c4baa0d21c19aa",
  "RequestId": "558D764F-8C55-49CA-BF38-80EA532FC08F",
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情