You need to enable JavaScript to run this app.
导航
获取任务结果
最近更新时间:2024.01.31 14:31:19首次发布时间:2023.12.28 11:22:02

本接口支持获取指定离线评估任务结果。

注意事项

  • 请求频率:单用户请求频率限制为 5 次/秒
  • 超时时间:超时时间约为 5 秒
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetImageAnalyzeResult&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringGetImageAnalyzeResult接口名称。当前 API 的名称为 GetImageAnalyzeResult
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01
TaskIdString658bc51c147***243fde951f7任务 ID,您可以通过调用 GetImageAnalyzeTasks 获取指定地区全部离线评估任务 ID。
StartTimeString1703054140任务运行开始时间的 Unix 时间戳
EndTimeString1703658940任务运行结束时间的 Unix 时间戳
RunIdString658bc51ed***cb7af29f592任务执行 ID
LimitString10分页条数。默认值为 10。
OffsetString0分页偏移。默认值为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。
FileStringtos-cn-i-4u***7a/URL.txt创建任务时提交的 txt 待评估文件的存储 URI

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
ResultsArray of Results-任务结果
TotalInteger1查询的数量

Results

参数类型示例值描述
RunIdString658bc51ed***7af29f592指定的任务执行 ID
StartAtString2023-12-27 06:33:02.461 +0000 UTC离线任务启动时间

Status

String

Done

任务状态,取值如下所示:

  • Running:进行中
  • Suspend:暂停
  • Done:结束
ResultUriStringtos-cn-i-23***tn/658b***9f592.csv评估结果存储 URI

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAnalyzeResult&Version=2023-05-01&TaskId=981820****9183720&StartTime=1697701258&EndTime=1698306058&RunId=6503f977**22be798e&Limit=10&Offset=0

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetImageAnalyzeResult",
    "Version": "2023-05-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
        "Results": [
            {
                "RunId": "653a17eb2**9bd7f5ec0c2",
                "StartAt": "2023-10-26 07:40:27.563 +0000 UTC",
                "Status": "Done",
                "ResultUri": "tos-cn-i-5t**4x/653a17e**d7f5ec0c2.csv"
            }
        ],
        "Total": 1
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码

服务端 SDK

veImageX 提供了配套的开发工具集 SDK,支持多种编程语言,帮助您更方便的调用 API。