tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for PostgreSQLInstance APIsDescribeDBInstances
DescribeDBInstances
Last updated: 2024-06-17 14:26:26
DescribeDBInstances
Last updated: 2024-06-17 14:26:26

1. API Description

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

This API is used to query the details of one or more 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: DescribeDBInstances.
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.
Filters.N No Array of Filter Query using one or more filter criteria. Filter criteria currently supported include:
db-instance-id: filter by instance ID (in string format)
db-instance-name: filter by instance name (in string format)
db-project-id: filter by project ID (in string format)
db-pay-mode: filter by instance billing mode (in string format)
db-tag-key: filter by tag key (in string format)
db-private-ip: filter by instance VPC IP (in string format)
db-public-address: filter by instance public network address (in string format)
Limit No Integer The maximum number of results returned per page. Value range: 1-100. Default: 10
Offset No Integer Data offset, which starts from 0.
OrderBy No String Sorting metric, such as instance name or creation time. Valid values: DBInstanceId, CreateTime, Name, EndTime
OrderByType No String Sorting order. Valid values: asc (ascending), desc (descending)

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Number of instances found.
DBInstanceSet Array of DBInstance Instance details set.
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 All Instances

This example shows you how to query the instance list by specified paging

Input Example

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

{
    "Limit": "10",
    "Offset": "0"
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "DBInstanceSet": [
            {
                "Zone": "ap-guangzhou-2",
                "DBInstanceName": "xxx",
                "DBNodeSet": [
                    {
                        "Role": "Primary",
                        "Zone": "ap-guangzhou-2"
                    }
                ],
                "Type": 1,
                "IsSupportTDE": 0,
                "DBMajorVersion": "10",
                "ReadOnlyInstanceNum": 1,
                "MasterDBInstanceId": "",
                "UpdateTime": "2020-09-22 00:00:00",
                "VpcId": "vpc-xxxxxxxx",
                "IsolatedTime": "2020-09-22 00:00:00",
                "DBVersion": "10",
                "DBKernelVersion": "v10.4_r1.0",
                "DBInstanceVersion": "standard",
                "AutoRenew": 1,
                "StatusInReadonlyGroup": "running",
                "SubnetId": "subnet-xxxxxxxx",
                "DBInstanceMemory": 1,
                "DBInstanceType": "primary",
                "DBInstanceStatus": "running",
                "OfflineTime": "2019-12-28 19:23:19",
                "Region": "ap-guangzhou",
                "ProjectId": 1,
                "DBInstanceNetInfo": [
                    {
                        "Address": "",
                        "Ip": "10.10.10.220",
                        "Port": 5432,
                        "Status": "opened",
                        "NetType": "private",
                        "VpcId": "vpc-xxxxxxxx",
                        "SubnetId": "subnet-xxxxxxxx"
                    },
                    {
                        "Address": "",
                        "Ip": "",
                        "Port": 0,
                        "Status": "",
                        "NetType": "public",
                        "VpcId": "",
                        "SubnetId": ""
                    }
                ],
                "DBInstanceStorage": 1,
                "Uid": 1,
                "DBCharset": "UTF8",
                "DBInstanceId": "postgres-xxxxxxxx",
                "PayType": "prepaid",
                "ExpireTime": "2020-09-22 00:00:00",
                "SupportIpv6": 1,
                "AppId": 1,
                "DBInstanceClass": "cdb.pg.z1.4g",
                "CreateTime": "2020-09-22 00:00:00",
                "DBInstanceCpu": 1,
                "TagList": [
                    {
                        "TagKey": "tag1",
                        "TagValue": "v1"
                    }
                ],
                "NetworkAccessList": []
            }
        ],
        "RequestId": "d849664a-191c-48bf-b42f-444caa189557"
    }
}

Example2 Querying Instance Information by ID

This example shows you how to query, for example, the details of the instance with the ID postgres-xxxxx.

Input Example

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

{
    "Limit": "10",
    "Filters": [
        {
            "Values": [
                "postgres-xxxxx"
            ],
            "Name": "db-instance-id"
        }
    ],
    "Offset": "0"
}

Output Example

{
    "Response": {
        "RequestId": "d849664a-191c-48bf-b42f-444caa189557",
        "TotalCount": 1,
        "DBInstanceSet": [
            {
                "Region": "ap-guangzhou",
                "Zone": "ap-guangzhou-2",
                "AppId": 100000000,
                "Uid": 1000001,
                "ProjectId": 0,
                "VpcId": "vpc-xxxxxxxx",
                "SubnetId": "subnet-xxxxxxxx",
                "Type": 1,
                "DBNodeSet": [
                    {
                        "Role": "Primary",
                        "Zone": "ap-guangzhou-2"
                    }
                ],
                "DBInstanceId": "postgres-xxxxxxxx",
                "MasterDBInstanceId": "",
                "DBInstanceName": "test",
                "DBInstanceStatus": "running",
                "DBInstanceMemory": 4,
                "DBInstanceStorage": 20,
                "DBInstanceCpu": 2,
                "DBInstanceClass": "cdb.pg.z1.4g",
                "DBInstanceType": "primary",
                "DBInstanceVersion": "standard",
                "DBInstanceNetInfo": [
                    {
                        "Address": "",
                        "Ip": "10.10.10.220",
                        "Port": 5432,
                        "Status": "opened",
                        "NetType": "private",
                        "VpcId": "vpc-xxxxxxxx",
                        "SubnetId": "subnet-xxxxxxxx"
                    },
                    {
                        "Address": "",
                        "Ip": "",
                        "Port": 0,
                        "Status": "",
                        "NetType": "public",
                        "VpcId": "",
                        "SubnetId": ""
                    }
                ],
                "DBCharset": "UTF8",
                "DBVersion": "10",
                "IsSupportTDE": 0,
                "DBMajorVersion": "10",
                "DBKernelVersion": "v10.4_r1.0",
                "CreateTime": "2017-12-28 19:23:19",
                "UpdateTime": "2018-01-18 15:54:32",
                "ExpireTime": "2018-01-28 19:23:23",
                "IsolatedTime": "0000-00-00 00:00:00",
                "OfflineTime": "2019-12-28 19:23:19",
                "StatusInReadonlyGroup": "running",
                "ReadOnlyInstanceNum": 1,
                "PayType": "prepaid",
                "AutoRenew": 1,
                "SupportIpv6": 0,
                "TagList": [
                    {
                        "TagKey": "tag1",
                        "TagValue": "v1"
                    }
                ],
                "NetworkAccessList": []
            }
        ]
    }
}

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.
FailedOperation.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamCheckResourceFailed Failed to check resource permissions through CAM.
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.
FailedOperation.LimitOperation Operations are not allowed on the instance.
FailedOperation.OssAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
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.
InternalError.TransactioBeginError Failed to enable transactions
InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
InvalidParameter Parameter error.
InvalidParameterValue.DataConvertError Failed to convert data format. Please contact customer service.
InvalidParameterValue.IllegalRegion Invalid Region parameter.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.InvalidRegionIdError Invalid region
InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
InvalidParameterValue.RegionNotSupported The current region is not supported.
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
OperationDenied.CamDeniedError This operation cannot be performed.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.
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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon