All Products
Search
Document Center

OpenSearch:ListPausePolicys

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-i7m2roiy504

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

2AE63638-5420-56DC-BF59-37D8174039A0
resultobject

The result.

object

The results returned.

pauseAllboolean

Indicates whether all pushes are suspended.

true
pauseIndexboolean

Indicates whether the push is suspended for the new full index version.

true
pauseIndexBatchboolean

Indicates whether the push is suspended for the incremental indexes.

true
pauseBizboolean

Indicates whether the push is suspended for the configuration.

true
pauseRuntimeboolean

Indicates whether the push is suspended for the real-time incremental indexes.

true

Examples

Sample success responses

JSONformat

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "key": {
      "pauseAll": true,
      "pauseIndex": true,
      "pauseIndexBatch": true,
      "pauseBiz": true,
      "pauseRuntime": true
    }
  }
}

Error codes

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