tencent cloud

All product documents
Cloud Log Service
DocumentationCloud Log ServiceAPI DocumentationLog Set Management APIsDescribeLogsets
DescribeLogsets
Download PDF
Last updated: 2024-04-15 19:58:31
DescribeLogsets
Last updated: 2024-04-15 19:58:31
Download PDF

1. API Description

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

This API is used to get the list of logsets.

A maximum of 100 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: DescribeLogsets.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
Filters.N No Array of Filter logsetName
- Filter by logset name
- Type: String
- Required: No

logsetId
- Filter by logset ID
- Type: String
- Required: No

tagKey
- Filter by tag key
- Type: String
- Required: No

tag:tagKey
- Filter by tag key-value pair. The tagKey should be replaced with a specified tag key.
- Type: String
- Required: No

Each request can have up to 10 Filters and 5 Filter.Values.
Offset No Integer Page offset. Default value: 0
Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of pages
Logsets Array of LogsetInfo Logset list
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 Getting the List of Logsets

This example shows you how to get the list of logsets.

Input Example

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

{
    "Offset": 0,
    "Limit": 100
}

Output Example

{
    "Response": {
        "Logsets": [
            {
                "LogsetId": "cce2db26-xxxx-43f3-ae7d-3502a4b424fd",
                "LogsetName": "CLS Demo logset_100007xxxx27",
                "CreateTime": "2022-04-27 14:53:42",
                "AssumerName": "CLS",
                "Tags": [],
                "TopicCount": 8,
                "RoleName": "inner_cls_demo"
            }
        ],
        "TotalCount": 1,
        "RequestId": "141c1a10-da4b-4d86-a70d-ed49fd9b3b58"
    }
}

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 Operation failed.
FailedOperation.TagQpsLimit The frequency of tag service requests is limited.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.ACLFailed ACL verification failed.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound The resource does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon