Obtain table schema information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeTable

The operation that you want to perform. Set the value to DescribeTable.

DbName String Yes drds_flashback

The name of the DRDS database.

DrdsInstanceId String Yes drdshbga76******

The ID of the DRDS instance.

TableName String Yes employee_split

Table name

RegionId String No cn-hangzhou

RegionId

Response parameters

Prameter Type Sample response Description
Data

Response parameters

List

Returned data set

ColumnName String Id

Column name

ColumnType String bigint(20)

Column type

Extra String auto_increment

Extra

Index String PRI

Primary Key Field

IsAllowNull String NO

Allow empty

IsPk String YES

Primary key

RequestId String 5DC75BC2-3F3F-4FE5-8DC9-2A808B******

The unique ID of the request. If any problem occurs, provide this request ID for troubleshooting.

Success Boolean true

Indicates whether the API request is successful.

Examples

Sample request


http(s)://[Endpoint]/? Action=DescribeTable
& <Common request parameters>

Sample success responses

XML format

<DescribeTableResponse>
	  <code>200</code>
	  <data>
		    <RequestId>5DC75BC2-3F3F-4FE5-8DC9-2A808B******</RequestId>
		    <Data>
			      <List>
				        <ColumnName>Id</ColumnName>
				        <ColumnType>bigint(20)</ColumnType>
				        <Extra>auto_increment</Extra>
				        <IsAllowNull>NO</IsAllowNull>
				        <IsPk>YES</IsPk>
				        <Index>PRI</Index>
			      </List>
			      <List>
				        <ColumnName>Name</ColumnName>
				        <ColumnType>varchar(20)</ColumnType>
				        <Extra></Extra>
				        <IsAllowNull>NO</IsAllowNull>
				        <IsPk>NO</IsPk>
				        <Index></Index>
			      </List>
			      <List>
				        <ColumnName>Address</ColumnName>
				        <ColumnType>varchar(20)</ColumnType>
				        <Extra></Extra>
				        <IsAllowNull>NO</IsAllowNull>
				        <IsPk>NO</IsPk>
				        <Index></Index>
			      </List>
		    </Data>
		    <Success>true</Success>
	  </data>
	  <requestId>5DC75BC2-3F3F-4FE5-8DC9-2A808B******</requestId>
	  <successResponse>true</successResponse>
</DescribeTableResponse>

JSON format

{
	"successResponse":true,
	"requestId":"5DC75BC2-3F3F-4FE5-8DC9-2A808B******",
	"data":{
		"Data":{
			"List":[
				{
					"IsPk":"YES",
					"Extra":"auto_increment",
					"Index":"PRI",
					"IsAllowNull":"NO",
					"ColumnType":"bigint(20)",
					"ColumnName":"Id"
				},
				{
					"IsPk":"NO",
					"Extra":"",
					"Index":"",
					"IsAllowNull":"NO",
					"ColumnType":"varchar(20)",
					"ColumnName":"Name"
				},
				{
					"IsPk":"NO",
					"Extra":"",
					"Index":"",
					"IsAllowNull":"NO",
					"ColumnType":"varchar(20)",
					"ColumnName":"Address"
				}
			]
		},
		"RequestId":"5DC75BC2-3F3F-4FE5-8DC9-2A808B******",
		"Success":true
	},
	"code":"200"
}

Error codes

For a list of error codes, visit the API Error Center.