文档首页/ 云数据库 RDS/ API参考/ API v3(推荐)/ 大版本升级/ 查询实例大版本升级历史(PostgreSQL)
更新时间:2024-03-28 GMT+08:00

查询实例大版本升级历史(PostgreSQL)

功能介绍

查询实例大版本升级历史。

接口约束

  • 该接口仅支持PostgreSQL引擎。
  • 实例在创建、变更规格、修改端口、冻结、异常等状态下不能执行该操作。

URI

  • URI格式

    GET /v3/{project_id}/instances/{instance_id}/major-version/upgrade-histories?offset={offset}&limit={limit}&order={order}&sort_field={sort_field}

  • 参数说明
    表1 参数说明

    名称

    参数类型

    是否必选

    说明

    project_id

    String

    租户在某一Region下的项目ID。

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

    instance_id

    String

    实例ID。

    offset

    Integer

    索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

    limit

    Integer

    查询记录数。默认为10,不能为负数,最小值为1,最大值为100。

    order

    String

    排序方式。

    • DESC:降序。
    • ASC:升序。
    • 默认为降序。

    sort_field

    String

    排序字段。

    • start_time:开始时间。
    • end_time:结束时间。
    • 默认为开始时间。

请求消息

  • 请求参数

    无。

  • URI样例
    https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/upgrade-histories?offset=0&limit=10

响应消息

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

    名称

    参数类型

    说明

    total_count

    Integer

    总记录数。

    upgrade_reports

    Array of objects

    升级报告信息。

    详情请参见表3

    表3 upgrade_report字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    升级报告ID。

    start_time

    String

    升级开始时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    end_time

    String

    升级结束时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    src_instance_id

    String

    原实例ID。

    src_database_version

    String

    原数据库版本。

    dst_instance_id

    String

    目标实例ID。

    dst_database_version

    String

    目标数据库版本。

    result

    String

    升级结果。

    • success:表示成功。
    • failed:表示失败。
    • running:表示升级中。

    is_private_ip_changed

    Boolean

    是否将实例内网IP切换到目标大版本实例。

    • true:表示切换。
    • false:表示不切换。

    private_ip_change_time

    String

    实例内网IP修改时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

    其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

    statistics_collection_mode

    String

    统计信息收集模式。

    • before_change_private_ip:修改实例内网IP前收集。
    • after_change_private_ip:修改实例内网IP后收集。

    detail

    String

    升级报告详情。

  • 正常响应样例
    {
             "total_count": 1,
             "upgrade_reports": [
                      {
                                "id": "1a8fda5a-17a6-ebc4-bf1f-97ae837f432b",
                                "start_time": "2023-03-06T02:45:49+0800",
                                "end_time": "2023-03-06T02:50:49+0800",
                                "src_instance_id": "dccacebb7b884ee18bc5c02c918ef2b0in03",
                                "src_database_version": "13.9",
                                "dst_instance_id": "6b5750504be1403191c4f00e4ffaee5ein03",
                                "dst_database_version": "14.6",
                                "result": "success",
                                "is_private_ip_changed": true,
                                "private_ip_change_time": "2023-03-06T03:10:49+0800",
                                "statistics_collection_mode": "before_change_private_ip",
                                "detail": "2023-03-06 18:33:26 --- pg_upgrade upgrade task                         begin"
                      }
             ]
    }

状态码

错误码

请参见错误码