文档中心

获取配置项列表

最近更新时间：2024.01.31 15:19:58

首次发布时间：2021.02.23 10:42:28

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

说明

如果不指定组件，则获取基础配置项列表信息。

请求说明

接口名称：GetImageSettings
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetImageSettings&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
AppId	String	是	应用 ID。说明您可以通过调用获取应用列表的方式获取所需的 Appid。
Category	String	否	所属组件，缺省情况下表示获取基础配置列表。取值为`HEIF`时，表示获取 HEIF 解码库下配置列表；取值为`SR`时，表示获取图像超分辨率（客户端）下配置列表。

返回参数

参数	类型	描述
Settings	Array of Settings	配置项列表。

Settings

参数	类型	描述
SettingId	String	配置项 ID。
ParentId	String	父节点 ID，若本身为父节点则该值为空。
Name	String	配置项名称。
Status	Integer	配置项状态。当前仅支持取值为`0`，表示状态正常。
Type	String	配置项类型。取值为`sample`表示采样率类型；取值为`integer`表示整数类型；取值为`float`表示浮点数类型；取值为`string`表示字符串类型；取值为`strarr`表示字符串数组类型；取值为`bool`表示布尔值类型；取值为`parent`表示父节点类型；取值为`object`表示对象类型。
ValueType	String	仅当`Type`取值为`object`时有值，表示 value 类型，key 类型统一为 String。
Comment	String	备注信息。
DefaultValue	类型由`Type`决定	`Type`的默认值，仅当`Type`值不是`parent`时有意义。说明例如当`Type`为整数类型时，默认值为 0。
ChildSettings	Array of Settings	配置子节点列表，仅当`Type`取值为`parent`时有意义。其参数结构与 Settings 相同。
Category	String	所属组件，即请求时的组件名称。
ValueRange	Object	取值限制范围。仅当`Type` 取值为`integer/float/sample/object`时有效。说明 `Type`取值为`object`时，表示`ValueType`的取值范围。
UpdateAt	String	配置修改时间，修改时的服务器当时时间。

ValueRange

参数	类型	描述
Lower	类型由`Type`决定	取值下限。
Upper	类型由`Type`决定	取值上限。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageSettings&Version=2018-08-01&AppId=179132&Category=HEIF

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2020120614035401001202009815090730",
        "Action": "GetImageSettings",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
     "Result":{
      "Settings":[
         {
            "SettingId":"S-46f1e5af-5ffb-4c38-a873-307c7bf18ba2",
            "ParentId":"",
            "Status":0,
            "Name":"enable_heif",
            "Type":"integer",
            "Comment":"支持云控开启/关闭heif解码能力。1：开启，0：关闭",
            "DefaultValue":1,
            "ChildSettings":[
               
            ],
            "Rules":[
               
            ],
            "Region":"",
            "Category":"HEIF",
            "Public":"",
            "ValueRange":{
               "Lower":null,
               "Upper":null
            },
            "UpdateAt":"2022-06-20 17:06:14"
         }
      ]
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
				"Action": "GetImageSettings",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "",
            "Message": ""
        }
    }
}

错误码

访问公共错误码和客户端配置下发相关错误码获取详细信息。