文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 历史会话分析(PostgreSQL)/ 查询历史会话分析的下载信息 - ShowHistorySessionAnalyseDownloadInfo
更新时间:2026-06-30 GMT+08:00
分享

查询历史会话分析的下载信息 - ShowHistorySessionAnalyseDownloadInfo

功能介绍

查询历史会话分析的下载信息。

调试

您可以在API Explorer中调试该接口。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

rds:instance:getHistorySessionDownload

read

-

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

接口约束

该接口仅支持RDS for PostgreSQL引擎。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/history-session-analyse-upload?type={type}

  • 参数说明
    表1 参数说明

    名称

    是否必选

    说明

    project_id

    参数解释:

    租户在某一region下的project ID。

    获取方法请参见获取项目ID

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    instance_id

    参数解释:

    实例ID。

    可调用查询数据库实例列表接口,通过表4中的“id”获取。

    约束限制:

    不涉及。

    取值范围:

    不涉及。

    默认取值:

    不涉及。

    type

    参数解释:

    下载信息类型。

    约束限制:

    不涉及。

    取值范围:

    • session:表示下载历史会话。
    • wait_event:表示下载历史等待事件。
    • top_sql:表示下载历史Top SQL。

    默认取值:

    不涉及。

请求消息

无。

请求示例

查询历史会话分析的下载信息。

GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/24c6678f474241fe89ee9c42f768022ein03/history-session-analyse-upload?type=session

响应消息

  • 正常响应要素说明
    表2 要素说明

    名称

    参数类型

    说明

    count

    Integer

    参数解释:

    记录个数。

    取值范围:

    不涉及。

    list

    Array of objects

    参数解释:

    下载信息。

    详情请参见表3

    表3 Session

    名称

    参数类型

    说明

    workflow_id

    String

    参数解释:

    任务ID。

    取值范围:

    不涉及。

    file_name

    String

    参数解释:

    生成的下载文件名。

    取值范围:

    不涉及。

    status

    String

    参数解释:

    当前链接的生成状态。

    取值范围:

    不涉及。

    file_size

    String

    参数解释:

    文件大小。单位Byte。

    取值范围:

    不涉及。

    file_link

    String

    参数解释:

    下载链接。

    取值范围:

    不涉及。

    file_link_expiration_time

    Long

    参数解释:

    下载链接过期时间。

    取值范围:

    不涉及。

    start_time

    Long

    参数解释:

    开始时间。

    格式为UTC时间戳。

    取值范围:

    不涉及。

    end_time

    Long

    参数解释:

    结束时间。

    格式为UTC时间戳。

    取值范围:

    不涉及。

  • 正常响应样例
    { 
      "list" : [ { 
        "status" : "SUCCESS", 
        "workflow_id" : "705bbb2d-b568-42ee-8ad7-f9b43f6780f1", 
        "file_name" : "a8e531baf4804b0a840e1b98cd146caf_topSql_download_1_20251209115539926.zip", 
        "file_size" : "225.0", 
        "file_link" : "xxx", 
        "file_link_expiration_time" : 1765281653734, 
        "start_time" : 1764869600000, 
        "end_time" : 1765249216000 
      } ], 
      "count" : 1 
    }
  • 异常响应

    请参见异常响应结果

状态码

错误码

请参见错误码

相关文档