UpdateExtendConfig - 修改场景化配置模板

更新时间:
复制 MD 格式

修改Elasticsearch场景化配置模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:UpdateExtendConfig

update

*全部资源

*

无 无

请求语法

POST /openapi/instances/{InstanceId}/extend-configs/actions/update HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID。

es-cn-n6w1o1x0w001c****

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

否

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

5A2CFF0E-5718-45B5-9D4D-70B3FF****

body

string

否

场景化配置模板信息,包括配置类型和场景取值。

{"configType":"usageScenario","value":"search"}

RequestBody

RequestBody 中还需填入以下参数,用来指定场景化配置模板信息。

名称类型是否必选示例值描述
configTypeString是usageScenario配置类型。支持:usageScenario(使用场景化配置)。
valueString是general商业版实例可选:general(通用场景)、analysisVisualization(数据分析场景)、dbAcceleration(数据库加速场景)、search(搜索场景)。增强版实例可选:log(日志场景)。

示例如下。

{
    "configType": "usageScenario",
    "value": "search"
}

返回参数

名称

类型

描述

示例值

object

Result

boolean

返回结果:

  • true:修改场景模板配置成功

  • false:修改场景模板配置失败

true

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

示例

正常返回示例

JSON格式

{
  "Result": true,
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ComponentCodeValueError component value is disable
401 UserNotOpen Aliyun account is not open elasticsearch
401 StsRoleAccountNoPermission Role account has no permission or expired
401 SubAccountNoPermission Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM
401 UserUnauthorized Authentication required

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。