DescribeServiceAccounts

Last updated: 2024-12-02 15:03:33

Last updated: 2024-12-02 15:03:33

1. API Description

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

This API is used to query service 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: DescribeServiceAccounts.
Version	Yes	String	Common Params. The value used for this API: 2019-09-24.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
RegistryId	Yes	String	Instance ID
All	No	Boolean	All service accounts
EmbedPermission	No	Boolean	Whether to fill in permission information.
Filters.N	No	Array of Filter	Filters
Offset	No	Integer	Offset. Default value: `0`
Limit	No	Integer	Maximum number of output entries. Default value: `20`. Maximum value: `100`. The maximum value is automatically applied when a value exceeding it is entered.

3. Output Parameters

Parameter Name	Type	Description
ServiceAccounts	Array of ServiceAccount	List of service accounts Note: This field may return `null`, indicating that no valid values can be obtained.
TotalCount	Integer	Number of service level 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 Querying Service Level Accounts

This example shows you how to query service level accounts.

Input Example

POST / HTTP/1.1Host: tcr.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeServiceAccounts<Common request parameters>

{
    "RegistryId": "abc",
    "All": true,
    "EmbedPermission": true,
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 0
}

Output Example

{
    "Response": {
        "ServiceAccounts": [
            {
                "Name": "abc",
                "Description": "abc",
                "Disable": true,
                "ExpiresAt": 0,
                "CreateTime": "2020-09-22T00:00:00+00:00",
                "UpdateTime": "2020-09-22T00:00:00+00:00",
                "Permissions": [
                    {
                        "Resource": "abc",
                        "Actions": [
                            "abc"
                        ]
                    }
                ]
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

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	Operation failed
FailedOperation.DbError	Database error
InvalidParameter	Parameter error. Please check and try again.
OperationDenied	Operation denied.
UnknownParameter	Unknown parameter error. Please check and try again.
UnsupportedOperation	Unsupported operation

Was this page helpful?

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

Yes

tencent cloud