Modifies the configurations of a node.
Operation description
Debugging
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 Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| searchengine:ModifyNodeConfig |
|
| none |
Request syntax
PUT /openapi/ha3/instances/{instanceId}/node-config HTTP/1.1
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| instanceId | string | Yes | The instance ID. | ha-cn-2r42p5oi202 |
| type | string | Yes | The type of the algorithm. Valid values:
| " " |
| name | string | Yes | The name of the configuration before the modification. | ha-cn-zvp2iv9a401_qrs |
| clusterName | string | No | The name of the cluster. | vpc_sh_domain_2 |
| dataSourceName | string | No | The name of the data source. Valid values: -search: search for data. -not_search: do not search for data. | ha-cn-2r42ostoc01_0704 |
| body | object | No | The request body. | |
| dataFragmentNumber | integer | No | The number of data shards. | 1 |
| dataDuplicateNumber | integer | No | The number of data replicas. | 1 |
| minServicePercent | integer | No | The minimum service ratio. | 10 |
| published | boolean | No | Specifies whether to mount the cluster. | true |
| active | boolean | No | Specifies whether to enable the index. | true |
| flowRatio | integer | No | The traffic percentage. | -100 |
Sample requests
PUT /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test
{
"dataFragmentNumber":1,// The query node and data node
"dataDuplicateNumber":1,// The query node and data node
"minServicePercent":20,// The query node and data node
"published":true,// The cluster
"active": true //index
}
Response parameters
Sample responses
Success responses
{
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": []
}
For more information, see Response struct.
Examples
Sample success responses
JSONformat
{
"requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0",
"result": {}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-03-20 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-08-28 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2022-01-12 | Add Operation | View Change Details |