修改云模式域名路由信息
功能介绍
参数解释:
更新云模式域名路由信息
约束限制:
不涉及
取值范围:
不涉及
默认取值:
不涉及
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/waf/instance/{instance_id}/route
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 用户项目Id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
instance_id |
是 |
String |
参数解释: 域名Id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 租户token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
[数组元素] |
是 |
Array of RouteBody objects |
路由线路列表 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
cname |
否 |
String |
参数解释: WAF集群的cname后缀 取值范围: 不涉及 |
name |
是 |
String |
参数解释: WAF集群名称 取值范围: 不涉及 |
servers |
是 |
Array of RouteServerBody objects |
参数解释: 防护域名源站服务器信息列表 取值范围: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of RouteBody objects |
单个路由线路详细信息 |
参数 |
参数类型 |
描述 |
---|---|---|
cname |
String |
参数解释: WAF集群的cname后缀 取值范围: 不涉及 |
name |
String |
参数解释: WAF集群名称 取值范围: 不涉及 |
servers |
Array of RouteServerBody objects |
参数解释: 防护域名源站服务器信息列表 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
back_protocol |
String |
参数解释: WAF转发客户端请求到防护域名源站服务器的协议 取值范围:
|
address |
String |
参数解释: 客户端访问的源站服务器的IP地址 取值范围: 不涉及 |
port |
Integer |
参数解释: WAF转发客户端请求到源站服务的业务端口 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
参数解释: 请求成功 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
400 |
参数解释: 请求失败 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
401 |
参数解释: token权限不足 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
500 |
参数解释: 服务器内部错误 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
错误码
请参见错误码。