新規作成¶
POST /api/v1/log_backup_cfg/add
概要¶
データ転送ルールを新規作成します。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | ルール名 例: xxx 空文字列許可: False 最大長: 64 |
| extend | json | フロントエンドカスタムデータ 空文字列許可: True |
|
| syncExtensionField | boolean | 拡張フィールドのバックアップ同期、true で同期、false で非同期、デフォルトは非同期 空文字列許可: False |
|
| openPermissionSet | boolean | カスタム権限設定を有効化（デフォルト false:無効）。有効化後、データ転送ルールの読み取り権限は readPermissionSet に従います（2025-03-26 のイテレーションで追加） 空文字列許可: False |
|
| readPermissionSet | array | データ転送ルールデータの読み取り権限設定。ロール（所有者以外）を設定可能（2025-03-26 のイテレーションで追加） 例: ['wsAdmin', 'general'] 空文字列許可: False |
|
| storeType | string | ストレージタイプ 空文字列許可: False 空文字列許可: True 選択可能な値: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris'] |
|
| storageClass | string | ストレージクラス 空文字列許可: False 空文字列許可: True |
|
| storageFormat | string | ストレージフォーマット、デフォルト値は json 空文字列許可: False 空文字列許可: True 選択可能な値: ['json', 'parquet'] |
|
| dataType | string | データタイプ 空文字列許可: False 選択可能な値: ['llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am'] |
|
| duration | string | データ保持期間 例: 180d 選択可能な値: ['180d', '360d', '720d'] |
|
| accessCfg | json | 外部リソースアクセス設定情報 空文字列許可: False |
|
| accessCfg.provider | string | プロバイダ 空文字列許可: False 選択可能な値: ['aliyun', 'aws', 'huawei', 'volcengine', 'google'] |
|
| accessCfg.grantType | string | 認可タイプ 空文字列許可: False 選択可能な値: ['role', 'ram', 'account', 'serviceAccount'] |
|
| accessCfg.cloudAccountId | string | クラウドアカウント ID 空文字列許可: False |
|
| accessCfg.bucket | string | ストレージバケット 空文字列許可: False |
|
| accessCfg.externalId | string | 外部一意識別 ID（AWS のロール認可方式における外部一意識別 ID） 空文字列許可: False |
|
| accessCfg.role | string | ロール名 空文字列許可: False |
|
| accessCfg.ak | string | アクセスキー ID 空文字列許可: False |
|
| accessCfg.sk | string | シークレットキー 空文字列許可: False |
|
| accessCfg.serviceAccountJson | json | GCP サービスアカウント JSON オブジェクト 空文字列許可: False |
|
| accessCfg.topic | string | topic 空文字列許可: False 空文字列許可: True |
|
| accessCfg.url | string | 接続URL（kafka に適用） 空文字列許可: False |
|
| accessCfg.securityProtocol | string | セキュリティプロトコル（kafka に適用） 空文字列許可: False 選択可能な値: ['plaintext', 'sasl_plaintext', 'sasl_ssl'] |
|
| accessCfg.ca | string | クライアント SSL 証明書の内容 空文字列許可: False 空文字列許可: True |
|
| accessCfg.mechanism | string | 認証方式 空文字列許可: False 空文字列許可: True 選択可能な値: ['plain', 'scram-sha-256', 'scram-sha-512'] |
|
| accessCfg.username | string | ユーザー名 空文字列許可: False 空文字列許可: True |
|
| accessCfg.password | string | パスワード 空文字列許可: False 空文字列許可: True |
|
| accessCfg.endpoints | string | Apache Doris FE HTTP/HTTPS アドレス、複数ある場合はカンマ区切り 空文字列許可: False |
|
| accessCfg.database | string | Apache Doris データベース名 空文字列許可: False |
|
| accessCfg.table | string | Apache Doris テーブル名、^[A-Za-z][A-Za-z0-9_]{0,63}$ に一致 空文字列許可: False |
|
| accessCfg.replicationNum | integer | Apache Doris 新規テーブルのレプリカ数。省略または 0 を指定するとクラスタのデフォルト値を使用 空文字列許可: False $minValue: 0 |
|
| accessCfg.region | string | リージョン（オプション、未入力の場合は現在のサイトに一致するベンダーのリージョンがデフォルト） 空文字列許可: False |
|
| accessCfg.endpoint | string | アクセスエンドポイント。storeType が s3/obs/oss/tos で grantType=ram の場合にオプション 空文字列許可: False |
|
| accessCfg.bucketPath | string | バケットパス 空文字列許可: False 空文字列許可: True |
|
| accessCfg.dataWaitSeconds | integer | オブジェクトストレージデータ待機時間（秒）。未指定の場合はデフォルト 3600 空文字列許可: False 選択可能な値: [900, 1800, 3600] |
|
| accessCfg.isEncrypt | boolean | 転送データを暗号化するかどうか。デフォルト false（暗号化しない） 空文字列許可: False |
パラメータ補足説明¶
レスポンス¶
{"code":200,"content":{"conditions":"","createAt":1697613651,"creator":"xxx","dataType":"tracing","deleteAt":-1,"extend":{"filterLogic":"and","filters":[]},"externalResourceAccessCfgUUID":"erac_xxxx32","id":null,"name":"temp_test","status":0,"storeType":"obs","syncExtensionField":true,"taskErrorCode":"","taskStatusCode":-1,"updateAt":1697613651,"updator":"xxx","uuid":"lgbp_xxxx32","workspaceUUID":"wksp_xxxx32"},"errorCode":"","message":"","success":true,"traceId":"TRACE-31D4417B-2665-4CFA-9BC9-60BD6A540744"}
requestCurl: |
```shell
curl '<Endpoint>/api/v1/log_backup_cfg/add' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"extend":{"filters":[],"filterLogic":"and"},"syncExtensionField":true,"storeType":"s3","name":"temp_test","dataType":"tracing","accessCfg":{"grantType":"ram","bucket":"test-s3-001","region":"cn-south-1","provider":"aws","endpoint":"https://s3.custom-endpoint.example.com"}}' \
--compressed