ListFunctionTasks - OpenSearch - Alibaba Cloud Documentation Center

Queries the training tasks. The results are sorted in descending order by start time.

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 HTTP/1.1

Path 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.	test_model_2

Request parameters

Parameter	Type	Required	Description	Example
status	string	No	The status of the task. Valid values: success failed running	success
startTime	integer	No	Returns tasks that started after the specified time. The time is a UNIX timestamp in milliseconds.	1582214400
endTime	integer	No	Returns tasks that ended before the specified time. The time is a UNIX timestamp in milliseconds.	1582646399
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries to return on each page. Default value: 1.	10

Sample request

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

Response elements

Element	Type	Description	Example
	object	The response body.	{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "totalCount": 1, "result": [ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\"recall\":91,\"errors\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ] }
Status	string	The status of the request.	200
HttpCode	integer	The HTTP status code.	200
TotalCount	integer	The total number of records that meet the requirements.	2
RequestId	string	The ID of the request.	1638157479281
Message	string	The returned message.	fail
Code	string	The error code.	200
Result	array<object>	The returned result.	[ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\"recall\":91,\"errors\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ]
	object	The result body.	{ "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\"recall\":91,\"errors\":[]}", "runId": "trigger__2021-03-05T12:18:41" }
EndTime	integer	The time when the task ended. This is a UNIX timestamp in milliseconds. A value of 0 indicates that the task has not ended.	100010
ExtendInfo	string	A JSON string that contains information such as model evaluation results and training errors.	{\"recall\":91,\"errors\":[]}
FunctionName	string	The name of the feature.	ctr
Progress	integer	The progress of the task. For example, a value of 90 indicates that the task is 90% complete.	90
RunId	string	The ID of the task.	trigger__2021-03-05T12:18:41
StartTime	integer	The time when the task started. This is a UNIX timestamp in milliseconds.	100010
Status	string	The status of the task. success failed running	success
Generation	string	The iteration number.	2
Latency	integer	The time consumed by the request, in milliseconds.	123

Sample success response

{
    "status": "OK",
    "requestId": "",
    "httpCode": 200,
    "code": "",
    "message": "",
    "latency": 123,
    "totalCount": 1,
    "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": "200",
  "HttpCode": 200,
  "TotalCount": 2,
  "RequestId": "1638157479281",
  "Message": "fail",
  "Code": "200",
  "Result": [
    {
      "EndTime": 100010,
      "ExtendInfo": "{\\\"recall\\\":91,\\\"errors\\\":[]}",
      "FunctionName": "ctr",
      "Progress": 90,
      "RunId": "trigger__2021-03-05T12:18:41",
      "StartTime": 100010,
      "Status": "success",
      "Generation": "2"
    }
  ],
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.