CreateFunctionTask - OpenSearch - Alibaba Cloud Documentation Center

Starts a training task for 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	FunctionTask acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
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

POST /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/task

Response parameters

Parameter	Type	Description	Example
	object	The response body.
Status	string	The status of the request.	OK
HttpCode	long	The HTTP status code.	200
RequestId	string	The ID of the request.	1638157990724
Message	string	The error message.	success
Code	string	The error code.	Task.IsRunning
Latency	long	The time consumed for the request, in milliseconds.	123

Sample success responses

{
  "status" : "OK",
  "requestId" : "",
  "httpCode": 200,
  "code": "",
  "message": "",
  "latency" : 123,
  "result" : {},
}

Examples

Sample success responses

JSONformat

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "1638157990724",
  "Message": "success",
  "Code": "Task.IsRunning",
  "Latency": 123
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history