修改参数配置 - UpdateYmls
功能介绍
Elasticsearch集群的核心配置信息都集中在“elasticsearch.yml”和“kibana.yml”文件中,OpenSearch集群的核心配置信息都集中在“opensearch.yml”和“opensearch_dashboards.yml”文件中。当需要根据业务需求调整集群的运行行为时,比如优化查询速度、修改跨域访问配置、调整内部缓存大小或管理后台任务队列等,则可以通过修改参数配置实现。
在使用该接口之前,建议先调用获取参数配置列表,确认集群的参数配置情况,便于根据需求修改参数配置。
接口约束
当参数类型UpdateYmlsReqEditModify为elasticsearch.yml时,自定义参数必须配置为Elasticsearch或OpenSearch支持的参数,否则集群重启会失败。
当参数类型UpdateYmlsReqEditModify为kibana.yml时,自定义参数必须配置为Kibana或Dashboards支持的参数,否则集群重启Kibana或Dashboards会失败。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| edit | 是 | UpdateYmlsReqEdit object | 参数解释: 配置文件信息。 约束限制: 不涉及 |
| inst_type | 否 | String | 参数解释: 节点类型。 约束限制: KooSearch集群涉及不同类型的节点,其他类型集群不涉及。 取值范围: 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| modify | 否 | UpdateYmlsReqEditModify object | 参数解释: 修改参数配置的操作。 约束限制: |
| delete | 否 | UpdateYmlsReqEditModify object | 参数解释: 删除自定义参数配置的操作。 约束限制: |
| reset | 否 | UpdateYmlsReqEditModify object | 参数解释: 重置参数配置的操作。 约束限制: |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| elasticsearch.yml | 否 | Object | 参数解释: 参数配置列表,值为需要修改的json数据,OpenSearch集群也使用此参数,即修改opensearch.yml时,这里也是填写elasticsearch.yml。 约束限制: 自定义参数必须配置为Elasticsearch或OpenSearch支持的参数,否则集群重启会失败,建议谨慎操作,以免影响业务。 |
| kibana.yml | 否 | Object | 参数解释: 参数配置列表,值为需要修改的json数据。OpenSearch集群也使用此参数,即修改opensearch_dashboards.yml时,这里也是填写kibana.yml。 约束限制: 自定义参数必须配置Kibana或Dashboards支持的参数,否则集群重启Kibana或Dashboards会失败,建议谨慎操作,以免影响业务。 |
| system.config | 否 | Object | 参数解释: 参数配置列表,值为需要修改的json数据,集群修改system.config时,会在系统config目录下生成以json数据中key值为名称,value值为内容的文件。 约束限制: 修改的json数据中key值为固定值,value值允许输入最大长度不能超过100KB(102400字节/字符,包含换行符)。 |
响应参数
状态码:200
请求示例
-
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update { "edit" : { "modify" : { "elasticsearch.yml" : { "thread_pool.force_merge.size" : 1 } } } } -
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update { "edit" : { "delete" : { "elasticsearch.yml" : { "thread_pool.force_merge.size" : 1 } } } } -
POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update { "edit" : { "reset" : { "elasticsearch.yml" : { "http.cors.allow-credentials" : "false" } } } }
响应示例
状态码:200
请求成功。
{
"acknowledged" : true,
"externalMessage" : null,
"httpErrorResponse" : null
} SDK代码示例
SDK代码示例如下。
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class UpdateYmlsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); UpdateYmlsRequest request = new UpdateYmlsRequest(); request.withClusterId("{cluster_id}"); UpdateYmlsReq body = new UpdateYmlsReq(); UpdateYmlsReqEditModify modifyEdit = new UpdateYmlsReqEditModify(); modifyEdit.withElasticsearchYml("{\"thread_pool.force_merge.size\":1}"); UpdateYmlsReqEdit editbody = new UpdateYmlsReqEdit(); editbody.withModify(modifyEdit); body.withEdit(editbody); request.withBody(body); try { UpdateYmlsResponse response = client.updateYmls(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class UpdateYmlsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); UpdateYmlsRequest request = new UpdateYmlsRequest(); request.withClusterId("{cluster_id}"); UpdateYmlsReq body = new UpdateYmlsReq(); UpdateYmlsReqEditModify deleteEdit = new UpdateYmlsReqEditModify(); deleteEdit.withElasticsearchYml("{\"thread_pool.force_merge.size\":1}"); UpdateYmlsReqEdit editbody = new UpdateYmlsReqEdit(); editbody.withDelete(deleteEdit); body.withEdit(editbody); request.withBody(body); try { UpdateYmlsResponse response = client.updateYmls(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.css.v1.region.CssRegion; import com.huaweicloud.sdk.css.v1.*; import com.huaweicloud.sdk.css.v1.model.*; public class UpdateYmlsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CssClient client = CssClient.newBuilder() .withCredential(auth) .withRegion(CssRegion.valueOf("<YOUR REGION>")) .build(); UpdateYmlsRequest request = new UpdateYmlsRequest(); request.withClusterId("{cluster_id}"); UpdateYmlsReq body = new UpdateYmlsReq(); UpdateYmlsReqEditModify resetEdit = new UpdateYmlsReqEditModify(); resetEdit.withElasticsearchYml("{\"http.cors.allow-credentials\":\"false\"}"); UpdateYmlsReqEdit editbody = new UpdateYmlsReqEdit(); editbody.withReset(resetEdit); body.withEdit(editbody); request.withBody(body); try { UpdateYmlsResponse response = client.updateYmls(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } }
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateYmlsRequest() request.cluster_id = "{cluster_id}" modifyEdit = UpdateYmlsReqEditModify( elasticsearch_yml="{\"thread_pool.force_merge.size\":1}" ) editbody = UpdateYmlsReqEdit( modify=modifyEdit ) request.body = UpdateYmlsReq( edit=editbody ) response = client.update_ymls(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateYmlsRequest() request.cluster_id = "{cluster_id}" deleteEdit = UpdateYmlsReqEditModify( elasticsearch_yml="{\"thread_pool.force_merge.size\":1}" ) editbody = UpdateYmlsReqEdit( delete=deleteEdit ) request.body = UpdateYmlsReq( edit=editbody ) response = client.update_ymls(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcss.v1.region.css_region import CssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcss.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CssClient.new_builder() \ .with_credentials(credentials) \ .with_region(CssRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateYmlsRequest() request.cluster_id = "{cluster_id}" resetEdit = UpdateYmlsReqEditModify( elasticsearch_yml="{\"http.cors.allow-credentials\":\"false\"}" ) editbody = UpdateYmlsReqEdit( reset=resetEdit ) request.body = UpdateYmlsReq( edit=editbody ) response = client.update_ymls(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.UpdateYmlsRequest{} request.ClusterId = "{cluster_id}" var elasticsearchYmlModify interface{} = "{\"thread_pool.force_merge.size\":1}" modifyEdit := &model.UpdateYmlsReqEditModify{ ElasticsearchYml: &elasticsearchYmlModify, } editbody := &model.UpdateYmlsReqEdit{ Modify: modifyEdit, } request.Body = &model.UpdateYmlsReq{ Edit: editbody, } response, err := client.UpdateYmls(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.UpdateYmlsRequest{} request.ClusterId = "{cluster_id}" var elasticsearchYmlDelete interface{} = "{\"thread_pool.force_merge.size\":1}" deleteEdit := &model.UpdateYmlsReqEditModify{ ElasticsearchYml: &elasticsearchYmlDelete, } editbody := &model.UpdateYmlsReqEdit{ Delete: deleteEdit, } request.Body = &model.UpdateYmlsReq{ Edit: editbody, } response, err := client.UpdateYmls(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
-
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" css "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/css/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := css.CssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := css.NewCssClient(hcClient) request := &model.UpdateYmlsRequest{} request.ClusterId = "{cluster_id}" var elasticsearchYmlReset interface{} = "{\"http.cors.allow-credentials\":\"false\"}" resetEdit := &model.UpdateYmlsReqEditModify{ ElasticsearchYml: &elasticsearchYmlReset, } editbody := &model.UpdateYmlsReqEdit{ Reset: resetEdit, } request.Body = &model.UpdateYmlsReq{ Edit: editbody, } response, err := client.UpdateYmls(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 非法请求。 建议直接修改该请求,不要重试该请求。 |
| 409 | 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 |
| 412 | 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 |
错误码
请参见错误码。