文档

ScaleInstance - 实例变配

更新时间:
重要

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

该接口用于变更Hologres实例的规格和存储空间。

接口说明

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

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

  • 变配实例计算资源期间实例不可用,变配实例存储资源不影响实例的正常使用。请勿频繁进行实例变配操作。详情请参见实例升降配

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hologram:ScaleInstanceWrite
  • 全部资源
    *

请求语法

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

请求参数

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

实例 id。

hgprecn-cn-xxxxxxx
bodyobject

请求体。

cpulong

实例规格。取值:

  • 8 核 32 GB (计算节点数量:1)
  • 16 核 64 GB (计算节点数量:1)
  • 32 核 128 GB(计算节点数量:2)
  • 64 核 256 GB(计算节点数量:4)
  • 96 核 384 GB(计算节点数量:6)
  • 128 核 512 GB(计算节点数量:8)
说明
  • 填写核数即可。
  • 购买 1024 以上规格请提交工单申请。
  • Shared 实例类型无需指定规格。
  • 8 核 32GB(计算节点数量:1)的规格仅用于体验使用,不可用于生产。
  • 128
    storageSizelong

    实例标准存储空间。单位:GB。

    说明 按量付费(PostPaid)实例会忽略此参数
    1000G
    coldStorageSizelong

    实例低频存储空间。单位:GB。

    说明 按量付费(PostPaid)实例会忽略此参数。
    1000G
    scaleTypestring

    变配类型。取值:

    • UPGRADE:升配
    • DOWNGRADE:降配
    说明
  • 升配规格不能小于原规格,为空的字段表示维持原规格不变,在此基础上,至少一项规格比原规格大。
  • 降配规格不能大于原规格,为空的字段表示维持原规格不变,在此基础上,至少一项规格比原规格小。
  • UPGRADE
    gatewayCountlong

    网关数量,取值[2, 50]。

    说明 只有 Warehouse 类型需要指定该参数。
    4

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    Id of the request

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

    返回结果。

    OrderIdstring

    订单 Id

    219183853450000
    Codestring

    错误码。

    InvalidScaleType.Unsupported
    Messagestring

    错误详细信息。

    不支持的变配类型
    Successboolean

    变配是否成功。

    枚举值:
    • true成功
    • false失败
    true
    HttpStatusCodestring

    http 状态码。

    200
    ErrorCodestring

    错误码

    null
    ErrorMessagestring

    错误信息。

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

    正常返回示例

    JSON格式

    {
      "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
      "Data": {
        "OrderId": "219183853450000",
        "Code": "InvalidScaleType.Unsupported",
        "Message": "不支持的变配类型",
        "Success": true
      },
      "HttpStatusCode": "200",
      "ErrorCode": "null",
      "ErrorMessage": "null"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-10-17API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用
    • 本页导读 (1)