All Products
Search
Document Center

OpenSearch:ModifyPausePolicy

Last Updated:Jul 16, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

PUT /openapi/ha3/instances/{instanceId}/pause-policies

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-zvp2jlr2g03
bodyobjectNo

The request body.

objectNo

The request body.

pauseAllbooleanNo

Specifies whether to suspend all pushes.

true
pauseIndexbooleanNo

Specifies whether to suspend the push for the new full index version.

true
pauseIndexBatchbooleanNo

Specifies whether to suspend the push for the incremental indexes.

true
pauseBizbooleanNo

Specifies whether to suspend the push for the configuration.

true
pauseRuntimebooleanNo

Specifies whether to suspend the push for the real-time incremental indexes.

true

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

0B1FF998-BB8D-5182-BFC0-E471AA77095A
resultobject

The result.

{}

Examples

Sample success responses

JSONformat

{
  "requestId": "0B1FF998-BB8D-5182-BFC0-E471AA77095A",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.