更新规则优先级--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新规则优先级

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

本接口支持通过指定应用 ID、配置项 ID 以及待更新后的全部规则 ID 及规则优先级，来更新配置项下的规则优先级。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`179132`	应用 ID，您可以通过调用获取应用列表的方式获取所需的 AppId。
SettingId	String	是	`S-6c040a73-7f60-44f7-b3d0-d13942dcc752`	配置项 ID，您可以通过调用获取配置项列表的方式获取所需的配置项 ID。
Priorities	Array of Priorities	是	`-`	更新后的优先级信息。

Priorities

参数	类型	是否必选	示例值	描述
RuleId	String	是	`R-d7b5625e-bdf1-40be-916d-c3fb3406b405`	待更新优先级的规则 ID，您可以通过调用获取规则列表的方式获取所需的规则 ID。
Priority	Integer	是	`1`	规则优先级。说明如果配置项下创建了多个规则，需要填写全部规则更新后的优先级。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageSettingRulePriority&Version=2023-05-01
{
    "AppId": "179132",
    "SettingId": "S-6c040a73-7f60-44f7-b3d0-d13942dcc752",
    "Priorities": [
    	{
            "RuleId": "R-d7b5625e-bdf1-40be-916d-c3fb3406b405",
            "Priority": 1
        }
    ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "UpdateImageSettingRulePriority",
    "Version": "2023-05-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {}
}

错误码

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

历史版本

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