调用DescribeTableDetail接口查看表结构详情。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeTableDetail |
系统规定参数。取值为DescribeTableDetail。 |
| DBInstanceName | String | 是 | pxc-**************** |
实例ID。 |
| DbName | String | 是 | db2 |
数据库名称。 |
| RegionId | String | 是 | cn-hangzhou |
实例所在地域。 |
| TableName | String | 是 | test |
目标表名称。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Data | Struct |
表信息。 |
|
| Fields | Array of Field |
表字段信息。 |
|
| Column | String | Id |
列名。 |
| DataType | String | varchar(20) |
列的数据类型。 |
| Extra | String | auto_increment |
列的其他信息，如是否自动增长（auto_increment）。 |
| Key | String | PRI |
键的类型，取值为PRI（即主键）或空值（即该列为普通字段）。 |
| Message | String | **** |
请求返回消息。
说明 请求成功时该参数为空，请求失败时会返回请求异常信息（如错误码等）。
|
| RequestId | String | C606E5AC-DD01-4515-BDC4-299A9****** |
请求ID。 |
| Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeTableDetail
&DBInstanceName=pxc-****************
&DbName=db2
&RegionId=cn-hangzhou
&TableName=test
&<公共请求参数>正常返回示例
XML 格式
<code>200</code>
<data>
<RequestId>C606E5AC-DD01-4515-BDC4-299A9******</RequestId>
<Message/>
<Data>
<Fields>
<Extra/>
<Column>Address</Column>
<DataType>varchar(20)</DataType>
<Key/>
</Fields>
<Fields>
<Extra>auto_increment</Extra>
<Column>Id</Column>
<DataType>bigint(20)</DataType>
<Key>PRI</Key>
</Fields>
<Fields>
<Extra/>
<Column>Name</Column>
<DataType>varchar(20)</DataType>
<Key/>
</Fields>
</Data>
<Success>true</Success>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>C606E5AC-DD01-4515-BDC4-299A9******</requestId>
<successResponse>true</successResponse>JSON 格式
{
"code": "200",
"data": {
"RequestId": "C606E5AC-DD01-4515-BDC4-299A9******",
"Message": "",
"Data": {
"Fields": [{
"Extra": "",
"Column": "Address",
"DataType": "varchar(20)",
"Key": ""
}, {
"Extra": "auto_increment",
"Column": "Id",
"DataType": "bigint(20)",
"Key": "PRI"
}, {
"Extra": "",
"Column": "Name",
"DataType": "varchar(20)",
"Key": ""
}]
},
"Success": true
},
"httpStatusCode": "200",
"requestId": "C606E5AC-DD01-4515-BDC4-299A9******",
"successResponse": true
}错误码
访问错误中心查看更多错误码。
