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

获取参数配置列表

功能介绍

该接口用于获取当前集群现有的YAML参数配置列表。

调用方法

请参见如何调用API

URI

GET /v1.0/{project_id}/clusters/{cluster_id}/ymls/template

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

指定待查询的集群ID,获取方法请参见获取集群ID

约束限制:

不涉及

取值范围:

获取方法请参见获取集群ID

默认取值:

不涉及

cluster_id

String

参数解释:

指定待查询的集群ID,获取方法请参见获取集群ID

约束限制:

不涉及

取值范围:

获取方法请参见获取集群ID

默认取值:

不涉及

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

configurations

Object

集群参数配置列表。该对象中key值以具体获取为准,value拥有以下属性。

  • id: 参数配置ID。

  • key: 参数名称。

  • vlaue: 参数值。

  • defaultValue: 参数默认值。

  • regex: 参数约束限制。

  • desc: 参数中文描述。

  • type: 参数类型描述。

  • moduleDesc: 参数功能中文描述。

  • modifyEnable: 参数是否可修改 true: 可以修改。 false:不可修改。

  • enableValue: 参数支持修改的值。

  • fileName: 参数存在的文件名称。默认为elasticsearch.yml。

  • version: 版本信息。

  • descENG: 参数英文描述。

  • moduleDescENG: 参数功能英文描述。

请求示例

获取当前集群现有的YAML参数配置列表。

GET https://{Endpoint}/v1.0/{project_id}/clusters/{cluster_id}/ymls/template

响应示例

状态码: 200

请求已成功。

{
  "configurations" : {
    "http.cors.allow-credentials" : {
      "id" : "b462d13c-294b-4e0f-91d3-58be2ad02b99",
      "key" : "http.cors.allow-credentials",
      "value" : "false",
      "defaultValue" : "false",
      "regex" : "^(true|false)$",
      "desc" : "跨域访问是否返回头部的Access-Control-Allow-Credentials,布尔类型,包括true和false",
      "type" : "Boolean",
      "moduleDesc" : "跨域访问",
      "modifyEnable" : "true",
      "enableValue" : "true,false",
      "fileName" : "elasticsearch.yml",
      "version" : null,
      "descENG" : "Whether to return the Access-Control-Allow-Credentials of the header during cross-domain access. The value is a Boolean value and the options are true and false.",
      "moduleDescENG" : "Cross-domain Access"
    }
  }
}

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
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 ListYmlsSolution {

    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();
        ListYmlsRequest request = new ListYmlsRequest();
        request.withClusterId("{cluster_id}");
        try {
            ListYmlsResponse response = client.listYmls(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
# 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 = ListYmlsRequest()
        request.cluster_id = "{cluster_id}"
        response = client.list_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
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.ListYmlsRequest{}
	request.ClusterId = "{cluster_id}"
	response, err := client.ListYmls(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码

相关文档