tencent cloud



Last updated: 2022-08-16 16:32:43

1. API Description

Domain name for API request: sqlserver.tencentcloudapi.com.

This API is used to query database configurations. It does not return information of the accounts that have permissions to operate the database.

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: DescribeDBsNormal.
Version Yes String Common Params. The value used for this API: 2018-03-28.
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 mssql-7vfv3rk3

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of databases of the instance
DBList Array of DbNormalDetail Detailed database configurations, such as whether CDC or CT is enabled for the database
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying detailed database configurations

Input Example

&<Common request parameters>

Output Example

    "Response": {
        "TotalCount": 1,
        "DBList": [
                "IsFulltextEnabled": "0",
                "UserAccessDesc": "MULTI_USER",
                "IsMirroring": "1",
                "CollationName": "Chinese_PRC_CI_AS",
                "RecoveryModelDesc": "FULL",
                "IsSubscribed": "1",
                "StateDesc": "ONLINE",
                "IsCdcEnabled": "1",
                "MirroringState": "SYNCHRONIZED",
                "IsPublished": "1",
                "RetentionPeriod": "20",
                "IsDbChainingOn": "1",
                "IsEncrypted": "0",
                "IsTrustworthyOn": "1",
                "IsReadCommittedSnapshotOn": "0",
                "IsBrokerEnabled": "1",
                "IsAutoCleanupOn": "1",
                "Name": "db_test"
        "RequestId": "9607d890-db08-11eb-9f54-a9df121c01af"

5. Developer Resources


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
FailedOperation.GcsError The operation failed or the network timed out.
InternalError.DBError Database error
InternalError.GcsError GCS API error.
InternalError.SystemError System error.
InvalidParameter.InputIllegal Input error.
InvalidParameter.InterfaceNameNotFound The API does not exist.
ResourceNotFound.InstanceNotFound The instance does not exist.
UnauthorizedOperation.PermissionDenied CAM authentication error.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support