Query an advanced configuration by calling GetAdvanceConfig - OpenSearch

Operation description

Method

GET

URI

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

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:GetAdvanceConfig

get

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****
configName	string	Yes	The name of the advanced configuration.	ha-cn-pl32rf0****_offline_adv_edit

Request parameters

Parameter	Type	Required	Description	Example
type	string	No	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

Sample requests

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

Response elements

Element	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request.	E45380E8-994A-5402-9806-F114B3295FCF
result	object	The result.
updateTime	integer	The time when the advanced configuration was updated.	2024-05-21 16:05:26
desc	string	The description of the advanced configuration.	Custom remarks
files	array<object>	The files.
	object	An array of files.
name	string	The file name.	ha-cn-pl32rf0****_qrs
fullPathName	string	The file path.	/cluster
isDir	boolean	Indicates whether the file is a directory.	true
isTemplate	boolean	Indicates whether the file is a container.	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.	used

Sample responses

Success responses

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": {
    "name": "my_index",
    "status": "drafting",
    "updateTime": 1631070464000,
    "desc":"test",
    "files": [
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      },
      {
        "fullPathName": "/",
        "isDir": true,
        "isTemplate": true,
        "name": "cava"
      }
    ]    
  }
}

Examples

Success response

JSON format

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "updateTime": 0,
    "desc": "Custom remarks",
    "files": [
      {
        "name": "ha-cn-pl32rf0****_qrs",
        "fullPathName": "/cluster",
        "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": "used"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.