Domain name for API request: dcdb.tencentcloudapi.com.
This API is used to query the list of database objects in a TencentDB instance, including tables, stored procedures, views, and functions.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dcdb.ap-shanghai-fsi.tencentcloudapi.com
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common parameter. The value used for this API: DescribeDatabaseObjects. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-04-11. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| InstanceId | Yes | String | Instance ID in the format of dcdbt-ow7t8lmc. |
| DbName | Yes | String | Database name, which can be obtained through the DescribeDatabases API. |
| Parameter Name | Type | Description |
|---|---|---|
| InstanceId | String | Passed through from the input parameters. |
| DbName | String | Database name. |
| Tables | Array of DatabaseTable | List of tables. |
| Views | Array of DatabaseView | List of views. |
| Procs | Array of DatabaseProcedure | List of stored procedures. |
| Funcs | Array of DatabaseFunction | List of functions. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://dcdb.tencentcloudapi.com/?Action=DescribeDatabaseObjects
&InstanceId=dcdbt-52s53yyh
&DbName=test
&<Common request parameters>{
"Response": {
"RequestId": "742443a5-4683-48ba-b30e-5151d26cf62d",
"InstanceId": "dcdbt-52s53yyh",
"DbName": "test",
"Tables": [],
"Views": [],
"Procs": [
{
"Proc": "AddGeometryColumn"
},
{
"Proc": "DropGeometryColumn"
}
],
"Funcs": []
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError.CamAuthFailed | CAM authentication request failed. |
| InternalError.DbOperationFailed | Failed to query the database. |
| InternalError.GetDbObjectFailed | Failed to get the database objects. |
| InvalidParameter.GenericParameterError | An error occurred while verifying parameter validity. |
| ResourceUnavailable.InstanceAlreadyDeleted | The database instance has been dropped. |
| ResourceUnavailable.InstanceStatusAbnormal | Incorrect database instance status. Operations are not allowed. |
| UnauthorizedOperation.PermissionDenied | You have no permission to manipulate this API or resource. |
Was this page helpful?