ModifyClusterDesc - OpenSearch - Alibaba Cloud Documentation Center

Modifies the description of a specified cluster.

Operation description

PUT

/openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc

There is currently no authorization information disclosed in the API.

PUT /openapi/ha3/instances/{instanceId}/clusters/{clusterName}/desc

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-c4d2rq7nt04
clusterName	string	Yes	The name of the cluster	sz_vpc_domain_1
body	object	No	The request body.	{}

Parameter	Required	Type	Description
description	Yes	String	The description of the cluster

PUT /openapi/ha3/instances/ha3_instance_name/clusters/my_cluster_name/desc

{
  "description":"this is descrition"
}

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request	D39EE0F1-D7EF-5F46-B781-6BF4185308B0
result	object	The result.	{}

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

For more information, see Response structure.

Sample success responses

JSONformat

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
  "result": {}
}

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

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details