Automate Config Deployment with PublishAdvanceConfig API - OpenSearch

Operation description

Method

POST

URI

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

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

update

*Instance

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

None

Request syntax

POST /openapi/ha3/instances/{instanceId}/advanced-configs/{configName}/actions/publish HTTP/1.1

Path Parameters

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.	{\"desc\":\"new version\"}
desc	string	No	The description of the advanced configuration.	Customconfig
files	array<object>	No	The files.
	array<object>	No
ossPath	string	No	The path of the Object Storage Service (OSS) object.	oss://opensearch/test.json
operateType	string	No	The operation type. Valid values: UPDATE and DELETE. Default value: UPDATE.	UPDATE
parentFullPath	string	No	The path of the parent directory.	/
fileName	string	No	The file name.	vector_question_schema.json
dirName	string	No	The directory name.	/clusters
config	object	No	The information about the advanced configuration.
content	string	No	The file content.	{\"url\":\"http://xxxxxx.aliyuncs.com/outnet_hz/packages/xxxxx/opensearch_offline_plugins_xxxxx.tar\"}
variables	object	No	The variables.
	object	No	The variable.
description	string	No	The description of the variable.	Custom variable
disableModify	boolean	No	Specifies whether the variable is not allowed to be modified.	true
isModify	boolean	No	Specifies whether the variable is modified.	true
type	string	No	The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable.	NORMAL
value	string	No	The variable value.	test

POST /openapi/ha3/instances/ose-test1/advanced-configs/test/actions/publish

{
    "desc": "new version"
}

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	The ID of the request	10D5E615-69F7-5F49-B850-00169ADE513C
result	object	The result returned	{}

Sample responses

Sample success responses

{
  "requestId": "65911539-5a8b-4bce-96a5-4d608900dc46",
  "result": {}
}

For more information, see Response structure.

Examples

Success response

JSON format

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {}
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.