ModifyRealtimeLogDeliveryTask
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to modify the configuration of a real-time log delivery task. It has the following limits:
- The destination type (
TaskType) of a real-time log delivery task cannot be modified; - The data delivery type (
LogType) cannot be modified; - The data delivery region (
Area) cannot be modified; - When the destination of the original real-time log delivery task is Tencent Cloud CLS, the destination details such as the log set and log topic cannot be modified.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyRealtimeLogDeliveryTask. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | Site ID. |
| TaskId | Yes | String | ID of the real-time log delivery task. |
| TaskName | No | String | Name of the real-time log delivery task. It can contain digits, letters, hyphens (-), and underscores (_), with a maximum of 200 characters. If left empty, the original configuration applies. |
| DeliveryStatus | No | String | Status of the real-time log delivery task. Valid values:
|
| EntityList.N | No | Array of String | List of entities that the real-time log delivery task applies to (Layer 7 domain names or Layer 4 proxy instances). Examples:
|
| Fields.N | No | Array of String | List of preset fields to deliver. If left empty, the original configuration applies. For valid values, see |
| CustomFields.N | No | Array of CustomField | List of custom fields to deliver. You can extract specified content from HTTP request headers, response headers, cookies, and request bodies. Custom field names must be unique. Custom fields can be added only for Layer 7 access logs ( The number of custom fields you can configure is subject to a quota. If the quota is insufficient, contact us. |
| CustomExpressionFields.N | No | Array of CustomExpressionField | List of custom expression fields to deliver. By defining the field name and value expression for log delivery, you can deliver personalized real-time log content. For details, see Custom Log Field Expressions. Custom fields can be added only for Layer 7 access logs ( The number of custom fields you can configure is subject to a quota. If the quota is insufficient, contact us. Note: If a field in |
| DeliveryConditions.N | No | Array of DeliveryCondition | Filter conditions for log delivery. If left empty, all logs are delivered. |
| Sample | No | Integer | Sampling ratio, in per mille. Value range: 1-1000. For example, 605 means a sampling ratio of 60.5%. If left empty, the original configuration applies. |
| LogFormat | No | LogFormat | Output format for log delivery. For usage details, see Custom Log Output Format. If left blank, the default format applies. The default format logic is as follows:
Particularly, when |
| CustomEndpoint | No | CustomEndpoint | Configuration of the custom HTTP service. If left empty, the original configuration applies. |
| S3 | No | S3 | Configuration of the S3-compatible (SigV4 authentication algorithm compatible) object storage. If left empty, the original configuration applies. |
| AWSS3 | No | AWSS3 | Configuration of the AWS S3 object storage. If left empty, the original configuration applies. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| 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 Disabling Log Sampling
This example shows you how to modify the configuration of a successfully created real-time log delivery task and disable its log sampling feature. Before modification, the log sampling ratio is 60.5%. After modification, log sampling will no longer be performed, and 100% of the logs will be delivered to the destination.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRealtimeLogDeliveryTask
<Common request parameters>
{
"ZoneId": "zone-2ju9lrnpayol",
"TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p",
"Sample": 1000
}Output Example
{
"Response": {
"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
}
}Example2 Adding Acceleration Domains for Log Delivery
This example shows you how to modify the configuration of a successfully created real-time log delivery task and add acceleration domains for which logs need to be delivered. Before modification, only the site acceleration log of domain1.example.com is delivered. After modification, the site acceleration logs of domain1.example.com, domain2.example.com, and domain3.example.com will be delivered.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRealtimeLogDeliveryTask
<Common request parameters>
{
"ZoneId": "zone-2ju9lrnpayol",
"TaskId": "17819248-77b0-4e1a-a979-d84b5a9b300p",
"EntityList": [
"domain1.example.com",
"domain2.example.com",
"domain3.example.com"
]
}Output Example
{
"Response": {
"RequestId": "5e0a2b4e-df6d-4d2a-ac39-1706cbf8a703"
}
}5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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.CreateLogTopicTaskAuthFailure | Authentication failed while creating a custom push task. Check whether the push address is correct. |
| InvalidParameter.InvalidLogFormatFieldDelimiter | The field separator in the log output format is incorrect. |
| InvalidParameter.InvalidLogFormatFormatType | The log output format type is incorrect. |
| InvalidParameter.InvalidLogFormatRecordDelimiter | The log record separator in the log output format is incorrect. |
| LimitExceeded.CustomLogFieldRegexLimitExceeded | The number of regular expression type fields in real-time log custom fields exceeds the limit. |