tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeAccounts

最后更新时间：2024-06-17 14:26:44

    1. API Description

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

    This API is used to query the list of the database accounts for an instance.

    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: DescribeAccounts.
    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.
    DBInstanceId Yes String Instance ID in the format of postgres-6fego161
    Limit No Integer Number of entries returned per page. Default value: 10. Value range: 1–100.
    Offset No Integer Data offset, which 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)

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of date entries returned for this API call.
    Details Array of AccountInfo Detailed account list information.
    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 u200cu200cu200cu200cGetting the user list for the instance "postgres-apzvwncr".

    u200cu200cu200cu200cThis example shows you how to get the user list for the instance "postgres-apzvwncr".

    Input Example

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

{
    "DBInstanceId": "postgres-apzvwncr"
}

    Output Example

    {
    "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"
            }
        ]
    }
}

    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.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.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
    InvalidParameterValue.AccountNotExist The current account does not exist.
    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款