DescribeInstanceAccount

Last updated: 2025-10-28 22:22:05

DescribeInstanceAccount

Last updated: 2025-10-28 22:22:05

1. API Description

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

This API is used to view instance account information.

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: DescribeInstanceAccount.
Version	Yes	String	Common Params. The value used for this API: 2018-04-12.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	ID of a specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.
Limit	Yes	Integer	Pagination size. The default value is 20, the minimum value is 1, and the maximum value is 100.
Offset	Yes	Integer	Pagination offset, which is an integral multiple of `Limit`. Calculation formula: `offset` = `limit` * (page number - 1).

3. Output Parameters

Parameter Name	Type	Description
Accounts	Array of Account	Account details.
TotalCount	Integer	Number of accounts.
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 Request Sample

This example shows you how to query the account information of a specified instance.

Input Example

https://redis.intl.tencentcloudapi.com/?Action=DescribeInstanceAccount
&InstanceId=crs-fswdmXXX
&Limit=10
&Offset=0
&<Common request parameters>

Output Example

{
    "Response": {
        "Accounts": [
            {
                "AccountName": "root",
                "CreateTime": "",
                "InstanceId": "crs-fswdmXXX",
                "Privilege": "rw",
                "ReadonlyPolicy": [
                    "master"
                ],
                "Remark": "default",
                "Status": 2
            }
        ],
        "RequestId": "10369b9b-b514-48b1-8967-44448fe8XXXXX",
        "TotalCount": 1
    }
}

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

Tencent Cloud CLI 3.0

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.SystemError	Internal system error, which is irrelevant to the business.
InternalError.InternalError	Internal error.
InvalidParameter.PermissionDenied	The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed	No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList	The user is not in the allowlist.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud