GetTableKnowledgeInfo - Data Management - Alibaba Cloud Documentation Center

Gets metadata knowledge for a specified GUID.

Operation description

This API can be called only for database instances that are enabled for security hosting.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:GetTableKnowledgeInfo	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TableSchemaName	string	No	The schema name of the table, which is required only for SQL Server instances.	dbo
DbId	integer	Yes	The ID of the physical database. You can call the SearchDatabase operation to obtain the ID.	325
TableName	string	Yes	The name of the table.	table_name

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. You can use the request ID to query logs and troubleshoot issues.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Table	TableKnowledgeInfo	The information about the table.	bill_orders

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "Success": true,
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Table": {
    "TableName": "",
    "Description": "",
    "AssetDescription": "",
    "Summary": "",
    "ColumnList": [
      {
        "ColumnName": "",
        "Description": "",
        "ColumnType": "",
        "Position": 0,
        "AssetDescription": "",
        "AssetModifiedGmt": ""
      }
    ],
    "AssetModifiedGmt": ""
  }
}

Error codes

For a list of error codes, visit the Service error codes.