Domain name for API request: cls.tencentcloudapi.com.
This API is used to get a collection rule configuration.
A maximum of 20 requests can be initiated per second for this API.
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 | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
Filters.N | No | Array of Filter | Filter by fuzzy match of collection configuration name Type: String Required: no Filter by collection configuration ID. Type: String Required: no 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 |
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, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConfigs
<Common request parameters>
{
"Filters": [
{
"Key": "configId",
"Values": [
"xxxx-xxx-xxxx"
]
}
],
"Offset": 0,
"Limit": 10
}
{
"Response": {
"Configs": [
{
"ConfigId": "xxxx-xx-xx-xx-yyyyyyyy",
"Path": "/abc/log/test.log",
"LogType": "delimiter_log",
"ExtractRule": {
"TimeKey": "date",
"TimeFormat": "%Y-%m-%d %H:%M:%S",
"Delimiter": "|",
"LogRegex": ".*",
"BeginRegex": "^",
"Keys": [
"date",
"",
"content"
],
"FilterKeyRegex": [
{
"Key": "xx",
"Regex": "xxxx"
}
],
"UnMatchLogKey": "testlog",
"UnMatchUpLoadSwitch": true,
"Backtracking": -1
},
"UserDefineRule": "xxxx",
"UpdateTime": "2017-08-08 12:12:12",
"CreateTime": "2017-08-08 12:12:12"
}
],
"TotalCount": 1,
"RequestId": "6ef60bec-0242-43af-bb20-270359fb54a7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?