文档

RenewInstance - 实例续费

更新时间:
重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

该接口用于为Hologres实例手动续费。可以在续费的同时开启按月自动续费。

接口说明

警告 该 API 操作涉及费用,请确保在使用该接口前,已充分了解实时数仓 Hologres 的收费方式和价格。

  • Hologres 计费详情请参见计费概述

  • Hologres 续费操作请参见续费管理

  • 续费操作仅适用预付费(PrePaid)实例。

调试

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

授权信息

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

请求语法

POST /api/v1/instances/{instanceId}/renew

请求参数

名称类型必填描述示例值
instanceIdstring

实例 id。

hgprecn-cn-i7m2v08uu00a
bodyobject

请求体。

durationinteger

续费周期。单位:月。

2
autoRenewboolean

是否开启按月自动续费,默认不开启。取值:

  • true:开启。
  • false:不开启
说明 已开启自动续费的实例,再次开启会报错。
true

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Dataobject

返回结果。

Codestring

错误码。

InvalidChargeType.UnRenewable
Messagestring

错误详细信息。

不支持续费的付费类型
OrderIdstring

订单 Id

221625608580893
Successboolean

续费是否成功。

  • true:续费成功。
  • false:续费失败。
true
ErrorCodestring

错误码

null
ErrorMessagestring

错误信息。

null
HttpStatusCodestring

http 状态码。

200
Successstring

请求结果,表示此次请求是否发生异常,和业务无关

false
说明
  • 参数校验错误,仍然会返回正常的 Data,Success 为 false,并包含 Code 和 Message。除非抛出异常,否则成功与否由 Data.Success 来判断。
  • 使用新版 SDK 包调用本接口时,由于 SDK 内部的客户端默认超时时间和服务端的不一致,因此可能返回请求超时的错误,但实际上接口已调用成功。如需避免这个问题,您可以在调用前设置 ReadTimeout 参数为 20000。
  • 示例

    正常返回示例

    JSON格式

    {
      "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
      "Data": {
        "Code": "InvalidChargeType.UnRenewable",
        "Message": "不支持续费的付费类型",
        "OrderId": "221625608580893",
        "Success": true
      },
      "ErrorCode": "null",
      "ErrorMessage": "null",
      "HttpStatusCode": "200",
      "Success": "false"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读 (1)