Membuat tugas pengiriman log kustom ke SLS, HTTP, OSS, S3, atau Kafka.
Deskripsi operasi
Gunakan API ini untuk membuat tugas pengiriman untuk data log tertentu. API ini mendukung beberapa tujuan pengiriman, termasuk SLS, layanan HTTP, Alibaba Cloud OSS, penyimpanan yang kompatibel dengan S3, dan antrean pesan Kafka. Anda dapat mengatur nama tugas kustom, memilih field log, menentukan pusat data, mengatur tingkat pembuangan, memilih jenis pengiriman, dan mengonfigurasi detail pengiriman untuk jenis yang dipilih.
-
Pemfilteran Field: Gunakan
FieldNameuntuk menentukan field log yang akan dikirim. -
Aturan Filter: Gunakan
FilterRulesuntuk memfilter data log sebelum pengiriman. -
Tujuan pengiriman yang didukung: Kirim log ke berbagai tujuan, termasuk SLS, HTTP(S), Alibaba Cloud OSS, penyimpanan yang kompatibel dengan S3, dan Kafka. Setiap metode memiliki parameter konfigurasi tertentu.
Catatan
-
Pastikan AccessKey dan SecretKey Anda memiliki izin yang diperlukan untuk operasi pengiriman.
-
Jika metode pengiriman memerlukan enkripsi atau autentikasi, konfigurasikan parameter keamanannya sesuai kebutuhan.
-
Verifikasi bahwa sintaks
FilterRulessudah benar. -
Sesuaikan parameter lanjutan, seperti jumlah percobaan ulang dan batas waktu, untuk mengoptimalkan efisiensi dan stabilitas pengiriman.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
esa:CreateUserDeliveryTask |
create |
*All Resource
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| BusinessType |
string |
Yes |
Jenis log real-time. Nilai yang valid:
|
dcdn_log_access_l1 |
| DataCenter |
string |
No |
Pusat data. Nilai yang valid:
|
cn |
| TaskName |
string |
Yes |
Nama tugas. |
test_project |
| FieldName |
string |
Yes |
Field yang akan dikirim. Pisahkan beberapa field dengan koma. |
user_agent,ip_address,ip_port |
| DeliveryType |
string |
Yes |
Tujuan pengiriman log. Nilai yang valid:
|
sls |
| DiscardRate |
number |
No |
Tingkat pembuangan log. Default-nya 0. |
0 |
| S3Delivery |
object |
No |
Konfigurasi untuk mengirim log ke Amazon S3 atau layanan yang kompatibel dengan S3. |
|
| Region |
string |
No |
Region tujuan. |
cn-shanghai |
| BucketPath |
string |
No |
Path bucket. |
logriver-test/log |
| AccessKey |
string |
No |
ID access key untuk akun S3. |
g0f46623ll0g0 |
| SecretKey |
string |
No |
Secret access key untuk akun S3. |
*** |
| Endpoint |
string |
No |
Endpoint S3. |
https://s3.oss-cn-hangzhou.aliyuncs.com |
| PrefixPath |
string |
No |
Prefix kunci objek. |
logriver-test/log |
| S3Cmpt |
boolean |
No |
Menentukan apakah tujuan merupakan layanan yang kompatibel dengan S3. |
true |
| ServerSideEncryption |
boolean |
No |
||
| VertifyType |
string |
No |
||
| OssDelivery |
object |
No |
Konfigurasi untuk mengirim log ke Object Storage Service (OSS). |
|
| Region |
string |
No |
Region bucket OSS tujuan. |
cn-hangzhou |
| Aliuid |
string |
No |
ID akun Alibaba Cloud. |
1234*** |
| BucketName |
string |
No |
Nama bucket. |
test_rlog |
| PrefixPath |
string |
No |
Prefix kunci objek. |
test/ |
| HttpDelivery |
object |
No |
Konfigurasi untuk mengirim log ke endpoint HTTP atau HTTPS. |
|
| DestUrl |
string |
No |
URL endpoint tujuan. |
http://xxx.aliyun.com/v1/log/upload |
| StandardAuthOn |
boolean |
No |
Menentukan apakah autentikasi standar diaktifkan. |
true |
| StandardAuthParam |
object |
No |
Konfigurasi untuk autentikasi standar. |
|
| PrivateKey |
string |
No |
Kunci privat. |
xxxx |
| ExpiredTime |
integer |
No |
Waktu kedaluwarsa, dalam detik. |
300 |
| UrlPath |
string |
No |
Path URL. |
v1/log/upload |
| MaxBatchSize |
integer |
No |
Jumlah maksimum entri log per permintaan pengiriman. |
1000 |
| MaxBatchMB |
integer |
No |
Ukuran maksimum batch pengiriman, dalam MB. |
5 |
| MaxRetry |
integer |
No |
Jumlah maksimum percobaan ulang jika pengiriman gagal. |
3 |
| TransformTimeout |
integer |
No |
Batas waktu pengiriman, dalam detik. |
10 |
| LogBodyPrefix |
string |
No |
Prefix yang ditambahkan ke payload pengiriman log. |
cdnVersion:1.0 |
| LogBodySuffix |
string |
No |
Suffix yang ditambahkan ke payload pengiriman log. |
cdnVersion:1.0 |
| Compress |
string |
No |
Metode kompresi. |
gzip |
| LogSplitWords |
string |
No |
Pembatas untuk entri log. |
\n |
| HeaderParam |
object |
No |
Header HTTP kustom. |
|
|
object |
No |
Nama header kustom. |
||
| StaticValue |
string |
No |
Nilai header kustom. |
aliyun |
| QueryParam |
object |
No |
Parameter query kustom. |
|
|
object |
No |
Nama parameter query kustom. |
||
| StaticValue |
string |
No |
Nilai parameter query kustom. |
v1.1 |
| LogSplit |
boolean |
No |
Menentukan apakah entri log dipisahkan. Default-nya true. |
true |
| LastLogSplit |
boolean |
No |
Pembatas akhir. |
\n |
| KafkaDelivery |
object |
No |
Konfigurasi untuk mengirim log ke Kafka. |
|
| Topic |
string |
No |
Topik Kafka. |
dqc_test2 |
| UserAuth |
boolean |
No |
Menentukan apakah autentikasi pengguna diaktifkan. |
true |
| MachanismType |
string |
No |
Mekanisme autentikasi. |
plain |
| UserName |
string |
No |
Nama pengguna untuk autentikasi. |
xxx |
| Password |
string |
No |
Kata sandi untuk autentikasi. |
xxx |
| Brokers |
array |
No |
Daftar broker Kafka. |
|
|
string |
No |
Broker Kafka, dalam format |
192.168.0.1:9902 |
|
| Compress |
string |
No |
Metode kompresi. Dinonaktifkan secara default. |
lz4 |
| Balancer |
string |
No |
Metode load balancing. |
kafka.LeastBytes |
| SlsDelivery |
object |
No |
Konfigurasi untuk mengirim log ke Log Service (SLS). |
|
| SLSRegion |
string |
No |
Region proyek tujuan. |
cn-hangzhou |
| SLSProject |
string |
No |
Nama proyek tujuan. |
dcdn-test20240417 |
| SLSLogStore |
string |
No |
Nama Logstore tujuan. |
accesslog-test |
| Details |
string |
No |
||
| FilterVer |
string |
No |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Data yang dikembalikan dalam respons. |
||
| RequestId |
string |
Pengidentifikasi unik untuk permintaan. |
2CCD40B1-3F20-5FF0-8A67-E3F34B87744F |
| TaskName |
string |
Nama tugas. |
er-http |
| DataCenter |
string |
Pusat data. Nilai yang valid:
|
cn |
| Status |
string |
Status tugas saat ini. |
online |
Contoh
Respons sukses
JSONformat
{
"RequestId": "2CCD40B1-3F20-5FF0-8A67-E3F34B87744F",
"TaskName": "er-http",
"DataCenter": "cn",
"Status": "online"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InternalError | An internal exception occurred, please try again later. | An inner exception was triggered. Please try again later. |
| 400 | InvalidParameter | Invalid parameter. Check the parameter configuration. | Invalid parameter. Check the parameter configuration. |
| 403 | ErService.NotOpen | Er service has not opend. | Er service has not opend. |
| 403 | RealTimeLog.S3EndpointInvalidError | Invalid S3 information for the delivery task. Check your configurations and try again. | Invalid S3 information for the delivery task. Check your configurations and try again. |
| 403 | RealTimeLog.KafkaBrokersExceedError | The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50). | The number of Kafka Broker addresses for real-time log delivery has reached the upper limit (50). |
| 403 | RealTimeLog.StatusQuotaError | The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase. | The maximum number of real-time log delivery tasks has been reached. Check your plan quota and upgrade the plan to request a quota increase. |
| 403 | EsaService.NotOpen | ESA service has not opend. | Edge Security Accelerator (ESA) is not turned on |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.