根据实例名称更新实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
opensearch:WriteFunction | update |
|
| 无 |
请求语法
PUT /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName} HTTP/1.1
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Body | object | 否 | body 参数 | |
cron | string | 否 | 周期训练信息,cron 语法(Minutes Hours DayofMonth Month DayofWeek),为空表示不进行周期训练(默认),其中 DayofWeek 为 0 表示星期日 | "0 3 ? * 0,1,3,5" |
createParameters | array<object> | 否 | 创建参数列表 | { "name": "title_field", "value": "title" } |
object | 否 | 参数体 | ||
name | string | 否 | 参数名称 | title_field |
value | string | 否 | 参数值 | title |
usageParameters | array<object> | 否 | 使用参数列表 | |
object | 否 | 参数体 | ||
name | string | 否 | 参数名称 | allow_dict_id |
value | string | 否 | 参数值 | 123 |
description | string | 否 | 实例描述 | 测试实例 |
appGroupIdentity | string | 是 | opensearch 应用名 | "app_group_name" |
functionName | string | 是 | 功能名称 | "ctr" |
instanceName | string | 是 | 实例名称 | "ctr_test" |
返回参数
示例
正常返回示例
JSON
格式
{
"Status": "OK",
"HttpCode": 200,
"RequestId": "\"3A809095-C554-5CF5-8FCE-BE19D4673790\"",
"Message": "\"instance not exist.\"",
"Code": "\"Instance.NotExist\"",
"Latency": 10
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史