使用DescribeColumns API擷取指定表的列資訊-雲資料庫 ClickHouse-阿里雲

查看列。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

clickhouse:DescribeColumns

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
DBClusterId	string	是	叢集 ID。	cc-2zeux3ua25242****
SchemaName	string	是	資料庫名。您可以通過調用介面 DescribeSchemas 查詢資料庫名。	database
TableName	string	是	表名。您可以通過調用介面 DescribeTables 查詢表名。	table

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	66428721-FFEC-5023-B4E5-3BD1B67837E0
Items	object
Column	array<object>	列資訊。
	object	列資訊。
Type	string	列類型。	String
ColumnName	string	列名。	name
TableName	string	表名。	table
AutoIncrementColumn	boolean	列是否自增，取值說明： true：自增。 false：不自增。	true
DBClusterId	string	叢集 ID。	cc-2zeux3ua25242****
PrimaryKey	boolean	列是否為主鍵，取值說明： true：主鍵。 false：非主鍵。	true
SchemaName	string	資料庫名。	database

樣本

正常返回樣本

JSON格式

{
  "RequestId": "66428721-FFEC-5023-B4E5-3BD1B67837E0",
  "Items": {
    "Column": [
      {
        "Type": "String",
        "ColumnName": "name",
        "TableName": "table",
        "AutoIncrementColumn": true,
        "DBClusterId": "cc-2zeux3ua25242****",
        "PrimaryKey": true,
        "SchemaName": "database"
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
500	InternalError	An error occurred while processing your request.	系統內部錯誤，請稍後重試
503	ServiceUnavailable	An error occurred while processing your request.	系統暫時不可用，請稍後重試

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

變更歷史

更多資訊，參考變更詳情。