tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDatabaseObjects

Last updated: 2024-11-20 12:14:51

    1. API Description

    Domain name for API request: mariadb.intl.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.

    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: 2017-03-12.
    Region Yes String Common Params. 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 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.

    4. Example

    Example1 Querying instance table objects

    Input Example

    https://mariadb.intl.tencentcloudapi.com/?Action=DescribeDatabaseObjects
&InstanceId=tdsql-e9tklsgz
&DbName=test
&<Common request parameters>

    Output Example

    {
    "Response": {
        "DbName": "test",
        "Funcs": [],
        "InstanceId": "tdsql-e9tklsgz",
        "Procs": [
            {
                "Proc": "AddGeometryColumn"
            },
            {
                "Proc": "DropGeometryColumn"
            }
        ],
        "RequestId": "a70c33e5-0c38-43a0-9953-234accd84d2a",
        "Tables": [
            {
                "Table": "region"
            }
        ],
        "Views": []
    }
}

    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

    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 object.
    ResourceUnavailable.InstanceAlreadyDeleted The database instance has been deleted.
    ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
    UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy