文档首页> 会议> 服务端API参考> 企业资源管理> SP管理员分页查询企业资源
更新时间:2022-05-05 GMT+08:00
分享

SP管理员分页查询企业资源

描述

SP根据条件查询企业的资源项。

调试

您可以在API Explorer中调试该接口。

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/sp/corp/{corp_id}/resource

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

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

资源状态:

  • 0:正常
  • 1:到期,仅查询时返回
  • 2:停用

X-Access-Token

String

Header

授权令牌。获取“执行App ID鉴权”响应的accessToken。

X-Request-Id

String

Header

请求requestId,用来标识一路请求,用于问题跟踪定位,建议使用uuId,若不携带,则后台自动生成。

Accept-Language

String

Header

语言参数,默认为中文zh-CN,英文为en-US。

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应码

参数

类型

描述

count

Integer

总数量。

limit

Integer

每页显示的条目数量。

默认值:10。

offset

Integer

页面起始页,从0开始。

data

Array of QueryResourceResultDTO objects

分页查询企业用户信息。

表5 QueryResourceResultDTO 数据结构

参数

类型

描述

count

Integer

资源数量。

editable

Boolean

标识资源是否可以编辑或删除,为false时,前台需要屏蔽操作按钮。

expireDate

Long

到期时间,utc时间戳。

id

String

唯一标识若携带则以携带为准,企业内保证唯一,否则后台自动生成UUID。

status

Integer

资源状态:

  • 0:正常

  • 1:到期

  • 2:停用

type

String

资源类型,前台通过查询接口返回该sp支持售卖的资源在界面上做相应屏蔽,当前为枚举类型。

  • VMR - 云会议室

  • CONF_CALL - 会议并发数

  • HARD_1080P - 1080P硬终端

  • HARD_720P - 720P硬终端

  • SOFT - 软终端用户数

  • ROOM - 大屏软终端

  • LIVE - 直播推流

  • RECORD - 录播空间

  • HARD_THIRD_PARTY - 第三方硬终端账号

  • HUAWEI_VISION -智慧屏

  • IDEA_HUB - ideahub

typeDesc

String

资源标识对应的回显描述,比如资源类型为vmrpkg,则该参数为vmrPkgName。

typeId

String

资源标识,比如资源类型为vmrpkg,则该参数为vmrPkgId。

vmrMode

Integer

VMR模式。

  • 0:个人会议ID
  • 1:云会议室
  • 2:网络研讨会

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
分享:

    相关文档

    相关产品

close