更新时间:2024-11-26 GMT+08:00

修改实例规格信息

功能介绍

修改设备接入实例的规格。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v5/iot/{project_id}/iotda-instances/{instance_id}/resize

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID。获取方法请参见 获取项目ID

instance_id

String

参数说明:实例ID。

取值范围:长度不超过36,由小写字母[a-f]、数字、连接符(-)的组成。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

表3 请求Body参数

参数

是否必选

参数类型

描述

flavor

Flavor object

参数说明:设备接入实例的规格参数。

is_auto_pay

Boolean

参数说明:修改包年/包月实例的规格时可指定,表示是否自动从客户的账户中支付,此字段不影响自动续订的支付方式。

取值范围:true - 自动支付,从账户余额自动扣费; false - 默认值,只提交订单不支付。

delay

Boolean

参数说明:是否延时变更设备实例的计费信息。约束:如需延时变更,需要先设置实例的变更时间窗。

取值范围

  • true:延迟变更,规格变更任务将在指定的变更时间窗内执行。

  • false:立即变更,规格变更任务将立即执行。

表4 Flavor

参数

是否必选

参数类型

描述

type

String

参数说明:待创建设备接入实例的规格名称。详情请参见产品规格说明中的规格编码。

size

Integer

参数说明:待创建设备接入标准版实例的单元数量。详情请参见产品规格说明。当instance_type是standard时,该参数必填。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

order_id

String

参数说明:订单号,修改包年包月实例时返回该参数,修改按需实例时返回为空。

请求示例

修改标准版实例规格,修改后的规格为标准版中频单元,单元个数为2。

POST https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}/resize

{
  "flavor" : {
    "type" : "iotda.standard.s2",
    "size" : 2
  }
}

响应示例

状态码: 200

OK

{
  "order_id" : "CS22121614500ABCD"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码