GetFunctionTask - OpenSearch - Alibaba Cloud Documentation Center

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:DescribeFunction

get

*FunctionTask

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

None

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances/{instanceName}/tasks/{generation} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
functionName	string	Yes	The name of the feature.	ctr
instanceName	string	Yes	The name of the instance.	test_model_2
generation	string	Yes	The number of iterations.	1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Sample requests

GET /v4/openapi/app-groups/my-app/functions/ctr/instances/ctr_test/tasks/3

Response elements

Element	Type	Description	Example
	object	The schema of the response.
Status	string	The request status.	OK
HttpCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Message	string	The error message.	operation success
Code	string	The error code.	Task.NotExist
Result	object	The result of the request.
EndTime	integer	The timestamp that indicates the end time of the task. Unit: milliseconds.	1647213406267
ExtendInfo	string	The extended information, which is a JSON string.	{\"recall\":91,\"errors\":[]}
FunctionName	string	The name of the feature.	ctr
Generation	string	The number of iterations.	1
Progress	integer	The progress. 90 indicates 90%.	90
RunId	string	The ID of the task.	trigger__2021-03-05T12:18:41
StartTime	integer	The timestamp that indicates the start time of the task. Unit: milliseconds.	1647212220000
Status	string	The status of the task. Valid values: success failed running	success
Latency	integer	The time consumed for the request, in milliseconds.	123

Sample success responses

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "result": {
      "functionName": "ctr",
      "progress": 100,
      "status": "success",
      "startTime": 100010,
      "endTime": 200020,
      "extendInfo": "{\"recall\":91,\"errors\":[]}",
      "runId": "trigger__2021-03-05T12:18:41",
      "generation": "3"
    }
}

Examples

Success response

JSON format

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "A4D487A9-A456-5AA5-A9C6-B7BF2889CF74",
  "Message": "operation success",
  "Code": "Task.NotExist",
  "Result": {
    "EndTime": 1647213406267,
    "ExtendInfo": "{\\\"recall\\\":91,\\\"errors\\\":[]}",
    "FunctionName": "ctr",
    "Generation": "1",
    "Progress": 90,
    "RunId": "trigger__2021-03-05T12:18:41",
    "StartTime": 1647212220000,
    "Status": "success"
  },
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.