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

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

功能介绍

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

调试

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

接口约束

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

URI

  • URI格式

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

  • 参数说明
    表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

    排序字段。

    • check_time:检查时间。
    • expiration_time:过期时间。
    • 默认为检查时间。

    target_version

    String

    目标版本。

    is_available

    Boolean

    是否有效。

    • true:表示有效。
    • false:表示无效。

请求消息

  • 请求参数

    无。

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

响应消息

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

    名称

    参数类型

    说明

    total_count

    Integer

    总记录数。

    inspection_reports

    Array of objects

    检查报告信息。

    详情请参见表3

    表3 inspection_report字段数据结构说明

    名称

    参数类型

    说明

    id

    String

    检查报告ID。

    check_time

    String

    检查时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

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

    expiration_time

    String

    到期时间,格式为“yyyy-mm-ddThh:mm:ssZ”。

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

    target_version

    String

    目标版本。

    result

    String

    检查结果。

    • success:表示成功。
    • failed:表示失败。
    • running:表示检查中。

    detail

    String

    检查报告详情。

  • 正常响应样例
    {
             "total_count": 1,
             "inspection_reports": [
                      {
                                "id": "289903e1-3006-19e9-e054-5fb7fe376552",
                                "check_time": "2023-03-06T02:33:49+0800",
                                "expiration_time": "2023-03-07T02:33:49+0800",
                                "target_version": "14.4",        
                                "result": "success",
                                "detail": "2023-03-06 18:33:26 --- pg_upgrade check task                              begin\n2023-03-06 18:34:40 --- pg_upgrade check on master:                       [user_check_report]User check success"
                      }
             ]
    }

状态码

错误码

请参见错误码

相关文档