Call the UpdateFunctionInstance API to update a function instance configuration - OpenSearch

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

opensearch:WriteFunction

update

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

PUT /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the OpenSearch application.	"app_group_name"
functionName	string	Yes	The name of the feature.	"ctr"
instanceName	string	Yes	The name of the instance.	"ctr_test"

Request parameters

Parameter	Type	Required	Description	Example
Body	object	No	The request body.	{}
cron	string	No	The schedule for periodic training. The value must be a cron expression in the format of Minutes Hours DayofMonth Month DayofWeek. If you leave this parameter empty, periodic training is disabled by default. For DayofWeek, 0 indicates Sunday.	"0 3 ? * 0,1,3,5"
createParameters	array<object>	No	The list of creation parameters.	{ "name": "title_field", "value": "title" }
	object	No	The parameter details.	{}
name	string	No	The name of the parameter.	title_field
value	string	No	The value of the parameter.	title
usageParameters	array<object>	No	The list of usage parameters.
	object	No	The parameter details.
name	string	No	The name of the parameter.	allow_dict_id
value	string	No	The value of the parameter.	123
description	string	No	The description of the instance.	test

Example: Update only createParameters and cron

PUT /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test

{
    "createParameters": [
        {
            "name": "param1",
            "value": "new value"
        }
    ],
    "cron": ""
}

Response elements

Element	Type	Description	Example
	object	Schema of Response	{}
Status	string	The request status. `OK: The request is successful.` `FAIL: The request failed.`	OK
HttpCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	"3A809095-C554-5CF5-8FCE-BE19D4673790"
Message	string	The error message.	"instance not exist."
Code	string	The error code.	"Instance.NotExist"
Latency	integer	The time consumed by the request. Unit: milliseconds (ms).	10

Examples

Success response

JSON format

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "\"3A809095-C554-5CF5-8FCE-BE19D4673790\"",
  "Message": "\"instance not exist.\"",
  "Code": "\"Instance.NotExist\"",
  "Latency": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.