DescribeDatabaseObjects

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2022-01-20 14:40:19

Download PDF

1. API Description

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.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

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.

3. Output Parameters

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.

4. Example

Example1 Querying the information of database objects

Input Example

https://dcdb.tencentcloudapi.com/?Action=DescribeDatabaseObjects
&InstanceId=dcdbt-52s53yyh
&DbName=test
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "742443a5-4683-48ba-b30e-5151d26cf62d",
    "InstanceId": "dcdbt-52s53yyh",
    "DbName": "test",
    "Tables": [],
    "Views": [],
    "Procs": [
      {
        "Proc": "AddGeometryColumn"
      },
      {
        "Proc": "DropGeometryColumn"
      }
    ],
    "Funcs": []
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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.

Recent Pages