调用DescribeColumns接口枚举实例下指定表格的列列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeColumns

系统规定参数，取值：DescribeColumns。
DBClusterId String 是 am-bp1xxxxxxxx47

实例ID。
SchemaName String 是 adb_demo

数据库名。
TableName String 是 test

表名。

返回数据

名称 类型 示例值 描述
Items Array of Column

列列表。
Column
AutoIncrementColumn Boolean true

是否自增。
ColumnName String id

列名。
DBClusterId String am-bp1xxxxxxxx47

实例ID。
PrimaryKey Boolean false

是否主键。
SchemaName String adb_demo

数据库名。
TableName String test

表名。
Type String bigint

列数据类型。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeColumns
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<Items>
    <Column>
        <TableName>test</TableName>
        <ColumnName>id</ColumnName>
        <Type>bigint</Type>
        <AutoIncrementColumn>true</AutoIncrementColumn>
        <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
        <PrimaryKey>false</PrimaryKey>
        <SchemaName>adb_demo</SchemaName>
    </Column>
    <Column>
        <TableName>test</TableName>
        <ColumnName>name</ColumnName>
        <Type>varchar</Type>
        <AutoIncrementColumn>false</AutoIncrementColumn>
        <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
        <PrimaryKey>false</PrimaryKey>
        <SchemaName>adb_demo</SchemaName>
    </Column>
    <Column>
        <TableName>test</TableName>
        <ColumnName>value</ColumnName>
        <Type>int</Type>
        <AutoIncrementColumn>false</AutoIncrementColumn>
        <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
        <PrimaryKey>false</PrimaryKey>
        <SchemaName>adb_demo</SchemaName>
    </Column>
    <Column>
        <TableName>test</TableName>
        <ColumnName>ts</ColumnName>
        <Type>timestamp</Type>
        <AutoIncrementColumn>false</AutoIncrementColumn>
        <DBClusterId>am-bp1xxxxxxxx47</DBClusterId>
        <PrimaryKey>false</PrimaryKey>
        <SchemaName>adb_demo</SchemaName>
    </Column>
</Items>

JSON 格式 

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "Items": {
        "Column": [
            {
                "TableName": "test",
                "ColumnName": "id",
                "Type": "bigint",
                "AutoIncrementColumn": true,
                "DBClusterId": "am-bp1xxxxxxxx47",
                "PrimaryKey": false,
                "SchemaName": "adb_demo"
            },
            {
                "TableName": "test",
                "ColumnName": "name",
                "Type": "varchar",
                "AutoIncrementColumn": false,
                "DBClusterId": "am-bp1xxxxxxxx47",
                "PrimaryKey": false,
                "SchemaName": "adb_demo"
            },
            {
                "TableName": "test",
                "ColumnName": "value",
                "Type": "int",
                "AutoIncrementColumn": false,
                "DBClusterId": "am-bp1xxxxxxxx47",
                "PrimaryKey": false,
                "SchemaName": "adb_demo"
            },
            {
                "TableName": "test",
                "ColumnName": "ts",
                "Type": "timestamp",
                "AutoIncrementColumn": false,
                "DBClusterId": "am-bp1xxxxxxxx47",
                "PrimaryKey": false,
                "SchemaName": "adb_demo"
            }
        ]
    }
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。

访问错误中心查看更多错误码。