变更实例规格 - UpdateLakeFormationInstanceScale
功能介绍
变更LakeFormation实例规格。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/instances/{instance_id}/scale
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目编号。获取方法,请参见获取项目ID。 |
instance_id | 是 | String | LakeFormation实例ID。创建实例时自动生成。例如:2180518f-42b8-4947-b20b-adfc53981a25。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 否 | String | 租户token。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
specs | 否 | Array of CreateSpec objects | 规格列表。 |
charge_mode | 否 | String | 计费类型:postPaid:按需计费、prePaid:包周期计费。 |
change_classify | 否 | String | 变更类型,UPGRADE:升级规格;RENEW_CHANGE:续费变更(仅支持包周期计费方式)。 |
charge_info | 否 | ChargeInfo object | 计费信息,购买包周期产品时,也就是charge_mode为prePaid时不能为空。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
product_id | 否 | String | 商品ID。已废弃,无需填写 |
spec_code | 是 | String | 规格编码。 |
stride_num | 是 | Integer | QPS规格步数,QPS为每秒最大请求数,最小为5,步长为1。只有在创建独享型实例(字段shared为false)时生效。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
period_type | 否 | String | 购买包周期产品时,也就是charge_mode为prePaid时生效,且为必选值,订购周期类型。取值范围:MONTH:包月;YEAR:包年。 |
period_num | 否 | Integer | 购买包周期产品时,也就是charge_mode为prePaid时生效,且为必选值,指定订购的时间。取值范围:当period_type为month时,取值为1~9。当period_type为year时,取值为1~3。当传入浮点型时,会自动截取为整型。 |
is_auto_renew | 否 | Boolean | 购买包周期产品时,也就是charge_mode为prePaid时生效,且为必选值,表示是否自动续订,续订时会自动支付。 按月订购时续订周期默认为1个月,按年订购时续订周期默认为1年,续订周期可自定义修改。true:为自动续订。false:为不自动续订,默认该方式。 |
is_auto_pay | 否 | Boolean | 购买包周期产品时,也就是charge_mode为prePaid时生效,且为必选值,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。true:为自动支付。false:为手动支付,默认该方式。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
X-request-id | String | 请求ID,定位辅助信息。 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:401
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:403
参数 | 参数类型 | 描述 |
|---|---|---|
error | Error object | 错误信息。 |
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
title | String | 标题。 |
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
title | String | 标题。 |
message | String | 错误信息。 |
code | String | 状态码。 |
状态码:404
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:408
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
状态码:500
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码。 |
error_msg | String | 错误描述。 |
common_error_code | String | CBC公共错误码。 |
solution_msg | String | 解决方案描述。 |
请求示例
POST https://{endpoint}/v1/{project_id}/instances/{instance_id}/scale
{
"specs" : [ {
"spec_code" : "hws.resource.type.lakeformation.qps",
"stride_num" : 1
} ]
} 响应示例
状态码:400
Bad Request
{
"error_code" : "common.01000001",
"error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
} 状态码:401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} 状态码:403
Forbidden
{
"error" : {
"code" : "403",
"message" : "X-Auth-Token is invalid in the request",
"error_code" : null,
"error_msg" : null,
"title" : "Forbidden"
},
"error_code" : "403",
"error_msg" : "X-Auth-Token is invalid in the request",
"title" : "Forbidden"
} 状态码:404
Not Found
{
"error_code" : "common.01000001",
"error_msg" : "response status exception, code: 404"
} 状态码:408
Request Timeout
{
"error_code" : "common.00000408",
"error_msg" : "timeout exception occurred"
} 状态码:500
Internal Server Error
{
"error_code" : "common.00000500",
"error_msg" : "internal error"
} 状态码
状态码 | 描述 |
|---|---|
200 | 实例规格变更成功 |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
408 | Request Timeout |
500 | Internal Server Error |
错误码
请参见错误码。

