UpdateFunctionInstance - OpenSearch - Alibaba Cloud Documentation Center

Updates an algorithm instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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
opensearch:WriteFunction	Write	FunctionInstance acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
Body	object	Yes	The parameter body.
cron	string	No	The cron expression used to schedule periodic training, in the format of (Minutes Hours DayofMonth Month DayofWeek). The default value is empty, which indicates that no periodic training is performed. DayofWeek 0 indicates Sunday.	"0 3 ? * 0,1,3,5"
createParameters	object []	No	The parameters that are used to create the instance.	{ "name": "title_field", "value": "title" }
name	string	No	The name of the parameter.	title_field
value	string	No	The value of the parameter.	title
usageParameters	object []	No	The parameters that are used.
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 instance
appGroupIdentity	string	Yes	The name of the application.	"app_group_name"
functionName	string	Yes	The name of the feature.	"ctr"
instanceName	string	Yes	The name of the instance.	"ctr_test"

Sample requests (Only the createParameters and cron parameters are updated.)

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

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

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
Status	string	The status of the request. Valid values: `OK: The request was successful.` `FAIL: The request failed.`	OK
HttpCode	long	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	long	The time consumed for the request, in milliseconds.	10

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history