文档中心

获取规则列表

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

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

本接口支持指定 APPID 以及配置项 ID，来获取配置项下的规则列表信息。

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
AppId	String	是	应用 ID。说明您可以通过调用获取应用列表的方式获取所需的 AppId。
SettingId	String	是	配置项 ID。说明您可以通过调用获取配置项列表的方式获取所需的配置项 ID。

返回参数

参数	类型	描述
Name	String	规则所属配置项名称。
Type	String	规则所属配置项类型。取值为`sample`表示采样率类型；取值为`integer`表示整数类型；取值为`float`表示浮点数类型；取值为`string`表示字符串类型；取值为`strarr`表示字符串数组类型；取值为`bool`表示布尔值类型；取值为`parent`表示父节点类型；取值为`object`表示对象类型。
ValueType	String	仅当`Type`取值为`object`时有值，表示 value 类型，key 类型统一为 String。
Comment	String	规则所属配置项备注信息。
DefaultValue	类型由`Type`决定	规则所属配置项默认值，仅当`Type`值不是`parent`时有意义。
ValueRange	Object	取值限制范围。仅当`Type` 取值为`integer/float/sample /object`时有效。说明 `Type`取值为`object`时，表示`ValueType`的取值范围。
Rules	Array of Rule	规则列表。
AppId	String	应用 ID。
AppRegion	String	应用地域。
Category	String	所属组件。返回值为`HEIF`时，表示 HEIF 解码库；返回值为`SR`时，表示图像超分辨率（客户端）。
ParentId	String	父节点 ID，若本身为父节点，则该值为空。
SettingId	String	配置项 ID。
Status	Intrger	配置项状态，仅支持取值为`0`，表示状态正常。
UpdateAt	String	修改时间，修改时的服务器当地时间。

ValueRange

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

Rule

参数	类型	描述
RuleId	String	规则 ID。
Priority	Integer	规则优先级，值越小优先级越高。
Name	String	规则名称。
Content	String	规则配置信息。
Cond	RuleCond	规则条件。
Value	类型由对应配置项类型决定	对应配置值。
Creator	String	规则创建人。

RuleCond

参数	类型	描述
Type	String	匹配条件。取值`AND`表示与，`OR`表示或。
Conds	Array of RuleCond	条件列表。
Key	String	过滤维度。
Op	String	操作符。支持取值：==、!=、>、>=、<、<=、in
Value	类型由`Op`决定	配置值。`Op`为`in`时为 Array of String 类型，取值为其他时为 String 类型。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageSettingRules&Version=2018-08-01&AppId=179132&SettingId=S-ccedaa3b-a914-4275-90ed-514300b40d*

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"202208161724370102091570361F9F96F9",
      "Action":"GetImageSettingRules",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "AppId":"394325",
      "SettingId":"S-ccedaa3b-a914-4275-90ed-514300b40d40",
      "ParentId":"S-6c040a73-7f60-44f7-b3d0-d13942dcc752",
      "Status":0,
      "Name":"imagex_load_monitor",
      "Type":"sample",
      "Comment":"客户端日志上报采样率",
      "DefaultValue":0.5,
      "ChildSettings":[
         
      ],
      "Rules":[
         
      ],
      "AppRegion":"cn",
      "Region":"",
      "Category":"",
      "Public":"",
      "UpdateAt":"2022-06-20 17:06:14"
   }
}

异常返回示例

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

错误码

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

请求说明

请求参数

Query

返回参数

ValueRange

Rule

RuleCond

示例

请求示例

正常返回示例

异常返回示例

错误码