tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLPostgreSQL for Serverless APIsDescribeServerlessDBInstances
DescribeServerlessDBInstances
Last updated: 2024-06-17 14:25:58
DescribeServerlessDBInstances
Last updated: 2024-06-17 14:25:58

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 1000 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: DescribeServerlessDBInstances.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
Filter.N No Array of Filter Query criteria. Query using one or more filter criteria. Filter criteria type (specified by the name field) currently supported include:

- db-instance-id: filter by instance ID (in string format)
- db-instance-name: filter by instance name (in string format)
- db-tag-key: filter by instance tag (in string format)

The value field specifies the specific instance ID/instance name/instance tag-key to filter under this type of filter criteria.
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, 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 the list of PostgreSQL for Serverless instances

Input Example

POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeServerlessDBInstances
<Common request parameters>

{
    "Filter": [
        {
            "Name": "\"xxx\","
        }
    ],
    "Limit": "0",
    "Offset": "1"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "DBInstanceSet": [
            {
                "DBInstanceId": "postgres-xxxxxxxx",
                "DBInstanceName": "xxx",
                "DBInstanceStatus": "running",
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-3",
                "ProjectId": 0,
                "VpcId": "vpc-xxxxxxxx",
                "SubnetId": "subnet-xxxxxxxx",
                "DBCharset": "UTF8",
                "DBVersion": "10",
                "DBKernelVersion": "v10.4_r1.0",
                "CreateTime": "2020-03-20 12:19:14",
                "DBInstanceNetInfo": [
                    {
                        "Address": "",
                        "Ip": "10.10.10.111",
                        "Port": 5432,
                        "Status": "opened",
                        "NetType": "private"
                    },
                    {
                        "Address": "",
                        "Ip": "",
                        "Port": 0,
                        "Status": "initing",
                        "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.DatabaseAffectedError Data operation failed. 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.InternalHttpServerError An exception occurred while executing the request.
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.DataConvertError Failed to convert data format. Please contact customer service.
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.
UnsupportedOperation The operation is not supported.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

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

Contact Us
Technical Support

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

Submit a Ticket
7x24 Phone Support