GetLogviewDownloadUrl - 获取离线 Logview 下载链接

更新时间:
复制 MD 格式

获取指定 MaxCompute 项目中实例的离线 Logview 文件下载链接,链接自生成起有效期为 10 分钟。

接口说明

调用本接口生成指定 MaxCompute 实例的离线 Logview 文件,并返回 OSS 预签名下载 URL。

使用流程

  1. 通过路径参数 project 指定项目名称,通过 instance 指定该项目中的实例 ID。

  2. 根据下载环境选择 useVpcEndpoint:不传或设为 false 时使用默认 OSS 访问地址;设为 true 时使用服务端配置的 OSS VPC 访问地址。下载客户端需具备访问所选地址的网络条件。

  3. 从成功响应的 data 字段获取 URL,并在链接有效期内下载文件。链接自生成起 10 分钟后过期;过期后请重新调用本接口获取新链接。

文件与使用说明

  • 下载文件名为 logview_detail_{project}_{instance}.txt,文件内容为 UTF-8 编码的 JSON 格式离线 Logview 数据。具体数据随实例任务类型和可获取的信息而异,不保证包含执行结果。

  • 每次调用均重新构建离线 Logview 数据并上传。同一项目、同一实例使用相同的文件对象路径,后一次上传会覆盖前一次内容。

  • 本接口成功时返回下载 URL,不直接返回文件流。成功响应通过 requestId 标识请求,通过 data 返回下载链接。httpCode、errorCode、errorMsg 为通用响应字段,本接口成功处理时不赋值,不保证这些字段一定从响应中省略。

  • useVpcEndpoint 为 true 时,若服务端未配置 OSS VPC 访问地址,生成链接失败,不会自动回退到默认地址。

  • data 中的示例 URL 已脱敏,仅用于说明格式,不能用于实际下载。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/logview/project/{project}/instance/{instance}/downloadUrl HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

project

string

是

MaxCompute 项目名称,用于指定待下载离线 Logview 的实例所属项目。

odps_project

instance

string

是

MaxCompute 实例 ID。该实例须属于 project 参数指定的项目。

20260409110419512gx6ofeaj8fb

请求参数

名称

类型

必填

描述

示例值

useVpcEndpoint

boolean

否

是否使用 OSS VPC 访问地址生成下载链接。

  • false:使用默认 OSS 访问地址。

  • true:使用服务端配置的 OSS VPC 访问地址,下载客户端需具备访问该地址的网络条件。 默认值为 false。设为 true 且服务端未配置 OSS VPC 访问地址时,生成链接失败,不会自动回退。

返回参数

名称

类型

描述

示例值

object

返回结果。成功时 data 为下载链接,requestId 为请求 ID。通用字段 httpCode、errorCode、errorMsg 在本接口成功处理时不赋值,其序列化呈现以实际响应为准。

data

string

离线 Logview 文件的 OSS 预签名下载 URL,自生成起有效期为 10 分钟。文件扩展名为 .txt,内容为 UTF-8 编码的 JSON 数据。下载地址由 useVpcEndpoint 决定;链接过期后请重新调用本接口。示例 URL 已脱敏,不能用于实际下载。

https://example-bucket.oss-cn-hangzhou.aliyuncs.com/logview/offline/logview_detail_odps_project_20260409110419512gx6ofeaj8fb.txt?OSSAccessKeyId=LTAI5tExample****&Expires=1791777900&Signature=example****

errorCode

string

错误码。本接口成功处理时不赋值。示例 NO_PERMISSION 用于说明通用权限错误,不能与成功响应示例合并。

NO_PERMISSION

errorMsg

string

错误信息。本接口成功处理时不赋值。示例 Forbidden 用于说明通用权限错误,不能与成功响应示例合并。

Forbidden

httpCode

integer

HTTP 状态码字段。本接口成功处理时不赋值,不应仅依赖该字段是否等于 200 判断是否成功。请结合实际 HTTP 响应状态与返回内容处理结果。示例 200 仅说明字段格式。

200

requestId

string

请求 ID,用于定位和排查本次请求。

0be3e0aa16667684362147582e038f

成功时从 data 获取下载链接,requestId 用于排查请求。以下示例仅展示成功时已赋值的字段,不代表完整原始响应;通用字段是返回 null 还是省略,以实际响应为准。

{
  "requestId": "0be3e0aa16667684362147582e038f",
  "data": "https://example-bucket.oss-cn-hangzhou.aliyuncs.com/logview/offline/logview_detail_odps_project_20260409110419512gx6ofeaj8fb.txt?OSSAccessKeyId=LTAI5tExample****&Expires=1791777900&Signature=example****"
}

参数表中的示例值分别说明各字段的格式,不应组合成一次调用的完整响应。errorCode 的 NO_PERMISSION 和 errorMsg 的 Forbidden 是通用权限错误示例,不属于上述成功响应,也不表示本接口固定返回该错误;httpCode 的 200 是状态码字段的格式示例,不表示本接口成功时一定为该字段赋值。

示例

正常返回示例

JSON格式

{
  "data": "https://example-bucket.oss-cn-hangzhou.aliyuncs.com/logview/offline/logview_detail_odps_project_20260409110419512gx6ofeaj8fb.txt?OSSAccessKeyId=LTAI5tExample****&Expires=1791777900&Signature=example****",
  "errorCode": "NO_PERMISSION",
  "errorMsg": "Forbidden",
  "httpCode": 200,
  "requestId": "0be3e0aa16667684362147582e038f"
}

错误码

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

变更历史

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