DescribeServerlessDBInstances

Last updated: 2021-03-01 17:01:03

1. API Description

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

This API is used to query the details of one or more PostgreSQL for Serverless instances.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeServerlessDBInstances.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Filter.N No Array of Filter Query conditions
Limit No Integer The number of queries
Offset No Integer The offset value
OrderBy No String Sorting metric. Currently, only "CreateTime" (instance creation time) is supported.
OrderByType No String Sorting order. Ascending and descending are supported.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer The number of query results
DBInstanceSet Array of ServerlessDBInstance Query results
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the list of PostgreSQL for Serverless instances

Input Example

https://postgres.tencentcloudapi.com/?Action=DescribeServerlessDBInstances
&Filter.0.Name="xxx",
&Limit=0
&Offset=1
&<Common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "DBInstanceSet": [
      {
        "DBInstanceId": "postgres-gqmunix5",
        "DBInstanceName": "anita_10",
        "DBInstanceStatus": "initing",
        "Region": "ap-guangzhou",
        "Zone": "ap-guangzhou-3",
        "ProjectId": 0,
        "VpcId": "vpc-0mocsnzb",
        "SubnetId": "subnet-mutl5yka",
        "DBCharset": "UTF8",
        "DBVersion": "10.4",
        "CreateTime": "2020-03-20 12:19:14",
        "DBInstanceNetInfo": [
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "opened",
            "NetType": "private"
          },
          {
            "Address": "",
            "Ip": "",
            "Port": 0,
            "Status": "0",
            "NetType": "public"
          }
        ],
        "DBAccountSet": [],
        "DBDatabaseList": null
      }
    ],
    "RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8"
  }
}

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
AuthFailure.UnauthorizedOperation Authentication failed.
DBError Backend database execution error.
FailedOperation.CamAuthFailed CAM authentication failed.
FailedOperation.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
InterfaceNameNotFound ACTION input error.
InternalError Internal error.
InternalError.DBError Backend database execution error.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidParameter Parameter error.
InvalidParameter.VpcNotFoundError Failed to query VPC information.
InvalidParameterValue.IllegalProjectId Invalid ProjectId.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
ResourceUnavailable.VpcResourceNotFound Failed to get the information of the VPC where the instance resides.
StructParseFailed An error occurred while parsing parameters.
SystemError System error. When this error occurs, please contact customer service for assistance.
UnknownError Unknown error. When this error occurs, please contact customer service for assistance.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help