Update an existing object group

post

https://example.com/Bucket/updateObjectGroup

Update an existing object group's settings for index retention, index parallelism, or target active index. The update API is limited to a subset of fields that can be changed. In some cases, you must delete and create a new object group if you want to change fields that are not part of the update endpoint. The Bucket endpoints currently use AWS Signature Version 4 authentication.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

bucket

string

required

Object group name

indexRetention

Defaults to 14

A time window (in terms of days) to determine whether a resource should be included (a value of -1 means no limit)

targetActiveIndex

integer

Defaults to 1

Allow overriding number of "irrevokable" leases on compute for tasks associated with indexing. Use with caution.

The object group indexing model uses a lease system to allocate workers (registered units) for indexing jobs. Each worker is allowed one lease. By default, an index for a given object group requires 1 lease to make progress. By setting the target active index value greater than 1, the system attempts to allocate more leases for indexing. If the system has no more leases available, the indexing will progress as long as it has at least 1 lease allocated.

The default value is 1.

Consult with ChaosSearch support before tuning this value for latency-sensitive indexes.

indexParallelism

integer

Defaults to 1

The number of orchestration workers dedicated to indexing for this object group. Setting this to more than 1 also has the effect of creating slices of the daily index. (e.g., s0, s1, ...). If the object group uses isolation keys, each slice is organized to contain consistent keys (to help with query performance).

The default value is 1.

Indexing must be paused/resumed to cycle the current index orchestration workers and rebalance the work. Before you change the values, it is recommended to pause indexing for the object group, change the setting, and then resume indexing manually after the change.

liveEventsParallelism

integer

Defaults to 1

The number of workers used to pull from SQS/PubSub. Typically, one worker supports up to 6000 events per minute. In environments where the events regularly exceed 6000, it can be helpful to increase this value.

The default value is 1.

Consult with ChaosSearch support before tuning this value.

Indexing must be paused/resumed to cycle the current index orchestration workers and rebalance the work. Before you change the values, it is recommended to pause indexing, change the setting, and then resume indexing manually after the change.

queryMaskedFields

array of strings

Defaults to

Specifies a masking list of one or more object group field names. Masking a column of an object group removes the column from returning a value in any query (and prevents queries from constraining on the column). It applies to all rows previously ingested. To change the list of masked fields, make sure that you specify the complete list of fields to mask in the updateObjectGroup call.

queryMaskedFields

Responses

200

Successful update of existing object group

400The specified resource already exists

500The input was invalid