调用ScaleInstance实例变配_实时数仓 Hologres(Hologres)-阿里云帮助中心

接口说明

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

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

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hologram:ScaleInstance

update

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 id。	hgprecn-cn-xxxxxxx
body	object	否	请求体。
cpu	integer	否	实例规格。取值： 16 核 64 GB （计算节点数量：1） 32 核 128 GB（计算节点数量：2） 64 核 256 GB（计算节点数量：4） 96 核 384 GB（计算节点数量：6） 128 核 512 GB（计算节点数量：8）等说明填写核数即可。购买 1024 以上规格请提交工单申请。 Shared 实例类型无需指定规格。	128
storageSize	integer	否	实例标准存储空间。单位：GB。说明按量付费（PostPaid）实例会忽略此参数	1000G
coldStorageSize	integer	否	实例低频存储空间。单位：GB。说明按量付费（PostPaid）实例会忽略此参数。	1000G
scaleType	string	是	变配类型。取值： UPGRADE：升配 DOWNGRADE：降配说明升配规格不能小于原规格，为空的字段表示维持原规格不变，在此基础上，至少一项规格比原规格大。降配规格不能大于原规格，为空的字段表示维持原规格不变，在此基础上，至少一项规格比原规格小。枚举值： DOWNGRADE : DOWNGRADE UPGRADE : UPGRADE	UPGRADE
gatewayCount	integer	否	网关数量，取值[2, 50]。说明只有 Warehouse 类型需要指定该参数。	4
enableServerlessComputing	boolean	否	是否开启 ServerlessComputing 枚举值： true : true false : false	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
Data	object	返回结果。
OrderId	string	订单 Id	219183853450000
Code	string	错误码。	InvalidScaleType.Unsupported
Message	string	错误详细信息。	不支持的变配类型
Success	boolean	变配是否成功。枚举值： true : 成功 false : 失败	true
HttpStatusCode	string	http 状态码。	200
ErrorCode	string	错误码	null
ErrorMessage	string	错误信息。	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"
}

错误码

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

变更历史

更多信息，参考变更详情。