全部产品
Search
文档中心

智能开放搜索 OpenSearch:CreateFolder - 创建目录

更新时间:Oct 16, 2024

创建目录。

接口说明

方法

POST

URI

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
searchengine:CreateFoldercreate
  • Folder
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

请求语法

POST /openapi/ha3/instances/{instanceId}/sql-studio/databases/{database}/folders HTTP/1.1

请求参数

名称类型必填描述示例值
instanceIdstring

实例 id

ha-cn-pl32rf0****
databasestring

数据库名称

general
bodyobject

请求体参数

namestring

目录名

gist_qc
parentlong

父类目 id(必传),为空时则默认为 1

1
typestring

table, instance, template, function

instance

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID

E7B7D598-B080-5C8E-AA35-D43EC0D5F886
resultobject

返回结果。

idlong

文件夹 id

25030
gmtCreatestring

创建时间

1719221186114
gmtModifiedstring

更新时间

1719221186114
namestring

名称

test
parentlong

父层级 id。

-1
isDirinteger

是否为目录。取值:-true:是-false:否

True
typestring

table, instance, template, function

instance
instanceIdlong

实例 id

ha-cn-pl32rf0****
templateIdlong

模板 ID。

1

示例

正常返回示例

JSON格式

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {
    "id": 25030,
    "gmtCreate": "1719221186114",
    "gmtModified": "1719221186114",
    "name": "test",
    "parent": -1,
    "isDir": 0,
    "type": "instance",
    "instanceId": 0,
    "templateId": 1
  }
}

错误码

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