文档首页/ 华为云会议 Meeting/ 服务端API参考/ 企业管理/ 接口参考/ 企业管理员分页查询企业资源订单列表
更新时间:2024-04-29 GMT+08:00

企业管理员分页查询企业资源订单列表

描述

企业管理员根据条件查询企业资源订单列表。

调试

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

接口原型

表1 接口原型

请求方法

GET

请求地址

/v1/usg/dcs/corp/resource-list

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

X-Access-Token

String

Header

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

X-Request-Id

String

Header

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

Accept-Language

String

Header

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

offset

Integer

Query

查询偏移量,若超过最大数量,则返回最后一页。

默认值:0

limit

Integer

Query

查询数量。

默认值:10

searchKey

String

Query

搜索条件,支持resourceId模糊查询。

startExpireDate

Integer

Query

查询过期时间在该时间戳之后的资源项。

endExpireDate

Integer

Query

查询过期时间在该时间戳之前的资源项。

type

String

Query

资源类型。

  • VMR:云会议室
  • CONF_CALL:会议并发数
  • HARD_1080P:1080P硬终端
  • HARD_720P:720P硬终端
  • SOFT:软终端用户数
  • ROOM:大屏软终端
  • LIVE:直播推流
  • RECORD:录播空间
  • HARD_THIRD_PARTY :第三方硬终端账号
  • HUAWEI_VISION:智慧屏
    说明:

    查询网络研讨会资源时type字段为VMR。

vmrMode

Integer

Query

VMR模式,type为VMR时传递该参数。

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

typeId

String

Query

资源类型Id,若想搜索5方VMR时,需携带5方vmrpkg对应的id。

orderId

String

Query

订单Id。

status

Integer

Query

订单状态。

  • 0:正常
  • 1:到期
  • 2:停用

状态码

表3 状态码说明

HTTP状态码

描述

200

操作成功。

400

参数异常。

401

未鉴权或鉴权失败。

403

权限受限。

500

服务端异常

响应参数

表4 响应参数

参数

类型

描述

count

Integer

总数量。

limit

Integer

每页显示的条目数量。

默认值:10。

offset

Integer

页面起始页,从0开始。

data

Array of QueryResourceResultDTO objects

分页查询企业的资源项。

请求消息示例

GET /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10
Connection: keep-alive
X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) 

响应消息示例

HTTP/1.1 200 
Date: Tue, 17 Dec 2019 09:32:47 GMT
Content-Type: application/json;charset=UTF-8
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 539e8b710378987ffc5eb844b5e5c290

{
    "offset": 0,
    "limit": 10,
    "count": 1,
    "data": [
        {
            "id": "1747cfe902c34631999975417bf6bc1a",
            "type": "VMR",
            "typeId": 2001000,
            "typeDesc": "网络研讨会_1000观众",
            "vmrMode": 2,
            "count": 10,
            "expireDate": 1640966400000,
            "orderId": "95152407f7f147149e7f3e8e5e4a84bc",
            "status": 0,
            "editable": true
        }
    ]
}

错误码

当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心

CURL命令示例

curl -k -i -X GET -H 'X-Access-Token: stbdOWTjFFPAoDfJaWFGWnOTtepUlEsfhQSC' /v1/usg/dcs/corp/resource-list?searchKey=&startExpireDate=&endExpireDate=&type=VMR&typeId=&orderId=&status=&vmrMode=2&offset=0&limit=10