查询转发策略详情
功能介绍
查询七层转发策略详情。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/l7policies/{l7policy_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:项目ID。 |
| l7policy_id | 是 | String | 参数解释:转发策略ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释:IAM鉴权Token。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| request_id | String | 参数解释:请求ID。 注:自动生成 。 |
| l7policy | L7Policy object | 参数解释:l7policy对象。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| action | String | 参数解释:转发策略的转发动作。 约束限制:
取值范围:
|
| admin_state_up | Boolean | 参数解释:转发策略的管理状态。 约束限制:只支持设置为true。 |
| description | String | 参数解释:转发策略描述信息。 |
| id | String | 参数解释:转发策略ID。 |
| listener_id | String | 参数解释:转发策略所属的监听器ID。 |
| name | String | 参数解释:转发策略名称 |
| position | Integer | 参数解释:转发策略的优先级,不支持更新。 不支持该字段,请勿使用。 |
| priority | Integer | 参数解释:转发策略的优先级。数字越小表示优先级越高。 约束限制:
取值范围:
默认取值:
|
| project_id | String | 参数解释:转发策略所在的项目ID。 |
| provisioning_status | String | 参数解释:转发策略的配置状态。 取值范围:
|
| redirect_pool_id | String | 参数解释:转发到pool的ID。 约束限制:当action为REDIRECT_TO_POOL时生效。 |
| redirect_listener_id | String | 参数解释:转发到的listener的ID。 约束限制:
|
| redirect_url | String | 参数解释:转发到的url。 取值范围:必须满足格式: protocol://host:port/path?query。 不支持该字段,请勿使用。 |
| rules | Array of RuleRef objects | 参数解释:转发策略关联的转发规则列表。 |
| redirect_url_config | RedirectUrlConfig object | 参数解释:转发到的url配置。 约束限制:
取值范围:格式:protocol://host:port/path?query protocol、host、port、path不允许同时不传或同时传${xxx} (${xxx}表示原值,如${host}表示被转发的请求URL的host部分)。 protocol和port传入的值不能与l7policy关联的监听器一致且host、path同时不传或同时传${xxx}。 |
| redirect_pools_extend_config | RedirectPoolsExtendConfig object | 参数解释:转发到的后端主机组的配置。 约束限制:当action为REDIRECT_TO_POOL时生效。 |
| fixed_response_config | FixtedResponseConfig object | 参数解释:固定返回页面的配置。 约束限制:
|
| created_at | String | 参数解释:创建时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
| updated_at | String | 参数解释:更新时间。 取值范围:格式:yyyy-MM-dd'T'HH:mm:ss'Z',UTC时区。 注意:独享型实例的历史数据以及共享型实例下的资源,不返回该字段。 |
| enterprise_project_id | String | 参数解释:企业项目ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| protocol | String | 参数解释:重定向的协议。 取值范围:
|
| host | String | 参数解释:重定向的主机名。 取值范围:只能包含英文字母、数字、“-”、“.”。且必须以字母、数字开头。 默认取值:${host} 表示继承原值(即与被转发请求保持一致)。 |
| port | String | 参数解释:重定向到的端口。 默认取值:默认值${port}表示继承原值(即与被转发请求保持一致)。 |
| path | String | 参数解释:重定向的路径。 取值范围:支持英文字母、数字、_~';@^-%#&$.*+?,=!:|\/()[]{},且必须以"/"开头。 默认取值:${path} 表示继承原值(即与被转发请求保持一致)。 |
| query | String | 参数解释:重定向的查询字符串。举例如下: 将query设置为:${query}&name=my_name,则在转发符合条件的URL (如https://www.example.com:8080/elb?type=loadbalancer)时,将会重定向到 https://www.example.com:8080/elb?type=loadbalancer&name=my_name。在例子中${query}表示type=loadbalancer。 取值范围:只能包含英文字母、数字和特殊字符:!$&'()*+,-./:;=?@^_`。字母区分大小写。其中$1,$2会匹配请求url通配符星号(*) 默认取值:${query}表示继承原值(即与被转发请求保持一致) |
| status_code | String | 参数解释:重定向后的返回码。 取值范围:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| rewrite_url_enable | Boolean | 参数解释:是否开启url重定向。 |
| rewrite_url_config | RewriteUrlConfig object | 参数解释:URL重定向配置。 约束限制:当action为REDIRECT_TO_POOL的时候生效。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| host | String | 参数解释:重定向的域名。 取值范围:英文字母、数字、“-”、“.”,必须以字母、数字开头。 默认取值:${host},表示继承原值(即与被重写请求host保持一致)。 |
| path | String | 参数解释:重定向的请求路径。其中$1-$9会匹配请求url通配符星号(*),当正则匹配分组小于指定数字,则$指定数字结果为空。$后面跟字母,匹配结果均为空,直到下一个特殊字符出现,例如$abc#123,则匹配结果为#123;$后面跟特殊字符则直接输出特殊字符,例如$#匹配结果为$#。 取值范围:英文字母、数字、_~';@^-%#&$.+?,=!:|/(),且必须以"/"开头。 默认取值:${path},表示继承原值(即与被重写请求保持一致)。 |
| query | String | 参数解释:重定向的查询字符串。其中$1-$9会匹配请求url通配符星号(*),当正则匹配分组小于指定数字,则$指定数字结果为空。$后面跟字母,匹配结果均为空,直到下一个特殊字符出现,例如$abc#123,则匹配结果为#123;$后面跟特殊字符则直接输出特殊字符,例如$#匹配结果为$#。 取值范围:英文字母、数字和特殊字符:!$&'()+,-./:;=?@^_`。字母区分大小写。 默认取值:${query},表示继承原值(即与被重写请求保持一致)。 |
请求示例
查询指定转发策略详情
GET https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/l7policies/cf4360fd-8631-41ff-a6f5-b72c35da74be 响应示例
状态码:200
操作正常返回。
{
"l7policy" : {
"redirect_pool_id" : "768e9e8c-e7cb-4fef-b24b-af9399dbb240",
"description" : "",
"admin_state_up" : true,
"rules" : [ {
"id" : "c5c2d625-676b-431e-a4c7-c59cc2664881"
} ],
"project_id" : "7a9941d34fc1497d8d0797429ecfd354",
"listener_id" : "cdb03a19-16b7-4e6b-bfec-047aeec74f56",
"redirect_url" : null,
"redirect_url_config" : null,
"redirect_pools_config" : {
"pool_id" : "722e9e8c-e7cb-4fef-b24b-af9399dbb240",
"weight" : 12
},
"redirect_pools_sticky_session_config" : {
"timeout" : 23,
"enable" : false
},
"fixed_response_config" : {
"content_type" : "text/plain",
"message_body" : "",
"status_code" : "207"
},
"redirect_listener_id" : null,
"action" : "REDIRECT_TO_POOL",
"position" : 100,
"priority" : 1,
"provisioning_status" : "ACTIVE",
"id" : "01832d99-bbd8-4340-9d0c-6ff8f7a37307",
"name" : "l7policy-67"
},
"request_id" : "6be83ec4-623e-4840-a417-2fcdf8ad5dfa"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 操作正常返回。 |
错误码
请参见错误码。