使用GetFunctionTask获取功能训练任务的状态与详情-智能开放搜索 OpenSearch-阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

opensearch:DescribeFunction

get

*FunctionTask

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称	my_app_group_name
functionName	string	是	功能名称	ctr
instanceName	string	是	实例名称	test_model_2
generation	string	是	迭代次数	1

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

示例

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

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Status	string	请求状态	OK
HttpCode	integer	HTTP 状态码	200
RequestId	string	请求 ID	A4D487A9-A456-5AA5-A9C6-B7BF2889CF74
Message	string	返回的错误信息	operation success
Code	string	返回的错误码	Task.NotExist
Result	object	返回结果
EndTime	integer	任务结束时间（单位 ms）	1647213406267
ExtendInfo	string	扩展信息（json string）	{\"recall\":91,\"errors\":[]}
FunctionName	string	功能名称	ctr
Generation	string	迭代次数	1
Progress	integer	进度，90 表示 90%	90
RunId	string	任务 ID	trigger__2021-03-05T12:18:41
StartTime	integer	任务开始时间（单位 ms）	1647212220000
Status	string	任务状态 success failed running	success
Latency	integer	请求耗时（单位 ms）	123

正常返回示例

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

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。