All Products
Search
Document Center

OpenSearch:ModifyOnlineConfig

Last Updated:Oct 16, 2024

Modifies online configurations.

Operation description

Method

put

URI

/openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName}

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:ModifyOnlineConfig
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

PUT /openapi/ha3/instances/{instanceId}/node/{nodeName}/online-configs/{indexName} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-7mz2ougaw02
nodeNamestringYes

The node name.

general
indexNamestringYes

The index name.

adsfasd
bodyobjectNo

The request body.

stringNo

The request body.

{}

Sample requests



PUT  /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs



{

  "content": "xxxx",

  "suezAdminName": "xxxx"

}

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

id of request

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

Map

{}

Sample requests

PUT  /openapi/ha3/instances/ha-test1/node/ihome_searcher/online-configs
{
 
  "content": "xxxx",
 
  "suezAdminName": "xxxx"
 
}

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {}
}

Error codes

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