获取高级配置列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| searchengine:ListAdvanceConfigs | list |
|
| 无 |
请求语法
GET /openapi/ha3/instances/{instanceId}/advanced-configs HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 实例 ID | ha-cn-pl32rf0**** |
| type | string | 否 | 高级配置类型： - online - offline（默认） | online |
| dataSourceName | string | 否 | 数据源名称。 | ha-cn-pl32rf0****_test_api |
| indexName | string | 否 | 索引名称 | test_api |
| newMode | boolean | 否 | 是否为新版本控制台页面 | true |
返回参数
返回示例
正确返回
{
"requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
"result": [
{
"name": "my_index",
"status": "drafting",
"updateTime": 1631070464000,
"desc":"test",
"files":[
{
"name": "file_name_1",
"fullPathName": "/path/wpd/nae",
"isDir": true,
"isTemplate": true
}
]
},
{
"name": "my_index2",
"status": "drafting",
"updateTime": 1631070464000,
"desc":"test",
"files":[
{
"name": "file_name_1",
"fullPathName": "/path/wpd/nae",
"isDir": true,
"isTemplate": true
}
]
}
]
}
示例
正常返回示例
JSON格式
{
"requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
"result": [
{
"updateTime": 1631070464000,
"desc": "自定义描述",
"files": [
{
"name": "file_name_1",
"fullPathName": "/path/wpd/nae",
"isDir": true,
"isTemplate": true
}
],
"content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}",
"contentType": "FILE",
"name": "my_index",
"status": "drafting",
"creator": "123456",
"advanceConfigType": "ONLINE"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-16 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
| 2022-01-12 | 新增 OpenAPI | 查看变更详情 |