All Products
Search
Document Center

OpenSearch:ModifyPausePolicy

Last Updated:Oct 16, 2024

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:ModifyPausePolicyupdate
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

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.