You can call this operation to enumerate the columns of a specific table in a cluster.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeColumns |
The operation that you want to perform. Set the value to DescribeColumns. |
DBClusterId | String | Yes | am-bp1xxxxxxxx47 |
The ID of the cluster. |
SchemaName | String | Yes | adb_demo |
The name of the database. |
TableName | String | Yes | test |
The name of the table. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Items | Array of Column |
The list of columns. |
|
Column | |||
AutoIncrementColumn | Boolean | true |
Indicates whether the columns are auto-incremented. |
ColumnName | String | id |
The name of the column. |
DBClusterId | String | am-bp1xxxxxxxx47 |
The ID of the cluster. |
PrimaryKey | Boolean | false |
Indicates whether the column is a primary key. |
SchemaName | String | adb_demo |
The name of the database. |
TableName | String | test |
The name of the table. |
Type | String | bigint |
The data type of the column. |
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeColumns
&<Common request parameters>
Sample success responses
XML
format
<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
format
{
"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"
}
]
}
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The error message returned because the specified DBClusterId parameter does not exist. Check whether you specify the DBClusterId parameter correctly. |
For a list of error codes, visit the API Error Center.