All Products
Search
Document Center

OpenSearch:PublishAdvanceConfig

Last Updated:Oct 16, 2024

Publishes a version of advanced configurations.

Operation description

Method

POST

URI

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

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:PublishAdvanceConfigupdate
  • Instance
    acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-7e22rof5304
configNamestringYes

The configuration name.

ha-cn-0ju2rrogr01_online_config_v3
bodyobjectNo

The request body.

descstringNo

The description of the advanced configuration.

Custom configuration
filesarray<object>No

The files.

objectNo
ossPathstringNo

The path of the Object Storage Service (OSS) object.

oss://opensearch/test.json
operateTypestringNo

The operation type. Valid values: UPDATE and DELETE. Default value: UPDATE.

UPDATE
parentFullPathstringNo

The path of the parent directory.

/
fileNamestringNo

The file name.

vector_question_schema.json
dirNamestringNo

The directory name.

/clusters
configobjectNo

The information about the advanced configuration.

contentstringNo

The file content.

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

The variables.

objectNo

The variable.

descriptionstringNo

The description of the variable.

Custom variable
disableModifybooleanNo

Specifies whether the variable is not allowed to be modified.

true
isModifybooleanNo

Specifies whether the variable is modified.

true
typestringNo

The variable type. Valid values: NORMAL: common variable. FUNCTION: function variable.

NORMAL
valuestringNo

The variable value.

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

{
    "desc": "new version"
}

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The ID of the request

10D5E615-69F7-5F49-B850-00169ADE513C
resultobject

The result returned

{}

Sample responses

Sample success responses

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

For more information, see Response structure.

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2024-05-16The internal configuration of the API is changed, but the call is not affectedView Change Details
2022-01-12Add OperationView Change Details