接口功能介绍
本接口用于查询用户名下有效的资源列表。
接口约束
请求参数说明：
String类型的参数，传""等同于不传。
Integer类型的参数，传0等同于不传。
Boolean类型的参数，传false等同于不传。
URI
GET /v2/resources
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| ResourceType | 是 | String | 资源类型编码。取值：VSS_VIDEO：视频存储包；VSS_AI：视频分析包；VSS_UPLOAD_BW：上行带宽包；VSS_DOWNLOAD_BW：下行带宽包；VSS_VIDEO_OD：设备管理；VSS_STORAGE_OD：按需存储；VSS_AI_OD：按需AI分析。 | VSS_VIDEO |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码，执行成功时，不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据，执行失败时，不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Resources | Array of Objects | 资源列表。 | Resource | |
| RequestId | String | 请求ID。 | f914976d478d4cce90ca26b27aebac75 |
表 Resource
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ResourceId | String | 资源id。 | 531616878506819628 | |
| ResourceType | String | 资源类型编码。取值：VSS_VIDEO：视频存储包；VSS_AI：视频分析包；VSS_UPLOAD_BW：上行带宽包；VSS_DOWNLOAD_BW：下行带宽包；VSS_VIDEO_OD：设备管理；VSS_STORAGE_OD：按需存储；VSS_AI_OD：按需AI分析。 | VSS_VIDEO | |
| ResourceName | String | 资源名称。1.ResourceType为VSS_VIDEO时，取值：{码率}-{天数}，例如 2-30，表示2M码率存储30天；2.ResourceType为VSS_AI时，取值：AI-100、AI-200、AI-300；3.ResourceType为VSS_UPLOAD_BW时，取值：BW-UPLOAD；4.ResourceType为VSS_DOWNLOAD_BW时，取值：BW-DOWNLOAD。 | 8-3 | |
| ResourceMode | String | 资源计费方式。取值：PACKAGE：包周期计费；ONDEMAND：按需计费。 | PACKAGE | |
| IsTrialOrder | String | 是否试用。取值：0代表商用；1代表试用。 | 0 | |
| TotalSize | Integer | 资源总量。包周期取值：1.ResourceType为VSS_VIDEO时，取值：设备总路数；2.ResourceType为VSS_AI时，取值：视频分析总路数；3.ResourceType为VSS_UPLOAD_BW时，取值：上行带宽包总量；4.ResourceType为VSS_DOWNLOAD_BW时，取值：下行带宽包总量。 | 300 | |
| UsageSize | Integer | 资源当前已使用量。取值：1.ResourceType为VSS_VIDEO时，取值：设备每绑定一路，该使用量增加一路，反之则减少一路；2.ResourceType为VSS_AI时，取值：设备每绑定一路，该使用量增加一路，反之则减少一路。 | 100 | |
| CreatedTime | String | 资源创建时间。 | 2022-11-25 16:03:04 | |
| ExpireTime | String | 资源过期时间。 | 2024-12-01 10:55:04 |
枚举参数
无
请求示例
请求url
GET '/v2/resources?ResourceType=VSS_VIDEO'
请求头header
无
请求体body
无
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "f914976d478d4cce90ca26b27aebac75","returnObj": {"Resources": [{"ResourceId": "531616878506819628","ResourceType": "VSS_VIDEO","ResourceName": "8-3","ResourceMode": "","ResourceState": "","IsTrialOrder": "0","TotalSize": "300","UsageSize": "284","CreateTime": "2022-11-25 16:03:04","ExpireTime": "2024-12-01 10:55:04"}],"RequestId": "f914976d478d4cce90ca26b27aebac75"}}
状态码
请参考 状态码
错误码
请参考 错误码
