更新配置项规则--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新配置项规则

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

本接口支持通过指定应用 ID、待更新规则 ID 以及更新后规则信息，来更新配置项上规则。

说明

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

请求说明

接口名称：UpdateImageSettingRule
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=UpdateImageSettingRule&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。说明您可以通过调用获取配置项列表的方式获取所需的配置项 ID。
RuleId	String	是	待更新的规则 ID。说明您可以通过调用创建配置项规则的方式获取所需的规则 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。

返回参数

无

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageSettingRule&Version=2018-08-01
{
   "SettingId":"S-45e1e640-5281-44b2-9256-86615277d30e",
   "AppId":"394325",
   "Rule":{
      "Value":1,
      "Cond":{
         "Type":"AND",
         "Conds":[
            {
               "Type":"AND",
               "Conds":[
                  {
                     "Type":"",
                     "Conds":[
                        
                     ],
                     "Key":"AppVer",
                     "Op":"==",
                     "Value":"other"
                  }
               ],
               "Key":"",
               "Op":"",
               "Value":null
            }
         ],
         "Key":"",
         "Op":"",
         "Value":null,
         "level":1
      },
      "Name":"aaa"
   },
   "RuleId":"R-32226e5e-602d-4a09-8a54-779749656a20"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageSettingRule",
        "Version": "2018-08-01",
		    "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
         
    }
}

异常返回示例

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

错误码

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