ListAdvanceConfigs - OpenSearch - Alibaba Cloud Documentation Center

Retrieves a list of advanced configurations.

Operation description

Method

GET

URI

/openapi/ha3/instances/{instanceId}/advanced-configs?type=online

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:ListAdvanceConfigs

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
type	string	No	The type of the advanced configuration. Valid values: - online - offline (default)	online
dataSourceName	string	No	The data source name.	ha-cn-pl32rf0****_test_api
indexName	string	No	The index name.	test_api
newMode	boolean	No	Specifies whether to use the new version of the page.	true
pageNumber	string	No	The page number. The default value is 1.	1
pageSize	string	No	The number of entries to return on each page. The default value is 10.	10

Request example

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

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	4FB0325E-8C37-5525-96AC-0333523170A3
result	array<object>	The returned result.
	object	A list of advanced configurations.
updateTime	integer	The update time.	1631070464000
desc	string	The description.	Custom Description
files	array<object>	A list of files.
	object	The file information.
name	string	The file name.	file_name_1
fullPathName	string	The absolute path.	/path/wpd/nae
isDir	boolean	Specifies whether the file is a directory. Valid values: - `true` - `false`	true
isTemplate	boolean	Specifies whether the file is a template. Valid values: - `true` - `false`	true
content	string	The configuration content. This parameter is returned for HTTP and Git requests.	{\"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 configuration is a draft. - `used`: The configuration is in use. - `unused`: The configuration is not in use. - `trash`: The configuration is being deleted.	drafting
creator	string	The ID of the user who created the configuration.	123456
advanceConfigType	string	ONLINE: online configuration ONLINE_CAVA: online Cava configuration ONLINE_PLUGIN: online plugin ONLINE_QUERY: query configuration OFFLINE_DICT: offline dictionary configuration OFFLINE_TABLE: offline table configuration OFFLINE_COMMON: common offline configuration OFFLINE_PLUGIN: offline plugin OFFLINE_INDEX: index configuration	ONLINE

Response example

Successful response

{
  "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
        }
      ]
    }
  ]
}

Examples

Success response

JSON format

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.