实时音视频 SPARKRTC-查询单个应用:响应参数

时间:2024-10-18 15:28:09

响应参数

状态码: 200

表3 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表4 响应Body参数

参数

参数类型

描述

app_name

String

app名称

app_id

String

应用id

state

AppState object

app状态

scope

String

RTC覆盖范围。

取值如下:

  • DOMESTIC:国内范围。

  • OVERSEA:海外范围。

  • GLOBAL:全球范围。

tenant_name

String

账号名

domain

String

域名 ,App对应域名

create_time

String

创建时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

authentication

AppAuth object

鉴权配置

callbacks

AppCallbacks object

回调配置

auto_record_mode

AppAutoRecordMode object

自动录制配置

表5 AppState

参数

参数类型

描述

state

String

状态

  • ACTIVATION:开启

  • DEACTIVATION:停用

  • ARREARS:欠费

  • DELETED:已删除

update_time

String

app鉴权的更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

表6 AppAuth

参数

参数类型

描述

enable

Boolean

开启或关闭URL鉴权

expire

Integer

接入RTC建链认证时的signature的有效期。单位:秒。默认300秒。signature由app_key生成

app_key

String

app鉴权秘钥

update_time

String

app鉴权的更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC

表7 AppCallbacks

参数

参数类型

描述

push_callback

AppCallbackUrl object

转推回调

record_callback

AppCallbackUrl object

录制回调

表8 AppCallbackUrl

参数

参数类型

描述

url

String

回调通知url地址,url必须以http://或https://开头,需要支持POST调用。

auth_key

String

回调秘钥,主要用于鉴权。如果不设置或者为空,则回调不会增加鉴权头域字段。

notify_event_subscription

Array of strings

订阅云端录制通知消息。

取值如下:

  • RECORD_NEW_FILE_START:开始创建新的录制文件。

  • RECORD_FILE_COMPLETE:录制文件生成完成。

update_time

String

更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC。

表9 AppAutoRecordMode

参数

参数类型

描述

mode

String

录制模式。

  • AUTO_RECORD_OFF:关闭自动录制。

  • AUTO_INDIVIDUAL_RECORD:开启单流自动录制,此时record_rule_id必须非空。

record_rule_id

String

录制规则id。

update_time

String

更新时间,形如“2006-01-02T15:04:05.075Z”,时区为:UTC。

状态码: 400

表10 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表12 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表14 响应Header参数

参数

参数类型

描述

X-request-Id

String

此字段携带请求ID号,以便任务跟踪。

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

support.huaweicloud.com/api-rtc/ShowApp.html