GetAdvanceConfig - OpenSearch - Alibaba Cloud Documentation Center

Queries the information about an advanced configuration.

Operation description

Method

GET

URI

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

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:GetAdvanceConfig	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-18qug6zlc1r
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
configName	string	Yes	The name of the advanced configuration.	ha-cn-18qug6zlc1r_offline_adv_edit

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The ID of the request.	E45380E8-994A-5402-9806-F114B3295FCF
result	object	The result.
updateTime	long	The time when the advanced configuration was updated.	""
desc	string	The description of the advanced configuration.	close alarm, chiji id 37080
files	array<object>	The files.
files	object	An array of files.
name	string	The file name.	ha-cn-2r42ostoc01_qrs
fullPathName	string	The file path.	""
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.	ha-cn-0ju2s170b03_qrs
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.	0,1,3,6,8

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

Sample success responses

JSONformat

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "updateTime": 0,
    "desc": "close alarm, chiji id 37080",
    "files": [
      {
        "name": "ha-cn-2r42ostoc01_qrs",
        "fullPathName": "\"\"",
        "isDir": true,
        "isTemplate": true
      }
    ],
    "content": "{\\\"url\\\":\\\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\\\"}",
    "contentType": "FILE",
    "name": "ha-cn-0ju2s170b03_qrs",
    "status": "0,1,3,6,8"
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-01-12	Add Operation	View Change Details