All Products
Search
Document Center

OpenSearch:ListAdvanceConfigs

Last Updated:Oct 16, 2024

Obtains a list of advanced configurations.

Operation description

Sample requests

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
searchengine:ListAdvanceConfigslist
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-pl32rf0js04
typestringNo

The type of advanced configurations that you want to query. Valid values: - online -offline (default)

online
dataSourceNamestringNo

The name of the data source.

ha-cn-pl32rf0****_test_api
indexNamestringNo

The index name.

test_api
newModebooleanNo

Specifies whether the OpenSearch Vector Search Edition instance is of the new version.

true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

requestIdstring

The ID of the request.

4FB0325E-8C37-5525-96AC-0333523170A3
resultarray<object>

The advanced configurations.

itemobject

The result returned.

updateTimelong

The time when the advanced configuration was updated.

1631070464000
descstring

The description of the advanced configuration.

test
filesarray<object>

The files.

fileobject

The information about files.

namestring

The file name.

file_name_1
fullPathNamestring

The absolute path in which the file is stored.

/path/wpd/nae
isDirboolean

Indicates whether the file is a directory. Valid values: true and false.

true
isTemplateboolean

Indicates whether the file is a template. Valid values: true and false.

true
contentstring

The content of the advanced configuration that is returned.

{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
contentTypestring

The type of the configuration content. Valid values: FILE, GIT, HTTP, and ODPS.

FILE
namestring

The name of the advanced configuration.

my_index
statusstring

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
creatorstring

The Alibaba Cloud account ID of the user who created the advanced configuration.

123456
advanceConfigTypestring
  • 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 timeSummary of changesOperation
2024-05-16The request parameters of the API has changed. The response structure of the API has changedView Change Details
2022-01-12Add OperationView Change Details