ListFunctionTasks_智能开放搜索 OpenSearch_API文档-阿里云OpenAPI开发者门户

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

opensearch:DescribeFunction	Get	FunctionTask acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	无	无

请求语法

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

路径参数

字段名称	字段详情
appGroupIdentitystring	应用名称示例值:app_group_name参考取值来源: CreateAppGroupCredentials ListAppGroups
functionNamestring	功能名称示例值:ctr参考取值来源: CreateFunctionTask
instanceNamestring	实例名称示例值:test_model_2参考取值来源: CreateFunctionInstance GetFunctionDefaultInstance ListFunctionInstances

请求参数

字段名称	字段详情
statusstring	任务状态：展开详情示例值:success
startTimeinteger<int64>	起始时间大于设定时间，单位毫秒注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1582214400
endTimeinteger<int64>	结束时间小于设定时间，单位毫秒注意该字段类型为 Long，在序列化/反序列化的过程中可能导致精度丢失，请注意数值不得大于 9007199254740991。示例值:1582646399
pageNumberinteger<int32>	页码（默认为 1）示例值:1
pageSizeinteger<int32>	每页大小（默认为 1）示例值:10

请求说明

示例

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

返回参数

字段名称	字段详情
Statusstring	状态码示例值:200
HttpCodeinteger<int64>	HTTP 状态码。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:200
TotalCountinteger<int64>	符合要求的总记录数注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:2
RequestIdstring	请求 id 示例值:1638157479281
Messagestring	请求返回信息示例值:fail
Codestring	HTTP 状态码示例值:200
Resultarray<object>	返回结果。示例值:[ { "functionName": "ctr", "progress": 100, "status": "success", "startTime": 100010, "endTime": 200020, "extendInfo": "{\"recall\":91,\"errors\":[]}", "runId": "trigger__2021-03-05T12:18:41" } ]
Latencyinteger<int64>	请求耗时（单位毫秒）注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:123

返回说明

正常返回示例

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

返回示例

变更历史

暂无变更历史