SLS、HTTP、OSS、S3、または Kafka へのカスタムログ配布タスクを作成します。
操作説明
この API を使用して、特定のログデータの配信タスクを作成します。配信先として、Log Service (SLS)、HTTP サービス、Alibaba Cloud Object Storage Service (OSS)、S3 互換ストレージ、Kafka メッセージキューなど、複数の宛先をサポートしています。カスタムタスク名の設定、ログフィールドの選択、データセンターの指定、破棄率の設定、配信タイプの選択、および選択したタイプに応じた配信詳細の設定が可能です。
フィールドフィルタリング:
FieldNameを使用して、配信するログフィールドを指定します。フィルター ルール:
FilterRulesを使用して、配信前にログデータをフィルタリングします。サポートされている配信先: ログを SLS、HTTP(S)、Alibaba Cloud OSS、S3 互換ストレージ、Kafka など、さまざまな宛先に配信します。各メソッドには、固有の設定パラメーターがあります。
注意事項
ご利用の AccessKey と SecretKey に、配信操作に必要な権限が付与されていることを確認してください。
配信方法で暗号化または認証が必要な場合は、それに応じてセキュリティパラメーターを設定してください。
FilterRulesの構文が正しいことを確認してください。リトライ回数やタイムアウトなどの詳細パラメーターを調整して、配信効率と安定性を最適化してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
esa:CreateUserDeliveryTask |
create |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BusinessType |
string |
必須 |
リアルタイムログのタイプ。有効な値:
|
dcdn_log_access_l1 |
| DataCenter |
string |
任意 |
データセンター。有効な値:
|
cn |
| TaskName |
string |
必須 |
タスク名。 |
test_project |
| FieldName |
string |
必須 |
配信するフィールド。複数のフィールドはコンマ (,) で区切ります。 |
user_agent,ip_address,ip_port |
| DeliveryType |
string |
必須 |
ログの配信先。有効な値:
|
sls |
| DiscardRate |
number |
任意 |
ログの破棄率。デフォルトは 0 です。 |
0 |
| S3Delivery |
object |
任意 |
ログを Amazon S3 または S3 互換サービスに配信するための設定。 |
|
| Region |
string |
任意 |
配信先のリージョン。 |
cn-shanghai |
| BucketPath |
string |
任意 |
バケットパス。 |
logriver-test/log |
| AccessKey |
string |
任意 |
S3 アカウントのアクセスキー ID。 |
g0f46623ll0g0 |
| SecretKey |
string |
任意 |
S3 アカウントのシークレットアクセスキー。 |
*** |
| Endpoint |
string |
任意 |
S3 エンドポイント。 |
https://s3.oss-cn-hangzhou.aliyuncs.com |
| PrefixPath |
string |
任意 |
オブジェクトキーのプレフィックス。 |
logriver-test/log |
| S3Cmpt |
boolean |
任意 |
配信先が S3 互換サービスであるかどうかを指定します。 |
true |
| ServerSideEncryption |
boolean |
任意 |
||
| VertifyType |
string |
任意 |
||
| OssDelivery |
object |
任意 |
ログを Object Storage Service (OSS) に配信するための設定。 |
|
| Region |
string |
任意 |
配信先 OSS バケットのリージョン。 |
cn-hangzhou |
| Aliuid |
string |
任意 |
Alibaba Cloud アカウント ID。 |
1234*** |
| BucketName |
string |
任意 |
バケット名。 |
test_rlog |
| PrefixPath |
string |
任意 |
オブジェクトキーのプレフィックス。 |
test/ |
| HttpDelivery |
object |
任意 |
ログを HTTP または HTTPS エンドポイントに配信するための設定。 |
|
| DestUrl |
string |
任意 |
配信先エンドポイントの URL。 |
http://xxx.aliyun.com/v1/log/upload |
| StandardAuthOn |
boolean |
任意 |
標準認証を有効にするかどうかを指定します。 |
true |
| StandardAuthParam |
object |
任意 |
標準認証の設定。 |
|
| PrivateKey |
string |
任意 |
秘密鍵。 |
xxxx |
| ExpiredTime |
integer |
任意 |
有効期限 (秒)。 |
300 |
| UrlPath |
string |
任意 |
URL パス。 |
v1/log/upload |
| MaxBatchSize |
integer |
任意 |
1 回の配信リクエストあたりの最大ログエントリ数。 |
1000 |
| MaxBatchMB |
integer |
任意 |
配信バッチの最大サイズ (MB)。 |
5 |
| MaxRetry |
integer |
任意 |
配信が失敗した場合の最大リトライ回数。 |
3 |
| TransformTimeout |
integer |
任意 |
配信タイムアウト (秒)。 |
10 |
| LogBodyPrefix |
string |
任意 |
ログ配信ペイロードに追加するプレフィックス。 |
cdnVersion:1.0 |
| LogBodySuffix |
string |
任意 |
ログ配信ペイロードに追加するサフィックス。 |
cdnVersion:1.0 |
| Compress |
string |
任意 |
圧縮方法。 |
gzip |
| LogSplitWords |
string |
任意 |
ログエントリの区切り文字。 |
\n |
| HeaderParam |
object |
任意 |
カスタム HTTP ヘッダー。 |
|
|
object |
任意 |
カスタムヘッダー名。 |
||
| StaticValue |
string |
任意 |
カスタムヘッダー値。 |
aliyun |
| QueryParam |
object |
任意 |
カスタムクエリパラメーター。 |
|
|
object |
任意 |
カスタムクエリパラメーター名。 |
||
| StaticValue |
string |
任意 |
カスタムクエリパラメーター値。 |
v1.1 |
| LogSplit |
boolean |
任意 |
ログエントリを分割するかどうかを指定します。デフォルトは true です。 |
true |
| LastLogSplit |
boolean |
任意 |
末尾の区切り文字。 |
\n |
| KafkaDelivery |
object |
任意 |
ログを Kafka に配信するための設定。 |
|
| Topic |
string |
任意 |
Kafka トピック。 |
dqc_test2 |
| UserAuth |
boolean |
任意 |
ユーザー認証を有効にするかどうかを指定します。 |
true |
| MachanismType |
string |
任意 |
認証メカニズム。 |
plain |
| UserName |
string |
任意 |
認証用のユーザー名。 |
xxx |
| Password |
string |
任意 |
認証用のパスワード。 |
xxx |
| Brokers |
array |
任意 |
Kafka ブローカーのリスト。 |
|
|
string |
任意 |
Kafka ブローカー。 |
192.168.0.1:9902 |
|
| Compress |
string |
任意 |
圧縮方法。デフォルトでは無効になっています。 |
lz4 |
| Balancer |
string |
任意 |
負荷分散方式。 |
kafka.LeastBytes |
| SlsDelivery |
object |
任意 |
ログを Log Service (SLS) に配信するための設定。 |
|
| SLSRegion |
string |
任意 |
配信先プロジェクトのリージョン。 |
cn-hangzhou |
| SLSProject |
string |
任意 |
配信先プロジェクトの名前。 |
dcdn-test20240417 |
| SLSLogStore |
string |
任意 |
配信先 Logstore の名前。 |
accesslog-test |
| Details |
string |
任意 |
||
| FilterVer |
string |
任意 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスで返されるデータ。 |
||
| RequestId |
string |
リクエストの一意の ID。 |
2CCD40B1-3F20-5FF0-8A67-E3F34B87744F |
| TaskName |
string |
タスクの名前。 |
er-http |
| DataCenter |
string |
データセンター。有効な値:
|
cn |
| Status |
string |
タスクの現在のステータス。 |
online |
例
成功レスポンス
JSONJSON
{
"RequestId": "2CCD40B1-3F20-5FF0-8A67-E3F34B87744F",
"TaskName": "er-http",
"DataCenter": "cn",
"Status": "online"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | InternalError | An internal exception occurred, please try again later. | |
| 400 | InvalidParameter | Invalid parameter. Check the parameter configuration. | |
| 403 | ErService.NotOpen | Er service has not opend. | |
| 403 | RealTimeLog.S3EndpointInvalidError | 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). | |
| 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. | |
| 403 | EsaService.NotOpen | ESA service has not opend. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。