tencent cloud

APIs

문서APIsCloud Log ServiceMetric APIsDescribeRecordingRuleYamlTask

DescribeRecordingRuleYamlTask

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-06-10 15:01:18

1. API Description

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

This API is used to retrieve the pre-aggregation task list in yaml.

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: DescribeRecordingRuleYamlTask.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TopicId Yes String

Source metric topic id.

Offset Yes Integer

Pagination offset. Default value: 0.

Limit Yes Integer

Maximum number of entries per page. Default value: 20. Maximum value: 100.

Filters.N No Array of Filter
  • Filter by yamlConfigName [configuration file name] with fuzzy matching. Type: String. Required: No
  • Filter by yamlId as [yamlID] with fuzzy matching. Type: String. Required: No
  • 3. Output Parameters

    Parameter Name Type Description
    RecordingRuleYamlTaskInfos Array of RecordingRuleYamlTaskInfo

    Task list information of RecordingRule

    TotalCount Integer

    Total number of tasks

    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 Obtaining the Pre-Aggregation Task List Through a YAML File

    Obtaining the Pre-Aggregation Task List Through a YAML File

    Input Example

    POST / HTTP/1.1
    Host: cls.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeRecordingRuleYamlTask
    <Common request parameters>
    
    {
        "TopicId": "539ba7bc-25e2-4696-bde5-0a5567164xxx",
        "Offset": 1,
        "Limit": 1
    }
    

    Output Example

    {
        "Response": {
            "RecordingRuleYamlTaskInfos": [],
            "RequestId": "76f39b5e-8476-4247-9331-9d415530d447",
            "TotalCount": 0
        }
    }
    

    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.
    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.
    ResourceNotFound.TopicNotExist The log topic does not exist.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백