接口功能介绍
创建转发规则。
接口约束
无。
URI
POST /v4/elb/create-rule
请求参数
请求体body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | |
| regionID | String | 是 | 区域ID | |
| listenerID | String | 是 | 监听器ID | |
| priority | Integer | 否 | 优先级，数字越小优先级越高，取值范围为：1-100(目前不支持配置此参数,只取默认值100) | 100 |
| description | String | 否 | 描述 | |
| conditions | Array of Objects | 是 | 匹配规则数据 | |
| action | Object | 是 | 规则目标 |
表 conditions
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | String | 是 | 类型。取值范围：server_name（服务名称）、url_path（匹配路径） | |
| serverNameConfig | object | 否 | 服务名称 | |
| urlPathConfig | object | 否 | 匹配路径 |
表 serverNameConfig
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| serverName | String | 否 | 服务名称 |
表 urlPathConfig
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| urlPaths | String | 否 | 匹配路径 | |
| matchType | String | 否 | 匹配类型。取值范围：ABSOLUTE，PREFIX，REG |
表 action
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| type | String | 是 | 默认规则动作类型。取值范围：forward、redirect、deny(目前暂不支持配置为deny) | |
| forwardConfig | object | 否 | 转发配置 | |
| redirectListenerID | String | 否 | 重定向监听器ID，当type为redirect时，此字段必填 |
表 forwardConfig
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| targetGroups | Array of Objects | 否 | 后端服务组 |
表 targetGroup
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| targetGroupID | String | 是 | 后端服务组ID | |
| weight | Integer | 否 | 权重，取值范围：1-256。默认为100 | 100 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | 错误信息的英文描述 | success |
| description | String | 返回信息说明，如果请求成功，返回空字符串；否则为错误信息。 | |
| errCode | String | 错误描述 | SUCCESS |
| returnObj | Array of Objects | 接口业务数据 | 见下表 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ID | String | 转发规则ID | xxxx |
请求示例
POST /v4/elb/create-rule
请求体body
{
"clientToken": "xxxx",
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": "az1",
"listenerID": "listener-3ba2dlfbec",
"description": "yacos_test",
"conditions": [
{
"type": "server_name",
"serverNameConfig": {
"serverName": "yacos-test.com"
},
"urlPathConfig": {
"urlPaths": "abcd",
"matchType": "PREFIX"
}
}
],
"action": {
"type": "forward",
"forwardConfig": {
"targetGroups": [
{
"targetGroupID": "tg-td6uhtxhso",
"weight": 10
}
]
}
}
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "",
"errCode": "SUCCESS",
"returnObj": [{
"ID": "Xxxx"
}]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
