GetFunctionTask - OpenSearch - Alibaba Cloud Documentation Center

Queries the details of a training task.

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.

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:DescribeFunction	get	FunctionTask acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	none	none

Request syntax

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

Request 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

Sample requests

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

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
Status	string	The status of the request.	OK
HttpCode	long	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	long	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	long	The progress. 90 indicates 90%.	90
RunId	string	The ID of the task.	trigger__2021-03-05T12:18:41
StartTime	long	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	long	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

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history