All Products
Search
Document Center

OpenSearch:ModifyAdvanceConfig

Last Updated:Oct 16, 2024

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

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

ha-cn-tl32m2c4u01
configNamestringYes

The name of the advanced configuration.

ha-cn-18qug6zlc1r_offline_adv_edit
bodyobjectNo

The request body.

namestringNo

The name of the advanced configuration.

ha-cn-zvp2qr1sk01_qrs
statusstringNo

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
updateTimelongNo

The time when the advanced configuration was updated.

2024-02-27T07:50:55Z
descstringNo

The description of the advanced configuration.

test
filesarray<object>No

The files.

fileobjectNo
namestringNo

The node name.

general
fullPathNamestringNo

The full path of the file.

/cluster.json
isDirbooleanNo

Specifies whether the file is a directory.

true
isTemplatebooleanNo

Specifies whether the file is a template.

true
contentstringNo

The content of the advanced configuration that is returned.

""
contentTypestringNo

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

FILE

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The request ID.

2AE63638-5420-56DC-BF59-37D8174039A0
resultobject

The result.

{}

Examples

Sample success responses

JSONformat

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {}
}

Error codes

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