文档首页/ 云搜索服务 CSS/ API参考/ 参数配置接口/ 获取参数配置列表
更新时间：2024-10-17 GMT+08:00
查看PDF
分享

获取参数配置列表

功能介绍

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

cluster_id

是

String

指定查询集群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: 参数功能英文描述。

请求示例

无

响应示例

状态码： 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"
    }
  }
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

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

409

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

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

412

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

错误码

请参见错误码。

父主题： 参数配置接口