All Products
Search
Document Center

OpenSearch:ModifyClusterOnlineConfig

Last Updated:Jul 16, 2024

Modifies the online configuration of a cluster.

Operation description

Method

PUT

URI

/openapi/ha3/instances/{instanceId}/cluster-online-config

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}/cluster-online-config

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-7mz2ougaw02
bodyobjectNo

The request body.

configobjectNo

The configuration information.

integerNo

The version number of the configuration.

2
clustersarrayNo

The cluster information.

stringNo

The clusters.

[ "hz_pre_vpc_domain_1" ]

Sample requests

PUT /openapi/ha3/instances/ha3_instance_name/cluster-online-config

{
    "advancedConfigVersionId": 2,
    "clusters": [
      "hz_pre_vpc_domain_1"
    ]
}

Response parameters

ParameterTypeDescriptionExample
object

{}

requestIdstring

The ID of the request

E7B7D598-B080-5C8E-AA35-D43EC0D5F886
resultobject

Map

{}

Sample responses

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

For more information, see Response structure.

Examples

Sample success responses

JSONformat

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

Error codes

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