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.
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 Params. The value used for this API: DescribeDatabaseObjects. |
Version | Yes | String | Common Params. The value used for this API: 2018-04-11. |
Region | No | String | Common Params. This parameter is not required for this API. |
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 input parameters. |
DbName | String | Database name. |
Tables | Array of DatabaseTable | Table list. |
Views | Array of DatabaseView | View list. |
Procs | Array of DatabaseProcedure | Stored procedure list. |
Funcs | Array of DatabaseFunction | Function list. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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": []
}
}
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?