查詢列信息。
接口說(shuō)明
- 地域的公網(wǎng)接入地址：
adb.<region-id>.aliyuncs.com。示例：adb.cn-hangzhou.aliyuncs.com。 - 地域的 VPC 接入地址：
adb-vpc.<region-id>.aliyuncs.com。示例：adb-vpc.cn-hangzhou.aliyuncs.com。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別：是指每個(gè)操作的訪問(wèn)級(jí)別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| adb:getTableColumns | get | *DBClusterLakeVersion acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId} |
| 無(wú) |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SchemaName | string | 否 | 數(shù)據(jù)庫(kù)名。 | adb_demo |
| TableName | string | 否 | 表名。 | test |
| ColumnName | string | 否 | 列名。 | assist_user_phone |
| PageNumber | long | 否 | 頁(yè)碼，取值為大于 0 且不超過(guò) Integer 數(shù)據(jù)類型的最大值。默認(rèn)值為 1。 | 1 |
| PageSize | long | 否 | 每頁(yè)記錄數(shù)，取值范圍如下：
| 30 |
| DBClusterId | string | 是 | 集群 ID。 | amv-bp11q28kvl688**** |
| RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 15,
"Data": {
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 15,
"Table": {
"SchemaName": "schemaName",
"TableName": "tableName",
"TableType": "PHYSICAL_SCHEMA_NAME",
"CreateTime": "2023-01-05 13:17:55",
"UpdateTime": "2023-01-05 13:17:55",
"Description": "Description",
"Owner": "abc",
"Columns": [
{
"ColumnName": "example",
"Type": "string",
"Description": "description",
"SchemaName": "schemaName",
"TableName": "tableName",
"CreateTime": "2023-01-05'T'13:17:55'Z'",
"UpdateTime": "2023-01-05'T'13:17:55'Z'",
"PartitionKey": true,
"Nullable": false,
"PrimaryKey": true,
"DistributeKey": false
}
],
"Catalog": "oss"
}
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | MDS.IllegalArgument | Invalid argument. | 用戶使用了非法參數(shù) |
| 400 | MDS.InvalidPrivilege | No permissions. | 用戶無(wú)權(quán)限進(jìn)行操作 |
| 400 | MDS.MetaSchemaAlreadyExist | The database already exists. | 數(shù)據(jù)庫(kù)已存在 |
| 400 | MDS.MetaSchemaNotExist | The database does not exist. | 操作的數(shù)據(jù)庫(kù)不存在 |
| 400 | MDS.MetaTableAlreadyExist | The table already exists. | 操作的表已經(jīng)存在 |
| 400 | MDS.MetaTableNotExist | The table is not found. | 操作的表不存在 |
| 500 | MDS.InternalError | An internal MDS error occurred. | MDS服務(wù)內(nèi)部錯(cuò)誤 |
| 500 | MDS.MetaVisitError | Failed to access metadata. | 訪問(wèn)元數(shù)據(jù)失敗 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2023-10-25 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-03-22 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |