ListAdvanceConfigs - OpenSearch - Alibaba Cloud Documentation Center

Obtains a list of advanced configurations.

Operation description

Sample requests

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /openapi/ha3/instances/{instanceId}/advanced-configs

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0js04
type	string	No	The type of advanced configurations that you want to query. Valid values: - online -offline (default)	online
dataSourceName	string	No	The name of the data source.	ha-cn-pl32rf0****_test_api
indexName	string	No	The index name.	test_api
newMode	boolean	No	Specifies whether the OpenSearch Vector Search Edition instance is of the new version.	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request.	4FB0325E-8C37-5525-96AC-0333523170A3
result	array<object>	The advanced configurations.
	object	The result returned.
updateTime	long	The time when the advanced configuration was updated.	1631070464000
desc	string	The description of the advanced configuration.	test
files	array<object>	The files.
	object	The information about files.
name	string	The file name.	file_name_1
fullPathName	string	The absolute path in which the file is stored.	/path/wpd/nae
isDir	boolean	Indicates whether the file is a directory. Valid values: true and false.	true
isTemplate	boolean	Indicates whether the file is a template. Valid values: true and false.	true
content	string	The content of the advanced configuration that is returned.	{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
contentType	string	The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.	FILE
name	string	The name of the advanced configuration.	my_index
status	string	The status of the advanced configuration. Valid values: drafting: The advanced configuration is in the draft state. used: The advanced configuration is being used. unused: The advanced configuration is not used. trash: The advanced configuration is being deleted.	drafting
creator	string	The Alibaba Cloud account ID of the user who created the advanced configuration.	123456
advanceConfigType	string	The type of the advanced configuration. Valid values: -ONLINE: online configuration -ONLINE_CAVA: online Cava configuration -ONLINE_PLUGIN: online plug-in configuration -ONLINE_QUERY: query configuration -OFFLINE_DICT: offline dictionary configuration -OFFLINE_TABLE: offline table configuration -OFFLINE_COMMON: offline configuration -OFFLINE_PLUGIN: offline plug-in configuration -OFFLINE_INDEX: index configuration	ONLINE

Examples

Sample success responses

JSONformat

{
  "requestId": "4FB0325E-8C37-5525-96AC-0333523170A3",
  "result": [
    {
      "updateTime": 1631070464000,
      "desc": "test",
      "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"
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-16	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2022-01-12	Add Operation	View Change Details