DescribeAppLayouts - 查询自定义布局列表_音视频通信(RTC)-阿里云帮助中心

查询app自定义布局

接口说明

QPS 限制

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
rtc:DescribeAppLayouts	none	App acs:rtc:*:{#accountId}:app/{#AppId}	无	无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。通过控制台创建和查询，仅支持传单个 ID。	ac7N****
PageNum	integer	否	页码，默认 1。	1
PageSize	integer	否	每页数量，默认 10。	10
Condition	object	否	查询条件。
LayoutId	string	否	布局 ID。	167466539798442****
Name	string	否	布局名称。	测试

返回参数

名称	类型	描述	示例值
	object
TotalPage	long	总页数。	1
RequestId	string	本次请求的 ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8
TotalNum	long	总数。	10
Layouts	array<object>	布局列表。
Layout	object
LayoutId	string	布局 ID。	167466539798442****
Name	string	布局名称。	测试
Panes	array<object>	窗格列表。
Panes	object
Width	float	窗格宽，归一化百分比。Width 取值范围：0.0<Width≤1.0。	0.25
Height	float	窗格高，归一化百分比。Height 取值范围：0.0<Height≤1.0。	0.25
Y	float	坐标 Y，归一化百分比。坐标 Y 取值范围：0.0≤Y≤1.0。	0.25
PaneId	integer	窗格 ID	0
ZOrder	integer	叠放顺序，0 为最底层，1 层在 0 层之上，以此类推。	0
X	float	坐标 X，归一化百分比。坐标 X 取值范围：0.0≤X≤1.0。	0.25

示例

正常返回示例

JSON格式

{
  "TotalPage": 1,
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "TotalNum": 10,
  "Layouts": [
    {
      "LayoutId": "167466539798442****",
      "Name": "测试",
      "Panes": [
        {
          "Width": 0.25,
          "Height": 0.25,
          "Y": 0.25,
          "PaneId": 0,
          "ZOrder": 0,
          "X": 0.25
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ParameterError	%s.	参数错误
404	NotFound	%s.	请求的资源不存在

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