创建配置项规则--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建配置项规则

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

本接口支持创建指定配置项的规则。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageSettingRule`	接口名称。当前 API 的名称为 `CreateImageSettingRule`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
SettingId	String	是	`Sd**bc`	配置项 ID，您可以通过调用获取配置项列表的方式获取所需的配置项 ID。
AppId	String	是	`56**80`	应用 ID，您可以通过调用获取应用列表的方式获取所需的 AppId。
Rule	Object of Rule	是	`-`	规则内容

Rule

参数	类型	是否必选	示例值	描述
Value	由对应配置项类型决定	是	`-`	配置值。
Cond	Object of Cond	否	`-`	匹配条件，仅当条件匹配后规则才会生效。
Name	String	是	`test`	规则名称，仅支持字母、数字、下划线，最多输入 32 个字符。

Cond

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Type	String	否	`AND`	匹配条件，取值如下所示： `AND`：表示与 `OR`：表示或
Conds	Array of Conds	否	`-`	规则条件

Type

String

否

AND

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

AND：表示与
OR：表示或

Conds Array of Conds 否 - 规则条件

Conds

参数	类型	是否必选	示例值	描述
Key	String	否	`OS`	过滤维度，取值请参考规则配置条件。
Op	String	否	`==`	操作符。支持取值：==、!=、>、>=、<、<=、in
Value	类型由 `Op` 决定	否	`iOS`	配置值。`Op`为`in`时，为 Array of String 类型，否则为 String 类型。

返回参数

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

参数	类型	示例值	描述
RuleId	String	`Re**21`	规则 ID。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageSettingRule&Version=2023-05-01
{
   "SettingId":"Sd**bc",
   "AppId":"56**80",
   "Rule":{
      "Value":1,
      "Cond":{
         "Type":"AND",
         "level":1,
         "Conds":[
            {
               "Type":"AND",
               "Conds":[
                  {
                     "Key":"OS",
                     "Op":"==",
                     "Value":"iOS"
                  }
               ]
            }
         ]
      },
      "Name":"test"
   }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateImageSettingRule",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "RuleId": "Re**21"
    }
}

错误码

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

历史版本

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