ワークスペースのデータ保持期間の変更¶
POST /api/v1/workspace/modify_rp_duration
概要¶
現在のワークスペースにおける各種標準保持期間と、サポートされている長期ストレージポリシーを調整します。
呼び出し前の準備と使用手順¶
workspace.ilmManage 権限が必要です。まず現在のワークスペース詳細から versionType、billingState、durationSet、storagePolicy、esIndexMerged、datastore を読み取り、現在のサイトで許可される範囲を確認してから、変更するカテゴリを送信します。free/freeEdition は操作できず、未払い/期限切れ状態は拒否されます。保持期間を短縮すると、以後に照会できる履歴範囲に影響しますが、クリーンアップ済みデータを復元できるわけではありません。
フィールドは実際のインデックスモードに応じて選択します。マージモードでは apm、分割モードでは tracing/rum/profiling/security を使用します。該当しないモードのフィールドはエラーにならず無視される場合があるため、返却された変更サマリーを確認し、読み戻しを行う必要があります。lineage は Doris/ScopeDB のみで、標準保持期間のみです。このページでは session_replay をサポートせず、他の入口のフィールドは返却しません。
長期総保持期間は標準保持期間より大きい必要があります。ログは scopedb のみで、pay/enterprise/unlimited がサポートします。メトリクスは pay と、請求センターを有効化した unlimited で metric_point_total が必要です。その他のバージョンでも明示的な timeseries は拒否されます。unlimited では rp/logging の長期タイプのみ許可されます。標準保持期間を変更する前に、古い長期保持期間が新しい標準保持期間より依然として大きいことを必ず確認してください。サーバー側では一部の履歴ポリシーに対して互換性のための保持が行われるため、storagePolicy を送信しない場合、成功したというだけで両方の設定が妥当であることを証明することはできません。省略したポリシーカテゴリは保持され、カテゴリに {} を送信するか longStorageEnabled を省略すると、オフとして正規化されます。
データベースとメトリクス/ログ/lineage の下流は段階的に更新されるため、データベースのコミット後にエラーが発生する可能性があります。一部の非 guancedb メトリクス通知にはフォールトトレランスがあり、HTTP 成功もすべての下流に適用済みであることを証明しません。読み戻して確認した後は、未完了の同期のみを処理してください。lineage の失敗は補償通知に進むことがあるため、むやみに繰り返し変更しないでください。成功時の content には実際に変更された項目のみが含まれ、変更がない場合は {} になります。空のサマリーから、送信したすべてのフィールドが有効になったと推測しないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| storagePolicy.rp | json | メトリクスポリシーオブジェクト。カテゴリを省略するか、該当カテゴリを null にした場合は変更しません。カテゴリに {} を指定するとオフとして正規化され、既存の長期ポリシーが閉じられる可能性があります。保持する場合はカテゴリオブジェクト全体を省略してください。例: {"longStorageEnabled": false}取得または入力方法: 現在の storagePolicy.rp から完全な設定を読み取ります。 |
|
| storagePolicy.rp.longStorageEnabled | boolean | 任意指定可能な JSON ブール値(推奨)。カテゴリオブジェクトが存在する場合、省略時はデフォルトで false です。lineage は false/省略のみ可能で、それ以外は拒否されます。例: false取得または入力方法: 長期保持が必要な場合は true、明示的に無効化する場合は false を選択します。 |
|
| storagePolicy.rp.longStorageDuration | string | 有効化時は条件付きで必須です。無効化時は空文字列に正規化されます。pay のメトリクスではデフォルトで 90d/120d/180d/360d/540d/720d、ログではデフォルトで 90d/120d/180d/360d です。enterprise/unlimited のログではデフォルトで 1d~1800d、メトリクスでは 1d~3600d で、サイト側で上書きできます。lineage は空/省略のみ可能です。例: 180d取得または入力方法: サイトで許可される長期保持期間の選択肢から選択し、標準保持期間より大きいことを確認します。 |
|
| storagePolicy.logging | json | ログポリシーオブジェクト。カテゴリを省略するか、該当カテゴリを null にした場合は変更しません。カテゴリに {} を指定するとオフとして正規化され、既存の長期ポリシーが閉じられる可能性があります。保持する場合はカテゴリオブジェクト全体を省略してください。例: {"longStorageEnabled": false}取得または入力方法: 現在の storagePolicy.logging から完全な設定を読み取ります。 |
|
| storagePolicy.logging.longStorageEnabled | boolean | 任意指定可能な JSON ブール値(推奨)。カテゴリオブジェクトが存在する場合、省略時はデフォルトで false です。lineage は false/省略のみ可能で、それ以外は拒否されます。例: false取得または入力方法: 長期保持が必要な場合は true、明示的に無効化する場合は false を選択します。 |
|
| storagePolicy.logging.longStorageDuration | string | 有効化時は条件付きで必須です。無効化時は空文字列に正規化されます。pay のメトリクスではデフォルトで 90d/120d/180d/360d/540d/720d、ログではデフォルトで 90d/120d/180d/360d です。enterprise/unlimited のログではデフォルトで 1d~1800d、メトリクスでは 1d~3600d で、サイト側で上書きできます。lineage は空/省略のみ可能です。例: 180d取得または入力方法: サイトで許可される長期保持期間の選択肢から選択し、標準保持期間より大きいことを確認します。 |
|
| storagePolicy.lineage | json | データオブザーバビリティポリシーオブジェクト。カテゴリを省略するか、該当カテゴリを null にした場合は変更しません。カテゴリに {} を指定するとオフとして正規化され、既存の長期ポリシーが閉じられる可能性があります。保持する場合はカテゴリオブジェクト全体を省略してください。例: {"longStorageEnabled": false}取得または入力方法: 現在の storagePolicy.lineage から完全な設定を読み取ります。 |
|
| storagePolicy.lineage.longStorageEnabled | boolean | 任意指定可能な JSON ブール値(推奨)。カテゴリオブジェクトが存在する場合、省略時はデフォルトで false です。lineage は false/省略のみ可能で、それ以外は拒否されます。例: false取得または入力方法: lineage は false または省略のみを指定し、長期保持はサポートされません。 |
|
| storagePolicy.lineage.longStorageDuration | string | 有効化時は条件付きで必須です。無効化時は空文字列に正規化されます。pay のメトリクスではデフォルトで 90d/120d/180d/360d/540d/720d、ログではデフォルトで 90d/120d/180d/360d です。enterprise/unlimited のログではデフォルトで 1d~1800d、メトリクスでは 1d~3600d で、サイト側で上書きできます。lineage は空/省略のみ可能です。例: 取得または入力方法: lineage は空文字列または省略のみを指定し、長期保持期間の選択肢は選択しません。 |
|
| apm | string | マージインデックスの APM 標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。マージインデックスモードでのみ有効で、分割時は無視される場合があります。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.apm、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| backup_log | string | バックアップログ標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 180d/360d/720d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。null の許可: False 例: 180d取得または入力方法: 現在のワークスペース の content.durationSet.backup_log、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| dialtest | string | Synthetic テスト標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.dialtest、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| keyevent | string | イベント標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 14d/30d/60d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。null の許可: False 例: 14d取得または入力方法: 現在のワークスペース の content.durationSet.keyevent、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| lineage | string | データオブザーバビリティ標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。実際の lineage が Doris/ScopeDB の場合のみ使用でき、長期ストレージは設定しません。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.lineage、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| logging | string | デフォルトログ標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.logging、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| profiling | string | プロファイリング標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。分割インデックスモードでのみ有効で、マージモードでは無視される場合があります。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.profiling、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| rp | string | メトリクス時系列標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d/180d/360d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~3600d)。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.rp、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| rum | string | リアルユーザーモニタリング(RUM)標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。分割インデックスモードでのみ有効で、マージモードでは無視される場合があります。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.rum、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| security | string | セキュリティデータ標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 90d/180d/360d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。分割インデックスモードでのみ有効で、マージモードでは無視される場合があります。null の許可: False 例: 90d取得または入力方法: 現在のワークスペース の content.durationSet.security、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
|
| storagePolicy | json | 任意のオブジェクト。送信したカテゴリのみをマージし、省略または {} の場合は既存ポリシーを保持します。null は指定できません。長期保持期間は総保持期間であり、標準保持期間に加算されません。有効化時は、今回の対応する標準保持期間より厳密に大きい必要があります。長期保持の有効化に使用できるのは、このドキュメントに記載された rp/logging のみで、lineage は互換性のための無効化のみです。null の許可: False 例: {"rp": {"longStorageEnabled": true, "longStorageDuration": "180d"}}取得または入力方法: 現在のワークスペース の content.storagePolicy から対象カテゴリの完全なポリシーを読み取ります。 |
|
| tracing | string | アプリケーショントレーシング標準保持期間。任意。省略時は保持し、null は許可されません。小文字の日数 d。pay のコードではデフォルトで 3d/7d/14d/30d/60d/90d を選択可能です。enterprise/unlimited の許可範囲はサイトに依存します(unlimited のコードでのデフォルトは 1d~1800d)。分割インデックスモードでのみ有効で、マージモードでは無視される場合があります。null の許可: False 例: 3d取得または入力方法: 現在のワークスペース の content.durationSet.tracing、esIndexMerged、datastore から現在値を取得し、現在のバージョン/エンジンで許可される選択肢を選びます。 |
パラメータ補足説明¶
現在のワークスペースでサポートされるモードのストレージカテゴリのみを更新します。標準保持期間は durationSet で、長期保持期間は総保持期間であり、標準保持期間と単純に加算することはできません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/modify_rp_duration' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"logging":"14d"}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 変更が発生したデータ型のサマリーのみを含みます。変更がない場合は {} になることがあり、常に完全な durationSet を返すわけではありません。 |
| content.数据类型 | object | 例: rp/logging/lineage。実際に変更された各カテゴリ。 |
| content.数据类型.old | string または null | 元の標準保持期間。標準保持期間が変化した場合にのみ表示されます。 |
| content.数据类型.new | string | 新しい標準保持期間。標準保持期間が変化した場合にのみ表示されます。 |
| content.数据类型.oldStoragePolicy | object | 元の長期ポリシー。ポリシーが変化した場合にのみ表示され、未設定の場合は {} になることがあります。 |
| content.数据类型.oldStoragePolicy.longStorageEnabled | boolean | 元の長期有効化フラグ。省略される場合があります。 |
| content.数据类型.oldStoragePolicy.longStorageDuration | string | 元の長期総保持期間。空または省略の場合があります。 |
| content.数据类型.newStoragePolicy | object | 新しい長期ポリシー。変化した場合にのみ表示され、lineage の中立ポリシーは {} になることがあります。 |
| content.数据类型.newStoragePolicy.longStorageEnabled | boolean | 新しい長期有効化フラグ。 |
| content.数据类型.newStoragePolicy.longStorageDuration | string | 新しい長期総保持期間。無効化時は空です。 |
| content.declaration | object または null | 空でない変更オブジェクトには共通宣言が追加されます。content={} の場合は挿入されません。 |
{
"code": 200,
"content": {
"logging": {
"old": "7d",
"new": "14d"
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては、共通エラー定義を参照してください。
メトリクスの長期ストレージ課金プランを照会する際、請求センター上流の明示的な 4xx では実際の HTTP と ft.CloudCareApiError を保持でき、message は上流の通知に従います。通常の 5xx/タイムアウトは最終的に 500 ft.InternalServerError に統一されます。保持期間と長期ポリシーを読み戻し、課金照会状態を確認してから対応し、むやみに繰り返し変更しないでください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンス説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の JSON ファイル形式エラー | このページのパラメータに従って JSON オブジェクトを送信してください。 |
| 400 | ft.FreeWKSPLimit | 現在のワークスペースバージョンが free/freeEdition |
無効な操作です。現在のワークスペースは無料プランです | 保持ポリシー編集をサポートするバージョンにアップグレードしてから操作してください。 |
| 400 | ft.WKSPStatusAbnormal | ワークスペースの billingState が arrearage/expired |
ワークスペースが未払いまたは期限切れです | 先に請求/有効期限の状態を処理してください。 |
| 406 | ft.CurrentVersionUnsupportRp | 編集をサポートしないバージョン、または現在のサイトに対応する選択肢がない | 現在のバージョンは rp:{} をサポートしていません |
管理者がバージョンと設定を確認してください。 |
| 400 | ft.IllegalDataKeepTime | pay の標準保持期間が不正、または lineage の新しい標準保持期間が不正 |
不正なデータ保持期間 | 現在のサイトで許可される期間を選択し、小文字の日数 d を確認してください。 |
| 406 | ft.InvalidDuration | 標準/長期の形式、または長期の固定選択肢が不正 | 無効な duration | 正の整数の日数に d を付けた値と、現在のバージョンで許可される選択肢を使用してください。 |
| 406 | ft.InvalidDurationRange | カスタム標準または長期の範囲が不正、または長期が標準保持期間以下 | 有効なデータ保持期間の範囲外 | バージョンの範囲を確認してください。長期保持期間は標準保持期間より厳密に大きい必要があります。 |
| 400 | ft.JsonFormatError | storagePolicy またはカテゴリポリシーがオブジェクトではない |
一部の JSON ファイル形式エラー | このページのポリシーオブジェクト構造を使用してください。 |
| 400 | ft.InvalidActionForbiddenChange | 長期ポリシーのバージョン/エンジン/メトリクス課金タイプがサポートされていない | インデックスマージ状態スイッチの変更は禁止されています | ログの scopedb とメトリクス課金タイプを確認してから有効化してください。 |
| 404 | ft.NamespaceDatastoreNotFound | lineage を要求したが、現在のワークスペースに有効な Doris/ScopeDB lineage エンジンがない |
{} のストレージタイプが見つかりません |
実際のデータエンジンのサポートを確認してください。 |
| 404 | ft.ForbiddenIndexCfg | lineage で非中立の長期ポリシーを送信 |
sls/beaver ストレージタイプのインデックス設定はサポートされていません |
lineage は標準保持期間のみを使用し、長期保持を有効化しません。 |
| 429 | ft.OperationTooFrequently | ストレージの排他処理がビジー、または実行中にロックを失った | 操作が頻繁すぎます。しばらくしてから再試行してください | バックオフし、保持期間と実際の同期状態を読み戻してから処理してください。並行して上書きしないでください。 |
| 500 | ft.InternalServerError | データベース、キャッシュ/キュー、下流の通常の 5xx/タイムアウト、または未処理タイプの失敗。書き込みはすでにコミットされている可能性があります | 内部エラー | まず現在/対象ワークスペースの詳細と下流状態から保存済みの結果を確認し、むやみに作成/ローテーションを繰り返さないでください。保存済みの場合は未完了の同期のみを処理し、traceId を提供してください。 |
| 406 | ft.InvalidBossNode | メトリクスの長期保持を有効化するには請求センターの課金プランを照会する必要があるが、ブランド/請求センターノードが設定されていない | 無効な Boss ノード | 管理者にブランドおよび請求センターノードを確認してもらってください。現在の保持期間とストレージポリシーを読み戻してから再試行を判断してください。 |