DescribeLiveMessageApp - 查询直播互动应用信息_视频直播(LIVE)-阿里云帮助中心

调用DescribeLiveMessageApp查询互动消息应用信息。

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
live:DescribeLiveMessageApp	get	*Rtc `acs:live::{#accountId}:rtc/{#AppId}`	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	待查询的互动消息应用 ID。	demo
DataCenter	string	否	数据中心，需要与 CreateLiveMessageApp 中的数据中心一致，当前支持上海（取值为 cn-shanghai)、新加坡（取值为 ap-southeast-1）。	cn-shanghai

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	9FB68B5B-ED07-18F0-A3CF-083F4E74****
AppId	string	所查询的互动消息应用 ID。	demo
AppName	string	App 名称。	testApp
AppKey	string	互动消息应用的 AppKey，在进行与该互动消息应用 ID 相关的各种鉴权操作时需要该信息。	**********************************
AppSign	string	互动消息应用签名，互动消息服务 SDK 需要该信息。	**************************************************************************
AuditType	integer	安全审核方式。取值： 0：不开启安全审核。 1：内置安全审核。 2：自定义安全审核。	2
AuditUrl	string	AuditType 取值为 2 时提供的安全审核地址。	http://example.aliyundoc.com/exampleaudit
EventCallbackUrl	string	用户登录、登出、加入、离开群组等事件的回调地址，若为空则不开启事件回调。	http://example.aliyundoc.com/examplecallback
Disable	boolean	是否禁用互动消息应用。	false
CreateTime	long	创建时间，用 UNIX 时间戳表示，单位：秒。	1698305471
ModifyTime	long	修改时间，用 UNIX 时间戳表示，单位：秒。	1698305471
MsgLifeCycle	integer	App 内群组消息的存储时效档位，取值： 0：默认值，存储 30 天。 1：存储 90 天。 2：存储 180 天。	1
DataCenter	string	数据中心。	cn-shanghai

示例

正常返回示例

JSON格式

{
  "RequestId": "9FB68B5B-ED07-18F0-A3CF-083F4E74****",
  "AppId": "demo",
  "AppName": "testApp",
  "AppKey": "**********************************",
  "AppSign": "**************************************************************************",
  "AuditType": 2,
  "AuditUrl": "http://example.aliyundoc.com/exampleaudit",
  "EventCallbackUrl": "http://example.aliyundoc.com/examplecallback",
  "Disable": false,
  "CreateTime": 1698305471,
  "ModifyTime": 1698305471,
  "MsgLifeCycle": 1,
  "DataCenter": "cn-shanghai"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-08-01	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-02-22	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-01-09	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情