Domain name for API request: postgres.intl.tencentcloudapi.com.
This API is used to query the database list of an instance.
A maximum of 1000 requests can be initiated per second for this API.
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: DescribeDatabases. |
| Version | Yes | String | Common Params. The value used for this API: 2017-03-12. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| DBInstanceId | Yes | String | Instance ID. obtain through the API DescribeDBInstances. |
| Filters.N | No | Array of Filter | Query using one or more filter criteria. Filter criteria currently supported include: database-name: filter by database name (in string format). Fuzzy matching is used to search for databases that meet the criteria. |
| Offset | No | Integer | Data offset, which starts from 0. |
| Limit | No | Integer | Number of items displayed at a time. the maximum value is recommended to be 100. Default value: 20. |
| Parameter Name | Type | Description |
|---|---|---|
| Items | Array of String | Database information |
| TotalCount | Integer | Total number of databases |
| Databases | Array of Database | Specifies the database details list. |
| 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. |
This example shows you how to pull the full list of databases of an instance without filtering.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<Common request parameters>
{
"DBInstanceId": "postgres-hf8jo5pr"
}
{
"Response": {
"Items": [
"postgres",
"postgres_bak_1715086333",
"postgres_bak_1715140150",
"rds",
"postgres_bak_1715152994"
],
"Databases": [
{
"DatabaseName": "postgres",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": "=Tc/postgres,postgres=CTc/postgres,pg_tencentdb_superuser=C/postgres"
},
{
"DatabaseName": "postgres_bak_1715086333",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": ""
},
{
"DatabaseName": "postgres_bak_1715140150",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": ""
},
{
"DatabaseName": "rds",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": ""
},
{
"DatabaseName": "postgres_bak_1715152994",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": ""
}
],
"RequestId": "4045d7a9-5330-4c2c-b968-475570200a97",
"TotalCount": 5
}
}
This example shows you how to return a partial list of databases using filtering conditions.
POST / HTTP/1.1
Host: postgres.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatabases
<Common request parameters>
{
"DBInstanceId": "postgres-hf8jo5pr",
"Filters": [
{
"Name": "database-name",
"Values": [
"postgres"
]
}
],
"Offset": 1,
"Limit": 2
}
{
"Response": {
"Items": [
"postgres_bak_1715086333",
"postgres_bak_1715140150"
],
"Databases": [
{
"DatabaseName": "postgres_bak_1715086333",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": ""
},
{
"DatabaseName": "postgres_bak_1715140150",
"DatabaseOwner": "postgres",
"Encoding": "UTF8",
"Collate": "C",
"Ctype": "C",
"AllowConn": true,
"ConnLimit": -1,
"Privileges": ""
}
],
"RequestId": "25cc2555-14a2-454f-af08-6bd691315335",
"TotalCount": 5
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.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. |
| 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. |
| FailedOperation.PreCheckError | Pre-check failed |
| InternalError.DBError | Backend database execution error. |
| InternalError.InstanceDataError | Failed to access database management service. Please contact customer service. |
| InternalError.InternalHttpServerError | An exception occurred while executing the request. |
| InternalError.SystemError | System error. When this error occurs, please contact customer service for assistance. |
| InvalidInstanceStatus | Incorrect instance status. |
| InvalidParameter | Parameter error. |
| InvalidParameter.ParameterCheckError | Failed to check the parameter. |
| InvalidParameterValue.AccountNotExistError | The account does not exist. |
| 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. |
| OperationDenied.InstanceAccessDeniedError | You do not have the permission to operate this resource. |
| OperationDenied.InstanceStatusLimitOpError | This operation cannot be performed on an instance in this status. |
| ResourceNotFound.InstanceNotFoundError | The instance does not exist. |
| ResourceUnavailable.InvalidInstanceStatus | Incorrect instance status. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback