Domain name for API request: postgres.tencentcloudapi.com.
This API is used to get the instance user list.
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
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: DescribeAccounts. |
| 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. |
| DBInstanceId | Yes | String | Instance ID in the format of postgres-6fego161 |
| Limit | No | Integer | Number of entries returned per page. Default value: 20. Value range: 1-100. |
| Offset | No | Integer | Page number for data return in paged query. Pagination starts from 0 |
| OrderBy | No | String | Whether to sort by creation time or username. Valid values: createTime (sort by creation time), name (sort by username) |
| OrderByType | No | String | Whether returns are sorted in ascending or descending order. Valid values: desc (descending), asc (ascending) |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of date entries returned for this API call. |
| Details | Array of AccountInfo | Account list details. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
https://postgres.tencentcloudapi.com/?Action=DescribeAccounts
&DBInstanceId=postgres-apzvwncr
&<Common request parameters>{
"Response": {
"TotalCount": 1,
"RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d",
"Details": [
{
"UserName": "root",
"Status": 2,
"Remark": "(Test) this account is invalid",
"DBInstanceId": "postgres-apzvwncr",
"UpdateTime": "2018-06-12 17:21:57",
"CreateTime": "2018-06-12 17:21:54"
}
]
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
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. |
| InternalError.SystemError | System error. When this error occurs, please contact customer service for assistance. |
| InvalidParameter | Invalid input parameter. |
| InvalidParameterValue.AccountNotExist | The current account does not exist. |
| InvalidParameterValue.InstanceNotExist | The current instance does not exist. |
Was this page helpful?