更新时间:2024-10-08 GMT+08:00
分享

修改参数配置

功能介绍

该接口用于修改参数配置。

调用方法

请参见如何调用API

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID和名称

cluster_id

String

指定修改参数配置的集群ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

edit

UpdateYmlsReqEdit object

配置文件信息。

表3 UpdateYmlsReqEdit

参数

是否必选

参数类型

描述

modify

UpdateYmlsReqEditModify object

配置文件操作。

  • modify: 修改参数配置。

  • delete: 删除参数配置。

  • reset: 重置参数配置。

表4 UpdateYmlsReqEditModify

参数

是否必选

参数类型

描述

elasticsearch.yml

Object

参数配置列表。值为需要修改的json数据。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

acknowledged

Boolean

修改是否成功。

  • true: 修改成功。

  • false: 修改失败。

externalMessage

String

错误信息描述。当acknowledged为true时,该字段返回null。

httpErrorResponse

String

HTTP错误信息。默认为null。

请求示例

修改参数配置。

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update

{
  "edit" : {
    "modify" : {
      "elasticsearch.yml" : {
        "thread_pool.force_merge.size" : 1
      }
    }
  }
}

响应示例

状态码: 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
# 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
42
43
44
45
46
47
48
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := css.NewCssClient(
        css.CssClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求,不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码

相关文档