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

文档中心

立即注册

导航

云手机

【旧版】创建基础版屏幕布局 CreateDisplayLayoutMini

最近更新时间：2024.06.17 19:36:22首次发布时间：2023.09.04 14:55:45

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

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	string	是	公共参数，OpenAPI 接口名称	CreateDisplayLayoutMini
Version	Query	string	是	公共参数，OpenAPI 接口版本	2022-08-01

Body 参数

字段	类型	必填	说明
product_id	string	是	业务 ID，可在「云手机控制台-业务信息」中获取
display_layout_id	string	是	屏幕布局 ID，支持的最大长度为64字节，只支持大小写字母、数字、下划线（_）、中划线（-），在同一业务下唯一，一个业务下最多可创建100个屏幕布局配置信息
width	int	是	屏幕宽度，偶数，大于等于200，小于等于3840，默认：1080，单位：px
height	int	是	屏幕高度，偶数，大于等于200，小于等于3840，默认：1920，单位：px
density	int	否	屏幕像素密度，枚举值：160，240，320，默认：320，单位：dpi
fps	int	否	屏幕刷新率，枚举值：30，60，默认：60，单位：fps
extra	string	否	备注信息，长度不超过32字节

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
display_layout_id	string	屏幕布局 ID
width	int32	屏幕宽度
height	int32	屏幕高度
density	int32	像素密度
fps	int32	屏幕刷新率
extra	string	备注信息
create_at	int64	屏幕布局创建时间
is_system_config	bool	是否为系统屏幕布局配置

示例

请求示例

POST https://open.volcengineapi.com?Action=CreateDisplayLayoutMini
&Version=2022-08-01
&<通过header传入的公共请求参数>

{
    "product_id": "1641133322660xxxxxx",
    "display_layout_id": "e03-display",
    "width": 720,
    "height": 1080,
    "density": 160,
    "fps": 30,
    "extra": "API 创建"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "CreateDisplayLayoutMini",
        "Region": "cn-north-1",
        "RequestId": "20231102155404077F8872883BE51E6334",
        "Service": "ACEP",
        "Version": "2022-08-01"
    },
    "Result": {
        "display_layout_id": "e03-display",
        "width": 720,
        "height": 1080,
        "density": 160,
        "fps": 30,
        "extra": "API 创建",
        "create_at": 1698911644,
        "is_system_config": false
    }
}

错误码

错误码	说明	操作建议
8090002	业务下屏幕布局 ID 重复	修改指定的屏幕布局 ID 后重试
8090005	业务下创建的屏幕布局达到上限	一个业务下最多可创建100个屏幕布局配置信息，可尝试删除不必要的屏幕布局后重试
1000007	请求参数非法	参考接口说明，检查请求参数和传值