可以实时查看到企业剩余存储空间、可用方数。
可用于监控企业资源使用情况,用户可基于接口进行开发,实现告警功能。当企业存储空间紧张时,企业管理员可以收到通知,提前进行处理。
默认接口请求频率限制:20次/秒。
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/enterprise/data/resource?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | 3.9无此接口 |
enterpriseId | String | Query | 是 | 无 | 企业ID,通过管理平台-云视讯API获得 | 5.2 |
signature | String | Query | 签名鉴权1.0(旧):是 签名鉴权2.0:否 | 无 | API签名,参见签名规则 | 5.2 |
resourceType | String[] | Body | 是 | 无 | 查询条件:不同资源类型 STORAGE(存储容量), SESSION(共享方数), RECORD(录制资源), H323(H323资源) | 5.2 (RECORD,H323类型仅在5.2环境支持) |
请求消息体示例(Json)
{
"resourceType":[
"STORAGE",
"SESSION",
"RECORD",
"H323"
]
}
返回结果示例:
成功时返回结果数据,失败时返回小鱼RESTAPI错误码
{
"session": {
"total": xxxxxx,
"available": xxxxxx
},
"storage": {
"total": xxxxxx,
"available": xxxxxx
},
"record": {
"total": xxxxxx,
"available": xxxxxx
},
"H323": {
"total": xxxxxx,
"available": xxxxxx
}
}
返回参数说明
参数 | 说明 |
session | 共享方数(单位:方) |
- total | 总方数 |
- available | 剩余可用方数 |
storage | 存储容量(单位:byte) |
- total | 总存储容量 (-1代表无存储上限) |
- available | 剩余存储容量 |
record | 录制资源(单位:次数) |
- total | 总并发录制数量 |
- available | 剩余并发录制数量 |
H323 | H323资源容量 |
- total | 总H323资源容量 |
- available | 剩余H323资源数量 |