Skip to content

Modify Workspace Data Retention Duration¶

POST /api/v1/workspace/modify_rp_duration

Overview¶

Body Request Parameters¶

Parameter Name	Type	Required	Description
rp	string		Duration for Metrics RP Example: 30d Allow Empty: False
logging	string		Duration for Logging RP Example: 14d Allow Empty: False
backup_log	string		Duration for backup logs Example: 180d Allow Empty: False
security	string		Duration for inspection data Example: 90d Allow Empty: False
keyevent	string		Duration for Events RP Example: 14d Allow Empty: False
tracing	string		Duration for tracing Example: 7d Allow Empty: False
profiling	string		Duration for profiling Example: 7d Allow Empty: False
rum	string		Duration for RUM Example: 7d Allow Empty: False
apm	string		Duration for APM (Valid when indexes are merged) Example: 7d Allow Empty: False

Parameter Supplementary Description¶

Parameter Supplementary Description

Standard Optional RP Value Range:¶

Optional Value	Description
1d	1 day
3d	3 days
7d	7 days
14d	14 days
30d	1 month
60d	2 months
90d	3 months
180d	Half a year
360d	1 year
720d	2 years
1095d	3 years

Configurable Items When Indexes Are Split¶

Category	Description
rp	Metrics
network	NETWORK
keyevent	Events
backup_log	Backup Logs
tracing	APM - Application Performance
profiling	APM - Profiling
rum	RUM
logging	LOG
security	Security Check

Configurable Items When Indexes Are Merged¶

Category	Description
rp	Metrics
network	NETWORK
keyevent	Events
backup_log	Backup Logs
logging	LOG / Synthetic Tests / Security Check
apm	RUM / APM (trace, profiling)

How to Distinguish if a Workspace is Merged¶

It can be distinguished by the esIndexMerged parameter in the response of the "Get Current Workspace Information" interface. If esIndexMerged=1, it indicates that the indexes are merged; otherwise, it indicates that the indexes are not merged.

Request Example¶

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

Response¶

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