创建基础版屏幕布局 CreateDisplayLayoutMini--云手机-火山引擎

文档中心

立即注册

导航

云手机

创建基础版屏幕布局 CreateDisplayLayoutMini

最近更新时间：2024.07.29 15:00:20首次发布时间：2024.05.08 16:08:10

创建基础版屏幕布局，适用于单屏云手机实例。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateDisplayLayoutMini`	接口名称。当前 API 的名称为 `CreateDisplayLayoutMini`。
Version	String	是	`2023-10-30`	接口版本。当前 API 的版本为 `2023-10-30`。

Body

参数	类型	是否必选	示例值	描述
ProductId	String	是	`1641133322660xxxxxx`	业务 ID，可在「云手机控制台-业务信息」中获取。
DisplayLayoutId	String	是	`e03-display`	屏幕布局 ID，支持的最大长度为 64 字节，只支持大小写字母、数字、下划线（_）、中划线（-），在同一业务下唯一，一个业务下最多可创建 100 个屏幕布局配置信息。
Width	Integer	是	`720`	屏幕宽度，取值范围在 [200, 2400] 区间的偶数，默认值为 1080，单位：px。
Height	Integer	是	`1280`	屏幕高度，取值范围在 [200, 2400] 区间的偶数，默认值为 1920，单位：px。
Density	Integer	否	`160`	屏幕像素密度，单位：dpi。包含以下值： 160 240 320（默认值）
Fps	Integer	否	`30`	屏幕刷新率，单位：fps。包含以下值： 30 60（默认值）
Extra	String	否	`API 创建`	备注信息，长度不超过 32 字节。

返回参数

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

参数	类型	示例值	描述
DisplayLayoutId	String	`e03-display`	屏幕布局 ID。
Width	Integer	`720`	屏幕宽度。
Height	Integer	`1080`	屏幕高度。
Density	Integer	`160`	屏幕像素密度。
Fps	Integer	`30`	屏幕刷新率。
Extra	String	`API 创建`	备注信息。
CreateAt	Long	`1698911644`	屏幕布局创建时间。
IsSystemConfig	Boolean	`false`	是否为系统屏幕布局配置。

请求示例

POST https://open.volcengineapi.com?Action=CreateDisplayLayoutMini&Version=2023-10-30
{
    "ProductId": "1641133322660xxxxxx",
    "DisplayLayoutId": "e03-display",
    "Width": 720,
    "Height": 1280,
    "Density": 160,
    "Fps": 30,
    "Extra": "API 创建"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateDisplayLayoutMini",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2023-10-30",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "DisplayLayoutId": "e03-display",
        "Width": 720,
        "Height": 1080,
        "Density": 160,
        "Fps": 30,
        "Extra": "API 创建",
        "CreateAt": 1698911644,
        "IsSystemConfig": false
    }
}

错误码

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