tencent cloud

PrevNext

masukan

cari berdasarkan kata kunci

Recent Pages

Dokumentasi
Cloud Log Service
    Dokumentasi
    Download PDF

    DescribeConfigs

    Terakhir diperbarui:2024-04-15 19:58:40
    Unduh PDF

      1. API Description

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

      This API is used to get collection rule configuration.

      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: DescribeConfigs.
      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 configName
      - Filter by fuzzy match of collection configuration name
      - Type: String
      - Required: No

      configId
      - Filter by collection configuration ID
      - Type: String
      - Required: No

      topicId
      - Filter by log topic
      - 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
      Configs Array of ConfigInfo Collection configuration list
      Note: this field may return null, indicating that no valid values can be obtained.
      TotalCount Integer Total number of filtered items
      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 Collection Configuration

      This example shows you how to get the collection configuration details by topic ID.

      Input Example

      POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigs
<Common request parameters>
{
    "Filters": [
        {
            "Key": "topicId",
            "Values": [
                "97e8a872-xxxx-4644-9d3c-603d95051458"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 10
}

      Output Example

      {
    "Response": {
        "Configs": [
            {
                "ConfigId": "02f11930-xxxx-4dca-8c9b-b6a147223945",
                "Name": "test",
                "LogFormat": "",
                "Path": "/test/**/test",
                "LogType": "minimalist_log",
                "ExtractRule": {
                    "TimeKey": "",
                    "TimeFormat": "",
                    "Delimiter": "",
                    "LogRegex": "",
                    "BeginRegex": "",
                    "Keys": null,
                    "FilterKeyRegex": [],
                    "UnMatchUpLoadSwitch": false,
                    "UnMatchLogKey": null,
                    "Backtracking": 0,
                    "IsGBK": 0,
                    "JsonStandard": 0,
                    "Protocol": "",
                    "Address": "",
                    "ParseProtocol": "",
                    "MetadataType": 0,
                    "PathRegex": "",
                    "MetaTags": []
                },
                "ExcludePaths": null,
                "Output": "97e8a872-xxxx-4644-9d3c-603d95051458",
                "UpdateTime": "2022-09-02 14:26:49",
                "CreateTime": "2022-09-02 14:26:49",
                "UserDefineRule": ""
            }
        ],
        "TotalCount": 2,
        "RequestId": "6eff3561-xxxx-4502-b625-3eb26c4ab450"
    }
}

      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
      AuthFailure CAM signature/authentication error.
      FailedOperation Operation failed.
      InternalError Internal error.
      InvalidParameter Incorrect parameter.
      InvalidParameterValue Incorrect parameter value.
      MissingParameter Missing parameter.
      OperationDenied Operation denied.
      OperationDenied.AccountDestroy The account has been terminated.
      OperationDenied.AccountIsolate The account has overdue payments.
      OperationDenied.AccountNotExists The account does not exist.
      ResourceNotFound.TopicNotExist The log topic does not exist.
      UnsupportedOperation Unsupported operation.
      Hubungi Kami

      Hubungi tim penjualan atau penasihat bisnis kami untuk membantu bisnis Anda.

      Hubungi Kami
      Dukungan Teknis

      Buka tiket jika Anda mencari bantuan lebih lanjut. Tiket kami tersedia 7x24.

      Kirim Tiket
      Dukungan Telepon 7x24
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Kebijakan PrivasiLegalKebijakan Cookie