接口功能介绍
更新转发规则
接口约束
仅支持更新策略名称和描述，未见策略名称字段；域名和URL字段不支持修改。
URI
POST /v4/elb/update-rule
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性, 长度 1 - 64 | 79fa97e3-c48b-xxxx-9f46-6a13d8163678 | |
| regionID | 是 | String | 区域ID | ||
| ID | 否 | String | 转发规则ID, 该字段后续废弃 | ||
| policyID | 否 | String | 转发规则ID, 推荐使用该字段, 当同时使用 ID 和 policyID 时，优先使用 policyID | ||
| priority | 否 | Integer | 优先级，数字越小优先级越高，取值范围为：1-100(目前不支持配置此参数,只取默认值100) | 100 | |
| description | 否 | String | 支持拉丁字母、中文、数字, 特殊字符： |
《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 - 128 | acl |
| conditions | 否 | Array of Objects | 匹配规则数据 | conditions | |
| action | 否 | Object | 规则目标 | action |
表 conditions
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| type | 是 | String | 类型。取值范围：server_name（服务名称）、url_path（匹配路径） | ||
| serverNameConfig | 否 | Object | 服务名称 | serverNameConfig | |
| urlPathConfig | 否 | Object | 匹配路径 | urlPathConfig |
表 serverNameConfig
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| serverName | 否 | String | 服务名称 |
表 urlPathConfig
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlPaths | 否 | String | 匹配路径 | ||
| matchType | 否 | String | 匹配类型。取值范围：ABSOLUTE，PREFIX，REG |
表 action
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| type | 是 | String | 默认规则动作类型。取值范围：forward、redirect、deny(目前暂不支持配置为deny) | ||
| forwardConfig | 否 | Object | 转发配置 | forwardConfig | |
| redirectListenerID | 否 | String | 重定向监听器ID，当type为redirect时，此字段必填 |
表 forwardConfig
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| targetGroups | 否 | Array of Objects | 后端服务组 | targetGroup |
表 targetGroup
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| targetGroupID | 是 | String | 后端服务组ID | ||
| weight | 否 | Integer | 权重，取值范围：1-256。默认为100 | 100 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Array of Objects | 返回结果 | 见下表 | returnObj |
| error | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 转发规则 ID | xxxx |
枚举参数
无
请求示例
请求url
POST /v4/elb/update-rule
请求头header
无
请求体body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"policyID": "rule-zamd0h5toh",
"description": "yacos_test_update",
"conditions": [
{
"type": "url_path",
"serverNameConfig": {
"serverName": "yacos-test-update.com"
},
"urlPathConfig": {
"urlPaths": "1122",
"matchType": "REG"
}
}
],
"action": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 20
}
]
},
"redirectListenerId": "xxxx"
}
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"ID": "Xxxx"
}
}
状态码
请参考 状态码
错误码
请参考 错误码
