文档

DescribeColumns - 查看列

更新时间:

查看列。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

cc-2zeux3ua25242****
SchemaNamestring

数据库名。您可以通过调用接口 DescribeSchemas 查询数据库名。

database
TableNamestring

表名。您可以通过调用接口 DescribeTables 查询表名。

table

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

66428721-FFEC-5023-B4E5-3BD1B67837E0
Itemsobject []

列信息。

Typestring

列类型。

String
ColumnNamestring

列名。

name
TableNamestring

表名。

table
AutoIncrementColumnboolean

列是否自增,取值说明:

  • true:自增。
  • false:不自增。
true
DBClusterIdstring

集群 ID。

cc-2zeux3ua25242****
PrimaryKeyboolean

列是否为主键,取值说明:

  • true:主键。
  • false:非主键。
true
SchemaNamestring

数据库名。

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错误码错误信息描述
500InternalErrorAn error occurred while processing your request.系统内部错误,请稍后重试
503ServiceUnavailableAn error occurred while processing your request.系统暂时不可用,请稍后重试

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈