查詢用戶資源列表
更新時間 2024-09-11 16:11:35
最近更新時間: 2024-09-11 16:11:35
分享文章
接口功能介紹
本接口用于查詢用戶名下有效的資源列表。
接口約束
請求參數說明：
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"}}
狀態碼
請參考
錯誤碼
請參考
