查詢表信息。
接口說明
- 地域的公網接入地址：
adb.<region-id>.aliyuncs.com。示例：adb.cn-hangzhou.aliyuncs.com。 - 地域的 VPC 接入地址：
adb-vpc.<region-id>.aliyuncs.com。示例：adb-vpc.cn-hangzhou.aliyuncs.com。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| adb:getTableObjects | get | *DBClusterLakeVersion acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId} |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SchemaName | string | 否 | 數據庫名稱。 | adb_demo |
| OrderBy | string | 否 | 排序字段。 類型取值：
域取值： -TableName； -TableSize； -CreateTime; -UpdateTime; 默認值：{"Type": "Desc","Field": "TableName"}； | {"Type": "Desc","Field": "TableName"} |
| FilterTblName | string | 否 | 表名。 | test_tbl |
| PageNumber | long | 否 | 頁碼，取值為大于 0 且不超過 Integer 數據類型的最大值。默認值為 1。 | 1 |
| PageSize | long | 否 | 每頁記錄數，取值：
默認值：30。 | 30 |
| DBClusterId | string | 是 | 集群 ID。 | am-bp1565u55p32**** |
| FilterTblType | string | 否 | 表類型。 取值： -DIMENSION_TABLE -FACT_TABLE -EXTERNAL_TABLE 默認值：空 | FACT_TABLE |
| FilterOwner | string | 否 | 所有者。 | admin |
| FilterDescription | string | 否 | 描述。 | description |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "863D51B7-5321-41D8-A0B6-A088B0******",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1,
"Data": {
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1,
"TableSummaryModels": [
{
"SchemaName": "schemaName",
"TableName": "tableName",
"TableType": "PHYSICAL_SCHEMA_NAME",
"TableSize": 1234,
"CreateTime": "2023-01-05 13:17:55",
"UpdateTime": "2023-01-05 13:17:55",
"SQL": "create table(a varchar)",
"Description": "descrtiption",
"Owner": "abc"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | MDS.IllegalArgument | Invalid argument. | 用戶使用了非法參數 |
| 400 | MDS.InvalidPrivilege | No permissions. | 用戶無權限進行操作 |
| 400 | MDS.MetaSchemaAlreadyExist | The database already exists. | 數據庫已存在 |
| 400 | MDS.MetaSchemaNotExist | The database does not exist. | 操作的數據庫不存在 |
| 400 | MDS.MetaTableAlreadyExist | The table already exists. | 操作的表已經存在 |
| 400 | MDS.MetaTableNotExist | The table is not found. | 操作的表不存在 |
| 500 | MDS.InternalError | An internal MDS error occurred. | MDS服務內部錯誤 |
| 500 | MDS.MetaVisitError | Failed to access metadata. | 訪問元數據失敗 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-08-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-25 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-03-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |