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

文档中心

立即注册

导航

veImageX

创建配置项规则

最近更新时间：2024.08.20 11:34:24首次发布时间：2021.02.23 10:42:28

本接口支持通过指定配置项下规则的详情来创建规则后获得规则 ID。

说明

该接口属于历史版本 API，建议您使用新版 CreateImageSettingRule 接口。

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数	类型	是否必选	描述
AppId	String	是	应用 ID。说明您可以通过调用获取应用列表的方式获取所需的 AppId。
SettingId	String	是	配置项 ID。仅当配置项类型非`parent`时可创建规则说明您可以通过调用获取配置项列表的方式获取所需的配置项 ID。
Rule	JSON Object	是	规则信息。

Rule

参数	类型	是否必填	描述
Name	String	是	规则名称。说明仅支持字母、数字、下划线，最多输入 32 个字符。
Cond	RuleCond	否	规则条件。
Value	类型由对应配置项类型决定	是	配置值。

RuleCond

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

说明

多个条件时传值 Type 和 Conds。
单个条件时传值 Key、Op 和 Value。

返回参数

参数	类型	描述
RuleId	String	规则 ID。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageSettingRule&Version=2018-08-01
{
   "SettingId":"S-45e1e640-5281-44b2-9256-86615277d30e",
   "AppId":"394325",
   "Rule":{
      "Value":0,
      "Cond":{
         "Type":"AND",
         "level":1,
         "Conds":[
            {
               "Type":"AND",
               "Conds":[
                  {
                     "Key":"AppVer",
                     "Op":"==",
                     "Value":"other"
                  }
               ]
            }
         ]
      },
      "Name":"aaa"
   }
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "CreateImageSettingRule",
        "Version": "2018-08-01",
	    	"Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
         "RuleId": "R-d7b5625e-bdf1-40be-916d-c3fb3406b405"
    }
}

异常返回示例

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

错误码

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