tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAccounts

Last updated: 2024-11-26 16:32:37

    1. API Description

    Domain name for API request: sqlserver.intl.tencentcloudapi.com.

    This API is used to pull the list of instance accounts.

    A maximum of 20 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: 2018-03-28.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID
    Limit No Integer Number of results per page. Value range: 1-100. Default value: 20
    Offset No Integer Page number. Default value: 0
    Name No String Account ID
    OrderBy No String Sorting by createTime, updateTime, or passTime. Default value: createTime (desc).
    OrderByType No String Sorting rule. Valid values: desc (descending order), asc (ascending order). Default value: desc.

    3. Output Parameters

    Parameter Name Type Description
    InstanceId String Instance ID
    Accounts Array of AccountDetail Account information list
    TotalCount Integer Total number
    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 Pulling the list of instance accounts

    Input Example

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

{
    "InstanceId": "mssql-j8kv137v"
}

    Output Example

    {
    "Response": {
        "InstanceId": "mssql-632eyp63",
        "TotalCount": 1,
        "Accounts": [
            {
                "Status": 2,
                "Remark": "--",
                "AccountType": "L0",
                "Host": "127.0.0.1",
                "Name": "xiaowei",
                "IsAdmin": true,
                "UpdateTime": "2020-09-22 00:00:00",
                "InternalStatus": "enable",
                "Authentication": "win-windows",
                "PassTime": "2020-09-22 00:00:00",
                "Dbs": [
                    {
                        "Privilege": "ReadOnly",
                        "DBName": "test"
                    }
                ],
                "CreateTime": "2020-09-22 00:00:00"
            }
        ],
        "RequestId": "5729760c-db94-4c71-a1ee-ebd43adae189"
    }
}

    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
    FailedOperation.DBError Database error.
    FailedOperation.GcsError The operation failed or the network timed out.
    InternalError.SystemError System error.
    InvalidParameter.InputIllegal Input error.
    InvalidParameter.ParamsAssertFailed An error occurred while converting parameter assertion.
    ResourceNotFound.InstanceNotFound The instance does not exist.
    UnauthorizedOperation.PermissionDenied CAM authentication error.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy