作成¶
POST /api/v1/log_backup_cfg/add
概要¶
データ転送ルールを作成します。
呼び出し前の準備と使用手順¶
まずターゲットとデータカテゴリを決定し、完全な接続設定と範囲を準備します。新規ルールはデフォルトで有効になります。現在の公開モジュールには独立した有効化/停止インターフェースがないため、一時停止が必要な場合はコンソールで操作してください。外部ターゲットの保存では構造および一部のプラットフォームバケット設定のみを検証し、書き込み権限/到達性が完全に検証済みであることを保証しません。作成後は taskStatusCode/taskErrorCode と実際のターゲットデータを確認してください。
ログ範囲の新版の例:regularLogIndexNames=[] はすべての通常インデックスを選択;["default"] はデフォルトのみを選択;indexs=[] と regularLogIndexNames=null はすべてのネイティブ直書きを選択;両方のキーが [] の場合は 2 種類すべてを選択;非空の直書き配列と通常の [] は和集合になります。ディレクトリはオプションインデックスインターフェースから名前を取得し、クローンはソース A が有効な場合のみ選択できます。regularLogIndexNames を欠く旧プロトコルは従来の indexs セマンティクスを維持します:キー欠落/null はインデックス制限なし、[] は旧実行パスを踏襲し、新版の空配列としては解釈されません。
LogBamboo は独立した logbamboo 接続のみを受け付け、storageClass/storageFormat は省略または空にする必要があります。独立した searchToken がない場合はクエリできず、読み取りカスタム主体はクリアされます。Doris は json 固定で、アーカイブカテゴリはありません。オブジェクトストレージの待機は dataWaitSeconds のみが有効です。保持期間はワークスペースまたは外部ライフサイクルによって制御され、追加された互換用 duration は単一ルールの保持には影響しません。
設定の保存、認証情報、および後続の転送/キャッシュ通知は個別のステップで処理されます。成功しても既にデータが書き込まれたことを意味しません。変更通知が失敗しても保存済みの可能性があるため、まず現在の状態と実際の転送結果を読み取ってから再試行してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| readPermissionSet[*] | string | 単一の主体です。ロール名を UUID として扱うことはできず、実際に読み取り可能な結果を確認する必要があります。 例: wsAdmin取得または入力方法: 本ワークスペースのロール UUID を取得します。共有権限エンジンは acnt_/group_ 主体も認識します。 |
|
| extend.filters | array | 実際のフィルタ条件配列です。[] は追加のフィールド条件がないことを示し、カテゴリ全体が転送される可能性があります。match/not match およびその正規化エイリアスは拒否されます。ログインデックスの advancedFilter 構造をここに混在させないでください。 例: [{"name": "env", "condition": "and", "operation": "=", "value": ["production"]}]取得または入力方法: 対応する dataType の実際のフィールドと値を取得し、保存前にマッチ範囲を確認します。 |
|
| extend.filters[*] | json | 完全な name/condition/operation/value を推奨します。query_task.search 構造ではありません。 例: {"name": "env", "condition": "and", "operation": "=", "value": ["production"]}取得または入力方法: 各項目に 1 つの条件を指定します。複雑なネストは既存設定で事前に検証してください。 |
|
| extend.filters[*].name | string | 実際のフィールドキー。 例: env取得または入力方法: 実際の元フィールド、関係、演算、値に従って入力します。 |
|
| extend.filters[*].condition | string | and/or で前の条件との関係を指定します。先頭項目では無視されます。 例: and取得または入力方法: 実際の元フィールド、関係、演算、値に従って入力します。 |
|
| extend.filters[*].operation | string | 一般的な値は =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist です。match/contain 系はサポートされません。 例: =取得または入力方法: 実際の元フィールド、関係、演算、値に従って入力します。 |
|
| extend.filters[*].value | array | マッチ値です。等値/比較では先頭項目を使用し、集合演算では複数項目を使用します。 例: ["production"]取得または入力方法: 実際の元フィールド、関係、演算、値に従って入力します。 |
|
| extend.filters[*].value[*] | JSON | 単一の文字列/数値です。実際の型を保持します。 例: production取得または入力方法: 元のフィールド値を取得します。 |
|
| extend.indexs | array | ログのネイティブ直書きインデックス名の配列です。新版では [] はそのカテゴリのすべてを表し、非空は指定を表します。旧プロトコルで regularLogIndexNames を欠く場合は動作が異なります。使用方法を参照してください。UUID 配列ではありません。 例: ["native_app_logs"]取得または入力方法: 選択可能な転送インデックス の content.items から type=native の name を取得します。綴りが indexs であることに注意してください。 |
|
| extend.indexs[*] | string | 実際の名前です。trim して重複を排除します。新版で追加する選択は現在の利用可能なディレクトリ内に存在する必要があります。 例: native_app_logs取得または入力方法: 選択可能な転送インデックス から native 項目の name を取得します。 |
|
| extend.regularLogIndexNames | array または null | ログのみを対象とする新版の通常インデックス選択です。[] はすべての通常カテゴリ、非空は指定、null を indexs 配列と同時に渡すと直書きのみを表します。変更時にこのキーのみ null を渡すとインデックス制限をクリアします。このキーを欠く場合は旧プロトコルまたは変更時の保持を意味します。詳細は使用説明を参照してください。 例: ["default"]取得または入力方法: 選択可能な転送インデックス の type=log から name を取得します(default、通常インデックス、条件を満たすクローンを含みます)。 |
|
| extend.regularLogIndexNames[*] | string | 現在選択可能な単一の通常インデックス名です。クローンを含む場合はソース A が有効である必要があります。UUID ではありません。 例: default取得または入力方法: 選択可能な転送インデックス の log 項目の名前を取得します。 |
|
| accessCfg.serviceAccountJson.type | string | 認証情報の種類。 例: service_account取得または入力方法: 同じサービスアカウント JSON から元の値を保持します。 |
|
| accessCfg.serviceAccountJson.project_id | string | GCP プロジェクト ID。 例: project-example取得または入力方法: 同じサービスアカウント JSON から元の値を保持します。 |
|
| accessCfg.serviceAccountJson.private_key | string | 認証情報の秘密鍵です。元の JSON の完全な複数行文字列を使用します。 例: <PEM-PRIVATE-KEY>取得または入力方法: 同じサービスアカウント JSON から元の値を保持します。 |
|
| accessCfg.serviceAccountJson.client_email | string | サービスアカウントのメール識別子。 例: xxx@guance.com取得または入力方法: 同じサービスアカウント JSON から元の値を保持します。 |
|
| accessCfg | json | 省略可能ですが、外部ターゲットでは通常条件付きで必須です。OpenAPI は HTTPS 経由で認証情報の原文を直接送信し、Front の Web AES ラッピングを使用しません。変更時にオブジェクト全体を省略すると保持されます。提供した場合は全体が置き換えられ、指定された機密値/パーティション/待機のみ継承できます。 null 許可: False 例: {"provider": "aws", "grantType": "ram", "region": "us-east-1", "bucket": "customer-archive-example", "ak": "<EXTERNAL-AK>", "sk": "<EXTERNAL-SK>"}取得または入力方法: 対象ストレージの管理者から完全な認可接続オブジェクトを取得するか、コンソールで検証済みの設定に基づいて構成します。 |
|
| accessCfg.ak | string | キー認可時に sk と組み合わせます。詳細では AK 識別子が返される場合がありますが、すべての秘密が返されることを意味しません。 null 許可: False 例: <EXTERNAL-AK>取得または入力方法: ターゲットのアクセスキー ID。 |
|
| accessCfg.bucket | string | GCS では必須です。オブジェクトストレージでは実際にアクセス可能なバケットを指定する必要があり、サイトプラットフォームが予約した転送バケットは使用できません。 null 許可: False 例: customer-archive-example取得または入力方法: 自前のオブジェクトストレージバケット名。 |
|
| accessCfg.bucketPath | string | 省略可能です。空文字列はバケットルートのプレフィックスです。変更時に完全なオブジェクトを提供する場合は値を埋め戻してください。 空文字列許可: True null 許可: False 例: production/logs取得または入力方法: 自前のバケット内のターゲットプレフィックスです。認証情報は含めません。 |
|
| accessCfg.ca | string | Kafka/Doris ではターゲットの必要に応じて指定します。秘密鍵ではなく、未使用の場合は省略します。 空文字列許可: True null 許可: False 例: <PEM-CA>取得または入力方法: ターゲットの TLS 検証に使用する PEM CA の内容。 |
|
| accessCfg.cloudAccountId | string | ロール/アカウント認可ではターゲットの要件に応じて指定します。DF-API-KEY ではありません。 null 許可: False 例: cloud-account-example取得または入力方法: クラウドアカウント管理から取得した認可関連 ID をそのまま使用します。 |
|
| accessCfg.dataWaitSeconds | integer | オブジェクトストレージでのみ有効です。新規追加時のデフォルトは 3600、変更時に省略すると以前の有効値を継承し、それ以外は 3600 になります。オブジェクト以外のターゲットではこのキーは削除され、bool やその他の値は無効です。 null 許可: False 選択可能な値: [900, 1800, 3600] 例: 3600取得または入力方法: オブジェクトストレージでは 900/1800/3600 秒から選択します。 |
|
| accessCfg.database | string | Doris のデータベース名は [A-Za-z_][A-Za-z0-9_]{0,63} に一致する必要があります。 null 許可: False 例: archive_db取得または入力方法: 準備済みの Doris データベース。 |
|
| accessCfg.endpoint | string | s3/obs/oss/tos で ram を設定する場合、実際のネットワーク要件に応じて指定します。Kafka ブローカーや LogBamboo サブオブジェクトの endpoint ではありません。 null 許可: False 例: https://s3.example.com取得または入力方法: オブジェクトストレージのカスタムサービスアクセスエンドポイント。 |
|
| accessCfg.endpoints | string | Doris では条件付きで必須です。認証情報、サブパス、query、fragment を含まず、ポートが有効である必要があります。 null 許可: False 例: https://doris.example.com:8030取得または入力方法: Doris FE の HTTP(S) ルートアドレスです。複数指定する場合は半角カンマで区切ります。 |
|
| accessCfg.externalId | string | ロール認可の場合は入力が必要です。s3/oss のロール設定を変更する際、過去の externalId のダイジェストが保持される場合があります。 null 許可: False 例: external-id-example取得または入力方法: AWS ロールの信頼認可で取り決めた External ID。 |
|
| accessCfg.grantType | string | 既存の非特殊ターゲットを変更する場合は以前の grantType を継承します。このフィールドで認可モードを切り替えることはできません。具体的な認可の組み合わせは事前にコンソールで検証してください。 null 許可: False 選択可能な値: ['role', 'ram', 'account', 'serviceAccount'] 例: ram取得または入力方法: ターゲットの認可方式に応じて ram(キー)、role(ロール)、account(サイトアカウント)、GCS serviceAccount を選択します。 |
|
| accessCfg.isEncrypt | boolean | 省略可能で、デフォルトでは暗号化しません。認証情報の転送/保存時暗号化のスイッチではなく、キー管理パラメータは提供しません。 null 許可: False 例: false取得または入力方法: ターゲットの転送データ暗号化要件に従って入力します。 |
|
| accessCfg.logbamboo | json | このターゲットではこのサブオブジェクトおよびシステムが補完するフィールドのみが許可されます。エンドポイントとインデックスは事前に作成する必要があり、query には独立した searchToken が必要です。 null 許可: False 例: {"endpoint": "https://archive.example.com", "index": "app_logs", "ingestToken": "<INGEST-TOKEN-AT-LEAST-16>"}取得または入力方法: storeType=logbamboo の場合のみ、独立したサービス設定を使用します。 |
|
| accessCfg.logbamboo.ca | string | ロード可能な PEM CA である必要があり、PRIVATE KEY を含んではいけません。省略すると空に正規化され、完全なオブジェクト更新時は明示的に保持する必要があります。 空文字列許可: True null 許可: False 例: <PEM-CA>取得または入力方法: 省略可能なターゲット CA 証明書。 |
|
| accessCfg.logbamboo.endpoint | string | ユーザー名/パスワード、サブパス、query/fragment/空白を含まず、末尾の / は正規化により削除されます。 空文字列許可: True null 許可: False 例: https://archive.example.com取得または入力方法: ターゲットの HTTP(S) サービスルートアドレス。 |
|
| accessCfg.logbamboo.index | string | 1~128 文字で、英数字、ピリオド、アンダースコア、ハイフンを使用できます。. や .. は使用できません。 空文字列許可: True null 許可: False 例: app_logs取得または入力方法: 作成済みのターゲットインデックス。 |
|
| accessCfg.logbamboo.ingestToken | string | 16 文字以上の印刷可能な非空白 ASCII 文字で、Bearer プレフィックスを含みません。変更時に省略/空文字列またはマスク値を指定すると以前の Token を継承し、新規追加時は有効である必要があります。 空文字列許可: True null 許可: False 例: <INGEST-TOKEN-AT-LEAST-16>取得または入力方法: サービス管理者から独立した書き込み Token を取得します。 |
|
| accessCfg.logbamboo.searchToken | string | 省略可能です。指定しない場合はクエリを実行できません。変更時に省略すると継承され、空文字列を指定すると削除されます。削除後は openPermissionSet と readPermissionSet がクリア/無効化されます。 空文字列許可: True null 許可: False 例: <SEARCH-TOKEN-AT-LEAST-16>取得または入力方法: 管理者から独立したクエリ Token を取得します。ingestToken と同じにすることはできません。 |
|
| accessCfg.mechanism | string | Kafka の SASL メカニズムです。クラスタの要件に応じて選択します。 空文字列許可: True null 許可: False 選択可能な値: ['plain', 'scram-sha-256', 'scram-sha-512'] 例: scram-sha-256取得または入力方法: plain/scram-sha-256/scram-sha-512。 |
|
| accessCfg.partitionFields | array | 省略可能です。変更時に省略すると以前の値を継承し、明示的な [] はルールレベルのパーティションをクリアします。Kafka 以外で指定すると 406 となり、各要素は非空文字列である必要があります。 null 許可: False 例: ["app_id", "userid"]取得または入力方法: Kafka のみで、実際に転送されるデータのフィールドからパーティションキーを選択します。 |
|
| accessCfg.partitionFields[*] | string | 単一のパーティションフィールドです。パーティション番号ではありません。 null 許可: False $notEmptyString: True 例: app_id取得または入力方法: 実際のデータフィールド名。 |
|
| accessCfg.password | string | 非特殊ターゲットを変更する際に省略/空値を指定すると以前のパスワードの保持を試みますが、クリアすることはできません。 空文字列許可: True null 許可: False 例: <EXTERNAL-PASSWORD>取得または入力方法: ターゲットアカウントのパスワード。 |
|
| accessCfg.provider | string | オブジェクトストレージではターゲットのクラウドプロバイダーと一致する必要があり、GCS は google 固定です。 null 許可: False 選択可能な値: ['aliyun', 'aws', 'huawei', 'volcengine', 'google'] 例: aws取得または入力方法: 実際のクラウドプロバイダー aliyun/aws/huawei/volcengine/google。 |
|
| accessCfg.region | string | オブジェクトストレージでは明示的に指定してください。現在の検証では後続のデフォルト補完前に非空が要求され、宣言テキスト内のデフォルトサイトリージョンには依存しません。 null 許可: False 例: us-east-1取得または入力方法: ターゲットバケットのリージョンです。GCS では実際の GCP リージョンを使用します。 |
|
| accessCfg.replicationNum | integer | Doris でのみ指定できます。非負整数で、省略または 0 の場合はクラスタのデフォルトを使用します。bool は無効です。 null 許可: False $minValue: 0 例: 0取得または入力方法: Doris で新規作成するテーブルのレプリカ数です。クラスタのノード容量に応じて決定します。 |
|
| accessCfg.role | string | ロール認可の身元識別子です。コンソールが要求する名前/識別子を使用し、本ワークスペースの RBAC ロールではありません。 null 許可: False 例: archive-role取得または入力方法: ターゲットクラウドアカウントで認可されたロールから取得します。 |
|
| accessCfg.securityProtocol | string | Kafka の認証プロトコルです。2 つの sasl モードでは username/password が非空である必要があります。 null 許可: False 選択可能な値: ['plaintext', 'sasl_plaintext', 'sasl_ssl'] 例: sasl_ssl取得または入力方法: plaintext/sasl_plaintext/sasl_ssl。 |
|
| accessCfg.serviceAccountJson | json | GCS の該当する認可条件でのみ必須で、少なくとも type/project_id/private_key/client_email が非空である必要があります。JSON 文字列として渡すことはできず、詳細では返されません。 null 許可: False 例: {"type": "service_account", "project_id": "project-example", "private_key": "<PEM-PRIVATE-KEY>", "client_email": "xxx@guance.com"}取得または入力方法: GCS の serviceAccount 認可時に Google からダウンロードした完全なサービスアカウント JSON オブジェクトを使用します。実際の内容をドキュメントにアップロードしないでください。 |
|
| accessCfg.sk | string | 変更時に省略/空値を指定すると以前の SK の保持を試みますが、空文字列でクリアすることはできません。新規追加時は完全な値を指定します。 null 許可: False 例: <EXTERNAL-SK>取得または入力方法: ak と組み合わせる秘密鍵。 |
|
| accessCfg.table | string | Doris のテーブル名は [A-Za-z][A-Za-z0-9_]{0,63} に一致する必要があり、以降の作成/書き込み動作はターゲットサービスが実行します。 null 許可: False 例: archive_logs取得または入力方法: Doris のターゲットテーブル名。 |
|
| accessCfg.topic | string | Kafka ではターゲットの転送設定に従って入力します。空値の場合にターゲットを自動作成するかはダウンストリームに依存し、保存を書き込み可能の証明とみなさないでください。 空文字列許可: True null 許可: False 例: archive_logs取得または入力方法: Kafka クラスタ内のターゲット topic。 |
|
| accessCfg.url | string | Kafka の接続アドレスです。ネットワーク/認可とプロトコルが一致している必要があります。 null 許可: False 例: kafka.example.com:9092取得または入力方法: Kafka 管理者が提供する到達可能なブローカーアドレス。 |
|
| accessCfg.username | string | Kafka SASL および Doris では条件付きで必須です。変更時にユーザー名は自動継承されません。 空文字列許可: True null 許可: False 例: archive_writer取得または入力方法: ターゲットシステムで書き込みが認可されたアカウント。 |
|
| dataType | string | 省略可能で、作成時のデフォルトは logging です。変更時は元のカテゴリのみ返却でき、切り替えることはできません。metric は利用可能なターゲットと組み合わせる必要があり、logbamboo は lineage をサポートしません。リクエストの query で指定した dataType はルールのカテゴリを上書きできません。 null 許可: False 選択可能な値: ['lineage', 'metric', 'llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am'] 例: logging取得または入力方法: lineage/metric/llm/logging/tracing/rum/keyevent/audit_event/am から選択します。ターゲットの元データカテゴリから決定します。 |
|
| duration | string | 新規追加時のみこのフィールドがあり、現在の実装では監査コンテキストに使用され、単一ルールの保持設定として保存されません。これに依存してバケットのライフサイクルを変更しないでください。一覧の duration はワークスペースの backup_log 保持期間に由来します。 選択可能な値: ['180d', '360d', '720d'] 例: 180d取得または入力方法: 旧宣言の互換値 180d/360d/720d。 |
|
| extend | json | 省略可能で、作成時は通常 {} です。変更時に渡すと全体が置き換えられ、旧インデックス選択には専用の継承ルールがあります。使用説明を参照してください。省略すると保持されます。作成時に null を渡すと後続の extend.get で 500 になる可能性があります。変更時に明示的に null を指定すると {} として全体置換され、新版インデックス選択の専用継承ルールは引き続き保持されます。 null 許可: True 例: {"filters": []}取得または入力方法: 実際のフィールドでフィルタを構築します。ログ範囲では以下の indexs と regularLogIndexNames の 2 フィールドを使用できます。 |
|
| name | string | Y | 新規追加時は必須です。最大 64 個の UTF-16 ユニット(多くの中国語文字は 1、一部の絵文字など非 BMP 文字は 2 を占めます)で、重複できません。変更時は name を宣言せず、このインターフェースで名前を変更することはできません。呼び出し元は非空にしてください。現在の名前検証では非空を強制していません。 null 許可: False 最大長: 64 例: production_archive取得または入力方法: 業務に基づいて命名します。事前にデータ転送ルール一覧で同一ワークスペースの非削除/削除中のレコード名を確認してください。 |
| openPermissionSet | boolean | 省略可能で、作成時は false、変更時に省略すると保持されます。readPermissionSet はデータクエリ権限を制御するもので、ルール管理インターフェースの権限ではありません。LogBamboo で独立した searchToken がない場合は強制的に無効化され、読み取り主体がクリアされます。 null 許可: False 例: false取得または入力方法: 転送済みデータの読み取りを追加で制限する必要がある場合に有効にします。 |
|
| readPermissionSet | array | 省略可能な完全な読み取り主体配列です。通常は非 owner ロールを設定し、owner/作成者には予約された読み取りパスがあります。作成時は []、変更時に渡すと全体置換、省略すると保持されます。空配列は全員が参照可能であることを意味しません。 null 許可: False 例: ["wsAdmin"]取得または入力方法: ロールは本ワークスペースのロール管理から取得します(例:wsAdmin/general/readOnly)。メンバー/チームは本ワークスペースの実際の UUID で入力します。 |
|
| storageClass | string | 省略可能なアーカイブカテゴリです。利用可能な値はサイト/プロバイダーによって決まります。ソースコードではこの層に統一的な列挙を定義していません。LogBamboo では省略/空値が必須で、Doris ではクリアされます。アーカイブデータを直接クエリできるかはターゲットの復元状態に依存します。 空文字列許可: True null 許可: False 例: STANDARD取得または入力方法: ターゲットプロバイダーの実際のストレージクラスコード(例:STANDARD/ARCHIVE)で設定します。バケットポリシーおよびコンソールで検証済みの設定から取得します。 |
|
| storageFormat | string | 省略可能で、通常はデフォルトの json です。変更時に省略すると保持されます。公開列挙には iceberg が含まれません。LogBamboo では明示的な json/parquet も拒否されます。Kafka では空に正規化され、Doris では json が強制されます。 空文字列許可: True null 許可: False 選択可能な値: ['json', 'parquet'] 例: json取得または入力方法: オブジェクトストレージでは json/parquet を選択します。LogBamboo では省略し、Kafka ではファイル形式を使用せず、Doris では json 固定です。 |
|
| storeType | string | 作成時は省略可能で、変更時は既存値に固定されます。公開では TiDB や Iceberg の作成をサポートしません。過去の TiDB が一覧/詳細に表示される場合がありますが、それに基づいて隠しパラメータを追加しようとしないでください。 空文字列許可: True null 許可: False 選択可能な値: ['guanceObject', 's3', 'obs', 'oss', 'kafka', 'tos', 'gcs', 'doris', 'logbamboo'] 例: s3取得または入力方法: オブジェクトストレージは s3/oss/obs/tos/gcs、メッセージは kafka、データベースは doris、サービスは logbamboo、プラットフォーム組み込みオブジェクトストレージは guanceObject です。省略または空値の場合はサイトのデフォルトになります。 |
|
| syncExtensionField | boolean | 省略可能で、作成時はデフォルト false、変更時に省略すると保持されます。ログで返される message の構造とマスキング方式に影響します。どのフィールドを選択するかのホワイトリストではありません。 null 許可: False 例: false取得または入力方法: 完全なログと拡張フィールドを転送する必要がある場合は true、従来の message のみの方式では false にします。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_backup_cfg/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"production_archive","dataType":"logging","storeType":"s3","storageFormat":"json","storageClass":"STANDARD","extend":{"filters":[],"regularLogIndexNames":["default"]},"syncExtensionField":false,"accessCfg":{"provider":"aws","grantType":"ram","region":"us-east-1","bucket":"customer-archive-example","ak":"<EXTERNAL-AK>","sk":"<EXTERNAL-SK>","dataWaitSeconds":3600}}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | レコード番号です。作成スナップショットはコミット前に生成されるため null になる場合があり、呼び出しには uuid を使用します。 |
| content.uuid | string | lgbp_ ルール UUID。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | ルール名です。作成後、この公開変更インターフェースでは名前を変更できません。 |
| content.conditions | string | extend.filters から生成される条件です。追加フィルタがない場合は空文字列または {} です。 |
| content.syncExtensionField | boolean | 拡張フィールドを同期するかどうか。 |
| content.externalResourceAccessCfgUUID | string | アクセス設定の識別子です。認証情報ではありません。 |
| content.storeType | string | 保存されたターゲットの種類です。過去の TiDB は読み取り可能な場合がありますが、現在の OpenAPI では作成できません。 |
| content.storageClass | string | ターゲットのアーカイブカテゴリ。 |
| content.storageFormat | string | json/parquet です。Kafka または LogBamboo では空になる場合があります。Iceberg は本公開の一覧/詳細では除外されます。 |
| content.dataType | string | ルールに固定されたデータカテゴリです。過去の空値は logging として扱われます。 |
| content.taskStatusCode | integer | バックグラウンド転送タスクが報告するステータスです。作成時は通常 -1 で、現在の HTTP ステータスではありません。 |
| content.taskErrorCode | string | バックグラウンド転送のエラーコードです。空文字列は現在のエラー記録がないことを示します。保存の成功はタスクの成功を保証しません。 |
| content.openPermissionSet | boolean | データ読み取りのカスタム権限スイッチ。 |
| content.readPermissionSet | array<string> |
保存された読み取り主体。 |
| content.readPermissionSet[] | string | 単一のロール/メンバー/チーム識別子。 |
| content.deleteStatus | string | 削除処理のステータスです。deleting は組み込みストレージルールが非同期削除中であることを示し、過去のものは空または completed の場合があります。 |
| content.status | integer | 0 は有効、2 は無効、3 は削除済み。 |
| content.creator | string | 作成者の身元。 |
| content.updator | string | 更新者の身元です。初期状態では空の場合があります。 |
| content.createAt | integer | 作成日時の Unix 秒。 |
| content.updateAt | integer | 更新日時の Unix 秒です。未更新の場合は -1。 |
| content.deleteAt | integer | 削除日時の Unix 秒です。未削除の場合は -1。 |
| content.extend | object | 保存された範囲/条件設定:省略可能で、作成時は通常 {} です。変更時に渡すと全体が置き換えられ、旧インデックス選択には専用の継承ルールがあります。使用説明を参照してください。省略すると保持されます。作成時に null を渡すと後続の extend.get で 500 になる可能性があります。変更時に明示的に null を指定すると {} として全体置換され、新版インデックス選択の専用継承ルールは引き続き保持されます。 |
| content.extend.filters | array | 保存された範囲/条件設定:実際のフィルタ条件配列です。[] は追加のフィールド条件がないことを示し、カテゴリ全体が転送される可能性があります。match/not match およびその正規化エイリアスは拒否されます。ログインデックスの advancedFilter 構造をここに混在させないでください。 |
| content.extend.filters[] | json | 保存された範囲/条件設定:完全な name/condition/operation/value を推奨します。query_task.search 構造ではありません。 |
| content.extend.filters[].name | string | 保存された範囲/条件設定:実際のフィールドキー。 |
| content.extend.filters[].condition | string | 保存された範囲/条件設定:and/or で前の条件との関係を指定します。先頭項目では無視されます。 |
| content.extend.filters[].operation | string | 保存された範囲/条件設定:一般的な値は =、!=、in、not_in、>、>=、<、<=、regexp、not_regexp、wildcard、not_wildcard、exist、not_exist です。match/contain 系はサポートされません。 |
| content.extend.filters[].value | array | 保存された範囲/条件設定:マッチ値です。等値/比較では先頭項目を使用し、集合演算では複数項目を使用します。 |
| content.extend.filters[].value[] | JSON | 保存された範囲/条件設定:単一の文字列/数値です。実際の型を保持します。 |
| content.extend.indexs | array | 保存された範囲/条件設定:ログのネイティブ直書きインデックス名の配列です。新版では [] はそのカテゴリのすべてを表し、非空は指定を表します。旧プロトコルで regularLogIndexNames を欠く場合は動作が異なります。使用方法を参照してください。UUID 配列ではありません。 |
| content.extend.indexs[] | string | 保存された範囲/条件設定:実際の名前です。trim して重複を排除します。新版で追加する選択は現在の利用可能なディレクトリ内に存在する必要があります。 |
| content.extend.regularLogIndexNames | array または null | 保存された範囲/条件設定:ログのみを対象とする新版の通常インデックス選択です。[] はすべての通常カテゴリ、非空は指定、null を indexs 配列と同時に渡すと直書きのみを表します。変更時にこのキーのみ null を渡すとインデックス制限をクリアします。このキーを欠く場合は旧プロトコルまたは変更時の保持を意味します。詳細は使用説明を参照してください。 |
| content.extend.regularLogIndexNames[] | string | 保存された範囲/条件設定:現在選択可能な単一の通常インデックス名です。クローンを含む場合はソース A が有効である必要があります。UUID ではありません。 |
| content.declaration | object | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": null,
"uuid": "lgbp_example",
"workspaceUUID": "wksp_example",
"name": "production_archive",
"conditions": "",
"extend": {
"filters": [],
"regularLogIndexNames": [
"default"
]
},
"syncExtensionField": false,
"externalResourceAccessCfgUUID": "erac_example",
"storeType": "s3",
"storageFormat": "json",
"storageClass": "STANDARD",
"dataType": "logging",
"taskStatusCode": -1,
"taskErrorCode": "",
"openPermissionSet": false,
"readPermissionSet": [],
"deleteStatus": "",
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトでない | 一部の json ファイルの形式エラー | パラメータ表の JSON オブジェクトを送信してください。 |
| 406 | ft.ParameterValidationFailed | データカテゴリ/ストレージターゲット/接続/名前/待機/インデックス選択、または不変フィールドの検証が一致しない | パラメータ解析失敗 | ターゲットの組み合わせに応じて完全に入力してください。内部の TiDB/Iceberg パラメータや未知のフィールドは使用できません。 |
| 406 | ft.UnsupportRuleType | filters で match/not match および対応する正規化エイリアスを使用 | サポートされていないルールタイプ:{} |
サポートされている等値、集合、正規表現などの条件に変更してください。 |
| 400 | ft.LogBackupCfgRegionInvalid | オブジェクトストレージのリージョンが空 | 外部ストレージのリージョンが無効 | ターゲットのリージョンを明示的に入力してください。 |
| 400 | ft.LogBackupCfgProviderInvalid | プロバイダーが空、または GCS が google でないなど | 外部ストレージプロバイダーの種類が無効 | 実際のターゲットに一致する provider を入力してください。 |
| 404 | ft.LogBackupCfgUserNameInvalid | Kafka SASL のユーザー名が空 | バックアップルール設定のユーザー名が無効 | プロトコルに一致するユーザー名を指定してください。 |
| 404 | ft.LogBackupCfgPasswordInvalid | Kafka SASL のパスワードが空 | バックアップルール設定のパスワードが無効 | 有効なパスワードを指定するか、変更時は継承ルールに従って保持してください。 |
| 406 | ft.DataTransferBucketUnavailable | ターゲットがプラットフォーム予約のデータ転送バケットを使用 | Bucket は使用できません | お客様自身の認可済みバケットを使用してください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ、フィールド形状、または通常のダウンストリーム 5xx/タイムアウト処理の失敗 | 内部エラー | 書き込み後はまずルールの現在の状態を確認し、タスクの照会では先に task_id を確認してください。継続的に失敗する場合は traceId を提供してください。 |
| 400 | ft.BackupLogNameRepeat | ワークスペースに同名の非削除レコード(削除中のルールを含む)が存在 | 現在のワークスペースに同名のデータ転送設定名{}が既に存在します |
一意の名前に変更するか、削除完了を待ってから確認してください。 |
| 403 | ft.Forbidden | 無料プランでは作成できません | 操作する権限がありません | サポート対象のプランと API Key の権限を確認してください。 |