获取配置项列表--veImageX-火山引擎

文档中心

立即注册

导航

获取配置项列表

最近更新时间：2024.08.20 11:14:32首次发布时间：2024.08.20 11:14:32

本接口支持通过指定应用 ID 以及所属组件，来获取当前组件配置项列表信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
数据延迟：约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageSettings&Version=2023-05-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageSettings`	接口名称。当前 API 的名称为 `GetImageSettings`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
AppId	String	是	`56**80`	应用 ID，您可以通过调用获取应用列表的方式获取所需的 AppId。
Category	String	否	`SR`	所属组件，缺省情况下表示获取基础配置列表。取值为`HEIF`时，表示获取 HEIF 解码库下配置列表；取值为`SR`时，表示获取客户端下配置列表。

返回参数

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

参数	类型	示例值	描述
Settings	Array of Settings	`-`	配置项列表。

Settings

参数	类型	示例值	描述
SettingId	String	`Sb**6e`	配置项 ID
ParentId	String	`S2**0a`	父节点 ID，若本身为父节点则该值为空。
Name	String	`heif_decode`	配置项名称
Status	Integer	`0`	配置项状态。当前仅支持取值为 `0`，表示状态正常。
Type	String	`integer`	配置项类型，取值如下所示： `sample`：采样率类型 `integer`：整数类型 `float`：浮点数类型 `string`：字符串类型 `strarr`：字符串数组类型 `bool`：布尔值类型 `parent`：父节点类型 `object`：对象类型
ValueType	String	`float`	仅当 `Type` 取值为 `object` 时有值，表示 value 类型，key 类型统一为 String。
Comment	String	`只有授权码生效期内才可支持云控开启/关闭heif解码能力。1：开启，0：关闭`	备注信息
DefaultValue	类型由 `Type` 决定	`1`	`Type` 的默认值，仅当`Type`值不是`parent`时有意义。该值的类型实际由 `Type` 决定，例如当`Type`为整数类型时，默认值为 0。
ChildSettings	Array of Settings	`-`	配置子节点列表，仅当`Type`取值为`parent`时有意义。其参数结构与 Settings 相同。
ValueRange	Object of ValueRange	`-`	取值限制范围。仅当`Type` 取值为`integer/float/sample/object`时有效。`Type`取值为`object`时，表示`ValueType`的取值范围。
UpdateAt	String	`2023-01-09 20:06:05`	配置修改时间，修改时的服务器当地时间。
Category	String	`HEIF`	所属组件，即请求时的组件名称。

ValueRange

参数	类型	示例值	描述
Lower	类型由 `Type` 决定	`0`	取值下限
Upper	类型由 `Type` 决定	`1`	取值上限

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageSettings&Version=2023-05-01&AppId=56**80&Category=HEIF

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageSettings",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Settings": [
            {
                "SettingId": "Sd***bc",
                "ParentId": "",
                "Status": 0,
                "Name": "heif_encode",
                "AppType": [
                    "APP"
                ],
                "Type": "integer",
                "Comment": "只有授权码生效期内才可支持云控开启/关闭heif编码能力。1：开启，0：关闭",
                "DefaultValue": 1,
                "ChildSettings": [],
                "Rules": [],
                "Region": "",
                "Category": "HEIF",
                "Public": "",
                "ValueRange": {
                    "Lower": null,
                    "Upper": 1
                },
                "UpdateAt": "2024-01-03 11:29:25"
            },
            {
                "SettingId": "Sb**6e",
                "ParentId": "",
                "Status": 0,
                "Name": "heif_decode",
                "AppType": [
                    "APP"
                ],
                "Type": "integer",
                "Comment": "只有授权码生效期内才可支持云控开启/关闭heif解码能力。1：开启，0：关闭",
                "DefaultValue": 1,
                "ChildSettings": [],
                "Rules": [],
                "Region": "",
                "Category": "HEIF",
                "Public": "",
                "ValueRange": {
                    "Lower": 0,
                    "Upper": 1
                },
                "UpdateAt": "2023-01-09 20:06:05"
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

历史版本

2018-08-01 版本 GetImageSettings 接口文档现已停止维护，建议您参考本文档使用最新版本。