查询基础版屏幕布局列表 ListDisplayLayoutMini--云手机-火山引擎

文档中心

立即注册

导航

云手机

查询基础版屏幕布局列表 ListDisplayLayoutMini

最近更新时间：2024.10.29 19:17:19首次发布时间：2024.03.04 19:40:02

此接口用于查询当前业务支持的基础版屏幕布局配置列表。

请求说明

请求方式：GET
请求地址：https://open.volcengineapi.com?Action=ListDisplayLayoutMini&Version=2023-10-30

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListDisplayLayoutMini`	接口名称。当前 API 的名称为 `ListDisplayLayoutMini`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。
ProductId	String	是	`1591495366954xxxxxx`	业务 ID，可在云手机控制台 > 业务信息中获取。
DisplayLayoutId	String	否	`163571455047xxxx`	筛选条件，屏幕布局 ID。
Offset	Long	否	`0`	查询结果的起始位置，用于指定从哪一条记录开始返回数据。例如，若 `Offset` 为 10，则表示从第 11 条记录开始。默认值为 0。说明可与 `Count` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。
Count	Long	否	`10`	单次查询返回的最大记录数，用于控制每次查询返回的数据量。例如，若 `Count` 为 100，则表示在查询数据时，系统将每次返回 100 条记录。说明可与 `Offset` 配合使用。假设当前数据集的记录总数为 200 条，如需查询第 101～150 条数据，需设置 `Offset` 为 100，`Count` 为 50。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Row	Array of DisplayLayoutMini	`-`	查询到的屏幕布局信息列表。
Total	Long	`1`	查询总数。

DisplayLayoutMini

参数	类型	示例值	描述
Fps	Integer	`60`	屏幕刷新率。
Extra	String	`test`	备注信息。
Width	Integer	`1920`	屏幕宽度。
Height	Integer	`720`	屏幕高度。
Density	Integer	`320`	像素密度。
CreateAt	Long	`1693377128`	屏幕布局创建时间。
IsSystemConfig	Boolean	`true`	是否为系统屏幕布局配置： `true`：是； `false`：否。
DisplayLayoutId	String	`single-display-landscape`	屏幕布局 ID。

请求示例

GET https://open.volcengineapi.com?Action=ListDisplayLayoutMini&Version=2023-10-30&ProductId=1591495366954xxxxxx&DisplayLayoutId=single-display-portrait&Offset=0&Count=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110***0232280022D31",
        "Action": "ListDisplayLayoutMini",
        "Version": "2023-10-30",
        "Service": "ACEP",
        "Region": "cn-north-1"
    },
    "Result": {
        "Row": [
            {
                "Extra": "test",
                "Height": 1920,
                "Density": 320,
                "Width": 1080,
                "Fps": 60,
                "DisplayLayoutId": "single-display-portrait",
                "IsSystemConfig": true,
                "CreateAt": 7961693377128
            }
        ],
        "Total": 1
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。