コンテンツにスキップ

ワークスペースのデータ保持期間の変更¶

POST /api/v1/workspace/modify_rp_duration

概要¶

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
rp	string		メトリクス RP の duration 例: 30d 空を許可: False
logging	string		ログ RP の duration 例: 14d 空を許可: False
dialtest	string		Synthetic テストデータの duration 例: 90d 空を許可: False
backup_log	string		バックアップログの duration 例: 180d 空を許可: False
security	string		セキュリティチェックデータの duration 例: 90d 空を許可: False
keyevent	string		イベント RP の duration 例: 14d 空を許可: False
tracing	string		トレーシングの duration 例: 7d 空を許可: False
profiling	string		プロファイリングの duration 例: 7d 空を許可: False
rum	string		RUM の duration 例: 7d 空を許可: False
apm	string		APM の duration (マージインデックスの場合に有効) 例: 7d 空を許可: False
storagePolicy	json		長期保存ポリシー。ログは scopedb ストレージのワークスペースのみ有効化可能。pay、enterprise、unlimited はログの長期保存をサポート。enterprise/unlimited の logging の最大値は 1800d。enterprise/unlimited の rp はカスタム長期保存期間（最大 3600d）をサポート。unlimited は BossAccountSet 有効時は metric_point_total 課金タイプのみサポート、無効時は metric_point_total として扱う。key は rp/logging などのデータタイプ、value は longStorageEnabled と longStorageDuration を含む。例: {'rp': {'longStorageEnabled': True, 'longStorageDuration': '180d'}, 'logging': {'longStorageEnabled': True, 'longStorageDuration': '180d'}} 空を許可: False

パラメータ補足説明¶

パラメータ補足説明

SaaS バージョンのオプション日数¶

ワークスペースバージョン	`rp`	`logging`	`dialtest`	`backup_log`	`keyevent`	`security`	`tracing`	`profiling`	`rum`	`apm`	`network`
無料プラン (`free`、`freeEdition`)	7d	7d	7d	7d	7d	7d	7d	7d	7d	7d	1d
商用プラン (`pay`)	3d / 7d / 14d / 30d / 60d / 90d / 180d / 360d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	180d / 360d / 720d	14d / 30d / 60d	90d / 180d / 360d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	2d
エンタープライズプラン (`enterprise`)	3d / 7d / 14d / 30d / 60d / 90d / 180d / 360d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	180d / 360d / 720d	14d / 30d / 60d	90d / 180d / 360d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	3d / 7d / 14d / 30d / 60d / 90d	2d

デプロイメントプラン / 無制限プランの説明¶

デプロイメントプラン (unlimited) のオプション日数は設定ファイルによって決定されます。このインターフェースでサポートされる範囲は workspaceAllowRpSet["unlimited"] と workspaceAllowCustomRpSet["unlimited"] に準拠します。

分割インデックス時のオプション設定項目¶

分類	説明
rp	メトリクス
network	ネットワーク
keyevent	イベント
backup_log	バックアップログ
dialtest	Synthetic モニタリング
tracing	トレーシング-APM
profiling	トレーシング-プロファイリング
rum	RUM
logging	ログ
security	セキュリティチェック

マージインデックス時のオプション設定項目¶

分類	説明
rp	メトリクス
network	ネットワーク
keyevent	イベント
backup_log	バックアップログ
logging	ログ / CI モニタリング / Synthetic モニタリング / セキュリティチェック
apm	RUM / APM（トレース、プロファイリング）

ワークスペースがマージインデックスかどうかの判断方法¶

「現在のワークスペース情報の取得」API のレスポンスに含まれる esIndexMerged パラメータで判断できます。esIndexMerged=1 の場合はインデックスがマージされていることを示し、それ以外の場合はマージされていないことを示します。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/modify_rp_duration' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"rp":"3d"}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "rp": {
            "new": "3d",
            "old": "7d"
        }
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "1f7911xxxxx"
}