RenameFolder - 修改目录名称_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

修改目录名称。

接口说明

方法

PUT

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}/name

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:RenameFolder	update	Folder acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

PUT /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders/{folderId}/name HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 id	ha-cn-pl32rf0****
database	string	是	数据库名称	general
folderId	long	是	文件夹 id	-1
body	object	否	请求体参数
name	string	是	文件夹名称	test

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	object	返回结果。
id	long	主键 id	1
gmtCreate	string	创建时间	1719221186114
gmtModified	string	修改时间。	1719221186114
name	string	文件名称	test
parent	long	父层级 id。	-1
isDir	integer	是否为目录。取值：-true：是-false：否	True
type	string	table, instance, template, function	template
instanceId	long	实例 id	1
templateId	long	模板 ID。	1

示例

正常返回示例

JSON格式

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {
    "id": 1,
    "gmtCreate": "1719221186114",
    "gmtModified": "1719221186114",
    "name": "test",
    "parent": -1,
    "isDir": 0,
    "type": "template",
    "instanceId": 1,
    "templateId": 1
  }
}

错误码

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