変更¶
POST /api/v1/log_backup_cfg/{cfg_uuid}/modify
概要¶
既存のデータ転送ルール設定を変更します。
呼び出し前の準備と使用手順¶
転送ルール詳細から完全な設定をバックアップしてください。name、storeType および dataType はこの公開変更エントリでは切り替えられず、dataType は同じ値の返送のみ許可されます。変更時に省略したトップレベルフィールドは保持されます。extend を渡すと全体が置換され、明示的な null は {} として扱われ、filters などの旧設定は回填する必要があります。既に新版のインデックス選択がある場合、両方の選択キーを省略すると元の範囲が保持されます。indexs のみを渡して regularLogIndexNames を欠くと拒否され、変更時に regularLogIndexNames=null のみを渡すとインデックス制限を解除できます。accessCfg はオブジェクト全体を省略すると保持されます。提供する場合は対象接続を完全に回填する必要があり、旧 SK/パスワード/サービスアカウント JSON は省略時に回填され、Kafka の partitionFields とオブジェクトの dataWaitSeconds は別途継承されます。
ログ範囲の新版の例:regularLogIndexNames=[] はすべての通常インデックスを選択し、["default"] はデフォルトのみを選択し、indexs=[] と regularLogIndexNames=null はすべてのネイティブ直書きを選択し、両キーが [] の場合は 2 種類すべてを選択し、非空の直書き配列と通常の [] の場合は和集合となります。カタログはオプションインデックス API から名前を取得し、クローンはソース A が有効な場合のみ選択できます。regularLogIndexNames を欠く旧プロトコルは履歴的な indexs セマンティクスを維持します。キー欠落/null はインデックス制限なし、[] は旧実行パスを踏襲し、新版の空配列としては解釈されません。
LogBamboo は独立した logbamboo 接続のみを受け付け、storageClass/storageFormat は省略または空である必要があります。独立した searchToken がない場合はクエリできず、読み取りカスタム主体はクリアされます。Doris は json に固定され、アーカイブカテゴリはありません。オブジェクトストレージの待機は dataWaitSeconds のみが有効です。保持期間はワークスペースまたは外部のライフサイクルで制御され、追加された互換 duration は単一ルールの保存期間を変更しません。
設定の保存、認証情報、および後続の転送/キャッシュ通知は段階的に処理され、成功は既にデータが書き込まれたことを意味しません。変更通知が失敗しても既に保存されている可能性があるため、まず現在の状態と実際の転送結果を読み取ってから再試行してください。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| cfg_uuid | string | Y | 本ワークスペースで削除されておらず、deleting 状態でもないルールの UUID です。name ではありません。 例: lgbp_example取得または記入方法: データ転送ルール一覧の content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 をサポートしません。リクエストクエリの dataType がルールのカテゴリを上書きすることはできません。 null 許可: False 選択可能な値: ['lineage', 'metric', 'llm', 'logging', 'tracing', 'rum', 'keyevent', 'audit_event', 'am'] 例: logging取得または記入方法: lineage/metric/llm/logging/tracing/rum/keyevent/audit_event/am から選択します。対象の元データカテゴリから決定します。 |
|
| extend | json | オプションで、作成時は通常 {} です。変更時に渡すと全体が置換され、旧インデックス選択には専用の継承規則があります。使用説明を参照してください。省略時は保持されます。作成時に null を渡すと、後続の extend.get で 500 が発生する可能性があります。変更時の明示的な null は {} として全体置換され、新版インデックス選択の専用継承規則は引き続き保持されます。 null 許可: True 例: {"filters": []}取得または記入方法: 実際のフィールドでフィルタを構成します。ログ範囲には以下の indexs と regularLogIndexNames の 2 フィールドを使用できます。 |
|
| 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 に固定されます。 |
|
| syncExtensionField | boolean | オプションで、作成時のデフォルトは false です。変更時に省略すると保持されます。ログが返す message の構造とマスキング方式に影響しますが、どのフィールドを選択するかのホワイトリストではありません。 null 許可: False 例: false取得または記入方法: 完全なログと拡張フィールドを転送する必要がある場合は true、元の message のみの方式に従う場合は false です。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/log_backup_cfg/lgbp_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"dataType":"logging","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": 100,
"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": 1785427300,
"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 を提供してください。 |
| 404 | ft.ObjectNotExists | ルールに関連付けられた接続設定が存在しない | 指定されたオブジェクトが存在しない | 関連リソースのライフサイクルを確認してから変更してください。 |
| 400 | ft.WKSPTypeUnsupportAction | 現在のバージョンが pay/enterprise/unlimited でない | 現在のワークスペースバージョンではサポートされていません | バージョンのサポートを確認してください。 |
| 404 | ft.LogBackupCfgNoExists | ターゲットが存在しない、削除済み、削除中、またはクロスワークスペース | 指定されたデータ転送設定が存在しません | 一覧から有効な UUID を取得し、deleting 期間中は変更しないでください。 |
| 403 | ft.Forbidden | ターゲットが本公開インターフェースで除外される Iceberg 形式 | 操作する権限がありません | 対応するサポート済みの専用管理エントリを使用してください。 |