All Products
Search
Document Center

OpenSearch:ListFunctionTasks

Last Updated:Dec 05, 2023

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

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.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application.

app_group_name
functionNamestringYes

The name of the feature.

ctr
instanceNamestringYes

The name of the instance.

test_model_2
statusstringNo

The status of the task. Valid values:

  • success
  • failed
  • running
success
startTimelongNo

The start time is greater than the specified time. Specify the time in the UNIX timestamp format. Unit: milliseconds.

1582214400
endTimelongNo

The end time is less than the specified time. Specify the time in the UNIX timestamp format. Unit: milliseconds.

1582646399
pageNumberintegerNo

The number of the page to return. Default value: 1.

1
pageSizeintegerNo

The number of entries to return on each page. Default value: 1.

10

Sample requests

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

Response parameters

ParameterTypeDescriptionExample
object

The response body.

Statusstring

The status of the request.

200
HttpCodelong

The HTTP status code.

200
TotalCountlong

The total number of records that meet the requirements.

2
RequestIdstring

The ID of the request.

1638157479281
Messagestring

The error message.

fail
Codestring

The error code.

200
Resultobject []

The returned result.

[ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\"recall\":91,\"errors\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ]
EndTimelong

The timestamp that indicates the end time. Unit: milliseconds. 0 indicates that the task has not ended.

100010
ExtendInfostring

The value is a JSON string. It includes model evaluation information and training error information.

{\"recall\":91,\"errors\":[]}
FunctionNamestring

The name of the feature.

ctr
Progresslong

The progress. 90 indicates 90%.

90
RunIdstring

The ID of the task.

trigger__2021-03-05T12:18:41
StartTimelong

The timestamp that indicates the start time. Unit: milliseconds.

100010
Statusstring

The status of the task. Valid values:

  • success
  • failed
  • running
success
Generationstring

The number of iterations.

2
Latencylong

The time consumed for the request, in milliseconds.

123

Sample success responses

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

Sample success responses

JSONformat

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

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

Change history

Change timeSummary of changesOperation
No change history