全部产品
Search
文档中心

智能开放搜索 OpenSearch:ListAdvanceConfigDir - 获取高级配置目录下文件列表

更新时间:Oct 16, 2024

获取高级配置目录下文件列表。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir?dirName={dirName}

调试

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

授权信息

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

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

请求语法

GET /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/dir HTTP/1.1

请求参数

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

实例 id。

ha-cn-pl32rf0****
configNamestring

配置名称。

ha-cn-pl32rf0****_online_config_v3
dirNamestring

目录名称。

/zones/general

请求示例

GET /openapi/ha3/instances/ose-test1/advanced-configs

返回参数

名称类型描述示例值
object
requestIdstring

请求 ID

2AE63638-5420-56DC-BF59-37D8174039A0
resultarray<object>

返回结果

itemobject

高级配文件列表

namestring

集群名称

hz_pre_vpc_domain_1
fullPathNamestring

绝对路径

/path/wpd/nae
isDirboolean

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

true
isTemplateboolean

是否是模板。取值:-true:是-false:否

true

返回示例

正确返回

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": [
    {
      "name": "file_name_1",
      "fullPathName": "/path/wpd/nae",
      "isDir": true,
      "isTemplate": true
    }
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": [
    {
      "name": "hz_pre_vpc_domain_1",
      "fullPathName": "/path/wpd/nae",
      "isDir": true,
      "isTemplate": true
    }
  ]
}

错误码

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