获取规则列表--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取规则列表

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

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

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageSettingRules`	接口名称。当前 API 的名称为 `GetImageSettingRules`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
AppId	String	是	`60**18`	应用 ID，您可以通过调用获取应用列表的方式获取所需的 AppId。
SettingId	String	是	`S9**od`	配置项 ID，您可以通过调用获取配置项列表的方式获取所需的配置项 ID。

返回参数

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

参数	类型	示例值	描述
AppId	String	`56**80`	应用 ID
SettingId	String	`Sd**a0`	配置项 ID
ParentId	String	`S6**52`	父节点 ID，若本身为父节点则该值为空。
Name	String	`magex_load_monitor_error`	规则所属配置项名称
Status	Integer	`0`	配置项状态。当前仅支持取值为 `0`，表示状态正常。
Type	String	`sample`	配置项类型，取值如下所示： `sample`：采样率类型 `integer`：整数类型 `float`：浮点数类型 `string`：字符串类型 `strarr`：字符串数组类型 `bool`：布尔值类型 `parent`：父节点类型 `object`：对象类型
ValueType	String	`-`	仅当`Type`取值为`object`时有值，表示 value 类型，key 类型统一为 String。
Comment	String	`客户端错误日志上报采样率`	规则所属配置项备注信息
DefaultValue	类型由 `Type` 决定	`1`	规则所属配置项默认值，仅当`Type`值不是`parent`时有意义。该值的类型有 `Type` 决定。
UpdateAt	String	`2022-06-20 17:06:14`	修改时间，修改时的服务器当地时间。
Category	String	`SR`	所属组件，取值如下所示 `HEIF`：表示 HEIF 编解码库 `SR`：表示客户端加载 SDK
Rules	Array of Rules	`-`	规则列表
ValueRange	Object of ValueRange	`-`	取值限制范围。仅当`Type` 取值为`integer/float/sample /object`时有效。`Type` 取值为 `object` 时，表示 `ValueType` 的取值范围。
AppRegion	String	`cn`	应用地域

Rules

参数	类型	示例值	描述
RuleId	String	`R3**4e`	规则 ID
Value	类型由对应配置项类型决定	`0`	对应配置值，该值的类型由对应配置项决定。
Cond	Object of Cond	`-`	规则条件
Name	String	`aaa`	规则名称
Priority	String	`1`	规则优先级，值越小优先级越高。
Content	String	`( (app_version == '12') )`	规则配置信息
Creator	String	`root/hs2021`	规则创建账号

ValueRange

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

Cond

参数类型示例值描述

参数	类型	示例值	描述
Type	String	`AND`	匹配条件，取值如下所示： `AND`：表示与 `OR`：表示或
Conds	Array of Conds	`[{"Key": "OS","Op": "==","Value": "iOS"}]`	条件列表

Type

String

AND

匹配条件，取值如下所示：

AND：表示与
OR：表示或

Conds Array of Conds [{"Key": "OS","Op": "==","Value": "iOS"}] 条件列表

Conds

参数	类型	示例值	描述
Key	String	`OS`	过滤维度。
Op	String	`==`	操作符。支持取值：==、!=、>、>=、<、<=、in
Value	类型由 `Op` 决定	`iOS`	配置值。`Op` 为 `in` 时，为 `Array of String` 类型，取值为其他时为 `String` 类型。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageSettingRules&Version=2023-05-01

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetImageSettingRules",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "AppId": "56**80",
        "SettingId": "S-b2a03c6a-238d-4db0-a742-02890ff269ca",
        "ParentId": "S-77c540e5-9c2b-486d-966d-67f786fde50a",
        "Status": 0,
        "Name": "bigimage_filesize_limit",
        "AppType": [
            "APP"
        ],
        "Type": "float",
        "Comment": "文件大小阈值，单位MB",
        "DefaultValue": 20,
        "ChildSettings": [],
        "Rules": [],
        "AppRegion": "cn",
        "Region": "",
        "Category": "",
        "Public": "",
        "ValueRange": {
            "Lower": null,
            "Upper": null
        },
        "UpdateAt": "2023-04-21 15:21:28"
    }
}

错误码

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

历史版本

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