文档

领取免费试用的云存储套餐

更新时间:

调用接口ConsumeFreeStorage领取免费试用的云存储套餐。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为100。

说明 单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ConsumeFreeStorage

系统规定参数。取值:ConsumeFreeStorage。

ProductKey String a1BwAGV****

设备所属的产品ProductKey

重要 如果传入该参数,需同时传入DeviceName
DeviceName String light

设备的名称。

重要 如果传入该参数,需同时传入ProductKey
IotId String Q7uOhVRdZRRlDnTLv****00100

设备ID。

重要 IotId作为设备唯一标识符,和ProductKeyDeviceName组合是一一对应的关系。如果传入该参数,则无需传入ProductKeyDeviceName。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。
EventRecordProlong Boolean true

是否延长事件录像。

  • true:表示在事件录像过程中,持续触发的事件会延长录像至事件结束。
  • false(默认):表示每个事件上报云端按配置的事件录像时长(如10秒)录制对应时长的录像。
EventRecordDuration Integer 2

事件录像总时长。取值范围为0~30,单位为秒。

ImmediateUse Boolean true

是否立即使用。

  • true:表示新领取免费套餐立即生效。
  • false(默认):表示新领取的免费套餐在之前套餐到期后生效。
EnableDefaultPlan Boolean true

是否设置默认录像计划,默认为全天的录像计划。

  • true:不设置默认录像计划。
  • false(默认):设置默认录像计划为全天的录像计划。
PreRecordDuration Integer 2

事件录像的预录时长。取值范围为0~5,单位为秒。

Quota Integer 12

使用赠送的云存储配额,单位为月。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。

返回数据

名称

类型

示例值

描述

Code String 400

调用结果状态码:

  • 调用成功,返回200。
  • 调用失败,返回错误码。详细信息,请参见下文错误码
Data Struct

调用成功,返回的结果。

Consumed Integer 1

是否已领取免费的云存储套餐。

  • 0:表示未领取。
  • 1:表示已领取。
EndTime String 2023-09-01 12:00:00

结束时间。格式为yyyy-MM-dd HH:mm:ss

EndTimeUTC String 2023-09-01T12:00:00Z

结束时间UTC。格式yyyy-MM-ddTHH:mm:ssZ

Expired Integer 0

云存储服务是否已到期。

  • 0:表示未到期。
  • 1:表示已到期。
  • 2:表示订单冻结停用。
Lifecycle Integer 1

数据在云端的存储周期。取值为1、3、7和30,单位为天。

Months Integer 12

云存储服务有效期,单位为月。

RemainQuota Integer 1

免费试用云存储的剩余配额,单位为月。

StartTime String 2023-01-01 12:00:00

开始时间。格式为yyyy-MM-dd HH:mm:ss

StartTimeUTC String 2023-01-01T12:00:00Z

开始时间UTC,格式为yyyy-MM-ddTHH:mm:ssZ

Type Integer 1

云存储套餐类型。

  • 1:表示连续型。
  • 2:表示事件型。
ErrorMessage String Request parameter error.

调用失败时,返回的出错信息。

RequestId String E******7-4***-***B-8**E-D3********65

阿里云为该请求生成的唯一标识符。

Success Boolean true

是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://linkvisual.cn-shanghai.aliyuncs.com/?Action=ConsumeFreeStorage
&ProductKey=a1BwAGV****
&DeviceName=light
&EventRecordProlong=true
&EventRecordDuration=30
&PreRecordDuration=5
&Quota=12
&<公共请求参数>

正常返回示例

XML格式

<ConsumeFreeStorageResponse>
  <RequestId>E******7-4***-***B-8**E-D3********65</RequestId>
  <Data>
        <Type>1</Type>
        <RemainQuota>1</RemainQuota>
        <StartTimeUTC>2023-01-01T12:00:00Z</StartTimeUTC>
        <EndTime>2023-09-01 12:00:00</EndTime>
        <Months>12</Months>
        <Lifecycle>1</Lifecycle>
        <StartTime>2023-01-01 12:00:00</StartTime>
        <Expired>0</Expired>
        <Consumed>1</Consumed>
        <EndTimeUTC>2023-09-01T12:00:00Z</EndTimeUTC>
  </Data>
  <Code>200</Code>
  <Success>true</Success>
</ConsumeFreeStorageResponse>

JSON格式

{
    "RequestId": "E******7-4***-***B-8**E-D3********65",
    "Data": {
        "Type": 1,
        "RemainQuota": "1",
        "StartTimeUTC": "2023-01-01T12:00:00Z",
        "EndTime": "2023-09-01 12:00:00",
        "Months": 12,
        "Lifecycle": 1,
        "StartTime": "2023-01-01 12:00:00",
        "Expired": 0,
        "Consumed": 1,
        "EndTimeUTC": "2023-09-01T12:00:00Z"
    },
    "Code": 200,
    "Success": true
}

错误码

HttpCode

错误码

错误信息

描述

400 iot.vision.RequestParamError Request parameter error. 请求参数错误。
403 iot.vision.RequestAuthFailed Request auth failed. 请求鉴权失败。
403 iot.vision.RequestForbidden Request forbidden. 请求被禁止。
429 iot.vision.RequestTrafficControl Request traffic control. 请求太频繁被限流。
400 iot.vision.RequestFailed Request failed. 请求失败。
400 iot.vision.UnexpectedInternalError Unexpected internal error. 未知内部错误。
400 iot.vision.DeviceNoOwner Device has no owner. 设备没有绑定管理员。
400 iot.vision.FreeStorageQuotaLimit No enough free storage quota or exceed limit. 免费试用的云存储配额不足或超限制。

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

  • 本页导读 (1)
文档反馈