查询应用列表
功能介绍
调用此接口查询应用列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/apps
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
state |
否 |
String |
应用的状态：
|
offset |
否 |
Integer |
查询结果起始编号，此处代表分页的页码，默认为0。 |
limit |
否 |
Integer |
查询结果集数量，此处代表每一页的条数，最小为1，最大为100。默认为100。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
内容类型。 |
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-Id |
String |
此字段携带请求ID号，以便任务跟踪。 |
参数 |
参数类型 |
描述 |
|---|---|---|
count |
Integer |
app的总数 |
apps |
Array of App objects |
app的列表 |
参数 |
参数类型 |
描述 |
|---|---|---|
app_name |
String |
app名称 |
app_id |
String |
应用id |
state |
AppState object |
app状态 |
scope |
String |
RTC覆盖范围。 取值如下：
|
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 |
自动录制配置 |
参数 |
参数类型 |
描述 |
|---|---|---|
state |
String |
状态
|
update_time |
String |
app鉴权的更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC |
参数 |
参数类型 |
描述 |
|---|---|---|
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 |
参数 |
参数类型 |
描述 |
|---|---|---|
push_callback |
AppCallbackUrl object |
转推回调 |
record_callback |
AppCallbackUrl object |
录制回调 |
参数 |
参数类型 |
描述 |
|---|---|---|
url |
String |
回调通知url地址，url必须以http://或https://开头，需要支持POST调用。 |
auth_key |
String |
回调秘钥，主要用于鉴权。如果不设置或者为空，则回调不会增加鉴权头域字段。 |
notify_event_subscription |
Array of strings |
订阅云端录制通知消息。 取值如下：
|
update_time |
String |
更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC。 |
参数 |
参数类型 |
描述 |
|---|---|---|
mode |
String |
录制模式。
|
record_rule_id |
String |
录制规则id。 |
update_time |
String |
更新时间，形如“2006-01-02T15:04:05.075Z”，时区为：UTC。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-Id |
String |
此字段携带请求ID号，以便任务跟踪。 |
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
X-request-Id |
String |
此字段携带请求ID号，以便任务跟踪。 |
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
查询当前租户下的全量应用
GET https://rtc-api.myhuaweicloud.com/v2/apps
响应示例
状态码： 200
查询应用列表
{
"count" : 1,
"apps" : [ {
"app_name" : "example",
"app_id" : "123456789abcdefghijklmno",
"state" : {
"state" : "ACTIVATION",
"update_time" : "2020-07-26T07:03:05.075Z"
},
"scope" : "DOMESTIC",
"tenant_name" : "hwstaff_pub_videortc",
"domain" : "123456789abcdefghijklmno.rtc.huawei.com",
"create_time" : "2020-07-26T07:03:05.075Z",
"authentication" : {
"enable" : true,
"expire" : 300,
"app_key" : "12345ABCDEF12345",
"update_time" : "2020-07-26T07:03:05.075Z"
},
"callbacks" : {
"push_callback" : {
"url" : "",
"auth_key" : "",
"update_time" : ""
},
"record_callback" : {
"url" : "http://mydomain.com",
"auth_key" : "78912374ae8cdb38",
"update_time" : "2020-07-26T07:53:05.075Z"
}
},
"auto_record_mode" : {
"mode" : "AUTO_RECORD_OFF",
"update_time" : "2020-07-26T07:53:05.075Z"
}
} ]
}
状态码： 400
语义有误，当前请求无法被服务器理解，或参数有误
{
"error_code" : "RTC.00001003",
"error_msg" : "InvalidParameterValue"
}
状态码： 500
查询出错，服务器端错误
{
"error_code" : "RTC.00002xxx",
"error_msg" : "InternalError"
}
状态码
状态码 |
描述 |
|---|---|
200 |
查询应用列表 |
400 |
语义有误，当前请求无法被服务器理解，或参数有误 |
500 |
查询出错，服务器端错误 |
错误码
请参见错误码。
