DescribeDBs

Last updated: 2019-09-09 14:59:27

PDF

1. API Description

API domain name: sqlserver.tencentcloudapi.com.

This API (DescribeDBs) describes the database list.

API request rate limit: 20 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The name of this API: DescribeDBs
Version Yes String Common parameter. The version of this API: 2018-03-28
Region Yes String Common parameter. For more information, see the list of regions supported by the product.
InstanceIdSet.N Yes Array of String Instance ID
Limit No Integer Number of results per page; up to 100; 20 by default
Offset No Integer Page number, starting at 0

3. Output Parameters

Parameter name Type Description
TotalCount Integer Number of databases
DBInstances Array of InstanceDBDetail Databases instance list
RequestId String The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Samples

Sample 1. Querying the Database List

Input Sample Code

https://sqlserver.tencentcloudapi.com/?Action=DescribeDBs
&InstanceId.0=mssql-njj2mtpl
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "RequestId": "5062de55-d048-4d3b-92f9-b98b6f244360",
    "TotalCount": 1,
    "DBInstances": [
      {
        "InstanceId": "mssql-632eyp63",
        "DBDetails": [
          {
            "Name": "ceshi1",
            "Charset": "Chinese_PRC_CI_AS",
            "Remark": "Test db1",
            "CreateTime": "2018-07-02 20:12:24",
            "Status": 2,
            "Accounts": [
              {
                "UserName": "victorwind",
                "Privilege": "ReadWrite"
              }
            ],
            "InternalStatus": "ONLINE"
          }
        ]
      }
    ]
  }
}

5. Developer Resources

API Explorer

This tool provides various capabilities such as online call, signature verification, SDK code generation, and quick API retrieval that significantly reduce the difficulty of using TencentCloud API.

SDK

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

TCCLI

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError.SystemError System error.
InvalidParameter.InputIllegal Invalid input.
InvalidParameter.ParamsAssertFailed Parameter assertion conversion error.
ResourceNotFound.InstanceNotFound The instance does not exist.