SP管理员分页查询企业资源
描述
SP根据条件查询企业的资源项。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
GET |
|---|---|
请求地址 |
/v1/usg/dcs/sp/corp/{corp_id}/resource |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
|---|---|---|---|---|
corp_id |
是 |
String |
Path |
企业id。 |
offset |
否 |
Integer |
Query |
查询偏移量，若超过最大数量，则返回最后一页。 默认值：0 |
limit |
否 |
Integer |
Query |
查询数量。 默认值：10 |
searchKey |
否 |
String |
Query |
搜索条件。 |
startExpireDate |
否 |
Integer |
Query |
查询过期时间在该时间戳之后的资源项。 |
endExpireDate |
否 |
Integer |
Query |
查询过期时间在该时间戳之前的资源项。 |
type |
否 |
String |
Query |
资源类型。 |
typeId |
否 |
String |
Query |
资源类型Id，若想搜索5方VMR时，需携带5方vmrpkg对应的id。 |
status |
否 |
Integer |
Query |
资源状态:
|
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
X-Request-Id |
否 |
String |
Header |
请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。 |
Accept-Language |
否 |
String |
Header |
语言参数，默认为中文zh-CN，英文为en-US。 |
状态码
HTTP状态码 |
描述 |
|---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常 |
响应参数
参数 |
类型 |
描述 |
|---|---|---|
count |
Integer |
总数量。 |
limit |
Integer |
每页显示的条目数量。 默认值：10。 |
offset |
Integer |
页面起始页，从0开始。 |
data |
Array of QueryResourceResultDTO objects |
分页查询企业用户信息。 |
参数 |
类型 |
描述 |
|---|---|---|
count |
Integer |
资源数量。 |
editable |
Boolean |
标识资源是否可以编辑或删除，为false时,前台需要屏蔽操作按钮。 |
expireDate |
Long |
到期时间，utc时间戳。 |
id |
String |
唯一标识若携带则以携带为准，企业内保证唯一，否则后台自动生成UUID。 |
status |
Integer |
资源状态: |
type |
String |
资源类型。 |
typeDesc |
String |
资源标识对应的回显描述，比如资源类型为VMR ，则该参数为vmrPkgName。 |
typeId |
String |
资源标识，比如资源类型为VMR ，则该参数为vmrPkgId。 |
vmrMode |
Integer |
VMR模式。
|
orderId |
String |
资源对应的订单id。 |
请求消息示例
GET /v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0 Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
响应消息示例
HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 63facce44898efa03629afd189da7f0f
{
"count": 1,
"data": [
{
"count": 10,
"editable": true,
"expireDate": 2549030400000,
"id": "b974dfbe2daf456880afd10c80d12c9f",
"status": 0,
"type": "VMR",
"typeDesc": null,
"typeId": "ff808081699b56cb0169c411a0980152"
}
],
"limit": 5,
"offset": 0
}
错误码
当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。
CURL命令示例
curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/sp/corp/818803911/resource?offset=0&limit=5&searchKey=&startExpireDate=&endExpireDate=&type=&typeId=&status=0
