文档首页/ Web应用防火墙 WAF/ API参考/ API/ 云模式域名管理/ 修改云模式域名路由信息
更新时间:2025-09-19 GMT+08:00
分享

修改云模式域名路由信息

功能介绍

参数解释:

更新云模式域名路由信息

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/waf/instance/{instance_id}/route

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

用户项目Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

instance_id

String

参数解释:

域名Id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表3 请求Body参数

参数

是否必选

参数类型

描述

[数组元素]

Array of RouteBody objects

路由线路列表

表4 RouteBody

参数

是否必选

参数类型

描述

cname

String

参数解释:

WAF集群的cname后缀

取值范围:

不涉及

name

String

参数解释:

WAF集群名称

取值范围:

不涉及

servers

Array of RouteServerBody objects

参数解释:

防护域名源站服务器信息列表

取值范围:

不涉及

表5 RouteServerBody

参数

是否必选

参数类型

描述

back_protocol

String

参数解释:

WAF转发客户端请求到防护域名源站服务器的协议

取值范围:

  • HTTP

  • HTTPS

address

String

参数解释:

客户端访问的源站服务器的IP地址

取值范围:

不涉及

port

Integer

参数解释:

WAF转发客户端请求到源站服务的业务端口

取值范围:

不涉及

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

[数组元素]

Array of RouteBody objects

单个路由线路详细信息

表7 RouteBody

参数

参数类型

描述

cname

String

参数解释:

WAF集群的cname后缀

取值范围:

不涉及

name

String

参数解释:

WAF集群名称

取值范围:

不涉及

servers

Array of RouteServerBody objects

参数解释:

防护域名源站服务器信息列表

取值范围:

不涉及

表8 RouteServerBody

参数

参数类型

描述

back_protocol

String

参数解释:

WAF转发客户端请求到防护域名源站服务器的协议

取值范围:

  • HTTP

  • HTTPS

address

String

参数解释:

客户端访问的源站服务器的IP地址

取值范围:

不涉及

port

Integer

参数解释:

WAF转发客户端请求到源站服务的业务端口

取值范围:

不涉及

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表14 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

响应示例

状态码

状态码

描述

200

参数解释:

请求成功

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档