1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
本接口(RefundStorageService)用于退订已购买的云存服务。
退订时,云存服务对应订单的处理方式 :
- 未开始的订单自动回到已付费订单池
- 已开始的订单自动失效
- 购买云存接口,优先从已付费订单池中分配订单
默认接口请求频率限制:40次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RefundStorageService。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-26。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ServiceId | 是 | String | 云存服务ID 示例值:xxxxxx |
OrderId | 否 | String | 云存子订单ID。如果指定子订单ID,则仅退订该子订单,如果未指定子定单ID,则退订所有子订单 示例值:111 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ServiceId | String | 云存服务ID |
StorageRegion | String | 云存服务所在的区域 |
Tid | String | 设备TID |
ChnNum | Integer | 视频流通道号。(对于存在多路视频流的设备,如NVR设备,与设备实际视频流通道号对应) 示例值:0 |
AccessId | String | 终端用户在IoT Video平台的注册ID |
StartTime | Integer | 服务开始时间 示例值:1602664760 |
EndTime | Integer | 服务失效时间 示例值:1605343160 |
Status | Integer | 服务状态 1:正常使用中 2:待续费。设备云存服务已到期,但是历史云存数据未过期。续费后仍可查看这些历史数据。 3:已过期。查询不到设备保存在云端的数据。 4:等待服务生效。 示例值:2 |
Data | Array of StorageOrder | 有效云存定单列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 退订已购买的云存服务
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RefundStorageService
<公共请求参数>
{
"ServiceId": "xxxxxx",
"OrderId": "111"
}
输出示例
{
"Response": {
"Status": 2,
"ChnNum": 0,
"AccessId": "xx",
"ServiceId": "xx",
"RequestId": "xx",
"StartTime": 1602664760,
"Tid": "xx",
"EndTime": 1605343160,
"Data": [
{
"OrderId": "xx",
"PkgId": "xx",
"EndTime": 0,
"StartTime": 0,
"Status": 0
}
],
"StorageRegion": "xx"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.SignatureFailure | 签名校验失败。 |
AuthFailure.TokenFailure | 获取token为空。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
FailedOperation.PermissionDenied | 无相关操作权限。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Tid | tid非法。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |