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

修改实例计费模式

功能介绍

修改设备接入实例的计费模式,支持将按需计费模式修改为包年/包月计费模式。

接口约束:当前实例的规格支持包年/包月计费模式时,才可以修改实例的计费模式为包年/包月。支持的实例规格请参见产品规格说明

调试

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

URI

POST /v5/iot/{project_id}/iotda-instances/{instance_id}/change-charge-mode

表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参数

参数

是否必选

参数类型

描述

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

参数说明:创建包年/包月实例时可指定,表示是否自动续订,续订的周期和原周期相同,且续订时会自动支付。

取值范围

  • true:自动续订

  • false:默认值,不自动续订

is_auto_pay

Boolean

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

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

order_id

String

参数说明:订单号。

请求示例

修改实例的计费模式为包年,订单到期后自动续费。

POST https://{endpoint}/v5/iot/{project_id}/iotda-instances/{instance_id}/change-charge-mode

{
  "period_type" : "year",
  "period_num" : 1,
  "is_auto_renew" : true
}

响应示例

状态码: 200

OK

{
  "order_id" : "CS22121614500ABCD"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码