DescribeLogsets

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-11-30 16:26:18

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 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 parameter. The value used for this API: DescribeLogsets.
Version	Yes	String	Common parameter. The value used for this API: 2020-10-16.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
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 contain 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, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting 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": 1
}

Output Example

{
  "Response": {
    "TotalCount": 0,
    "RequestId": "xx",
    "Logsets": [
      {
        "Tags": [
          {
            "Value": "xx",
            "Key": "xx"
          }
        ],
        "CreateTime": "xx",
        "RoleName": "xx",
        "TopicCount": 0,
        "LogsetName": "xx",
        "LogsetId": "xx"
      }
    ]
  }
}

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.
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.

Recent Pages