调用DescribeWhiteBoardRecordings查询白板录制详情。

使用说明

调用本接口前，您必须已经调用StartWhiteBoardRecording启动白板录制。

QPS限制

本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeWhiteBoardRecordings

系统规定参数。取值：DescribeWhiteBoardRecordings。

RegionId String 否 cn-shanghai

地域ID。
AppID String 是 7mbj****

白板应用唯一标识符。获取AppID，请参见CreateApp。

DocKey String 是 4EZlwmRW0gDG****

白板文档唯一标识符。获取DocKey，请参见CreateWhiteBoard。

PageNum Long 否 1

查询页码，参数为空默认查询第1页。
PageSize Long 否 10

每页显示个数，参数为空默认显示个数为10。

返回数据

名称 类型 示例值 描述
RequestId String FE22D613-D3C6-4A58-87CA-F21FC85AA08E

请求ID。
ResponseSuccess Boolean true

请求结果。
ErrorCode String null

错误码。
ErrorMsg String null

错误信息。
Result Object

返回的结果信息。
TotalNum Long 10

文档总个数。
TotalPage Long 1

文档总页数。
RecordingList Array of recordingList

录制信息列表。
AppID String 7mbj****

白板应用唯一标识符。
DocKey String 4EZlwmRW0gDG****

白板文档唯一标识符。
RecordId String 8a4556336bc6456b918e8eedbed6****

白板录制Session的唯一标识符。
UserId String 123456

创建白板录制的用户ID。
OperateList Array of String start@1631686505500

白板录制操作，格式：operate@UNIX时间戳。其中operate取值如下所示：

  • start：开始白板录制。
  • stop：停止白板录制。
  • pause：暂停白板录制。
  • resume：恢复白板录制。

示例

请求示例

http(s)://rtc-white-board.cn-shanghai.aliyuncs.com/?Action=DescribeWhiteBoardRecordings
&AppID=7mbj****
&DocKey=4EZlwmRW0gDG****
&PageNum=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeWhiteBoardRecordingsResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <ResponseSuccess>true</ResponseSuccess>
    <ErrorCode>null</ErrorCode>
    <ErrorMsg>null</ErrorMsg>
    <Result>
        <TotalNum>10</TotalNum>
        <TotalPage>1</TotalPage>
        <RecordingList>
            <AppID>7mbj****</AppID>
            <DocKey>4EZlwmRW0gDG****</DocKey>
            <RecordId>8a4556336bc6456b918e8eedbed6****</RecordId>
            <UserId>123456</UserId>
            <OperateList>start@1631686505500</OperateList>
        </RecordingList>
    </Result>
</DescribeWhiteBoardRecordingsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
  "ResponseSuccess" : true,
  "ErrorCode" : "null",
  "ErrorMsg" : "null",
  "Result" : {
    "TotalNum" : 10,
    "TotalPage" : 1,
    "RecordingList" : [ {
      "AppID" : "7mbj****",
      "DocKey" : "4EZlwmRW0gDG****",
      "RecordId" : "8a4556336bc6456b918e8eedbed6****",
      "UserId" : "123456",
      "OperateList" : [ "start@1631686505500" ]
    } ]
  }
}