文档

CreateIstioGatewayRoutes - 创建ASM网关对应的路由

调用CreateIstioGatewayRoutes创建ASM网关对应的路由。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ServiceMeshIdstring

服务网格实例 ID。

c08ba3fd1e6484b0f8cc1ad8fe10d****
IstioGatewayNamestring

ASM 网关名称。

ingressgateway
GatewayRouteobject

网关路由信息。

RouteNamestring

路由名称

reviews-v2-routes
RouteTypestring

路由类型,取值:HTTPTLSTCP

HTTP
MatchRequestobject

路由匹配规则。

URIobject

URI 匹配规则。

MatchingModestring

路由规则匹配模式。取值:

  • exact:精准匹配。

  • prefix:前缀匹配。

  • regex:正则匹配。

prefix
MatchingContentstring

用于匹配的内容。

/ratings/v2/
Headersobject []

用于判断是否匹配的请求头部列表。

Namestring

Header 匹配的键。

x-request-id
MatchingModestring

Header 值匹配方式,取值:

  • exact:精准匹配。

  • prefix:前缀匹配。

  • regex:正则匹配。

exact
MatchingContentstring

用于 Header 匹配的内容。

v1
TLSMatchAttributesobject []

TLS 连接匹配属性列表。

TLSPortinteger

TLS 端口。

443
SNIHostsarray

服务器名称标识列表。

string

SNI 值中可以使用通配符前缀,例如*.com将匹配foo.example.comexample.com

说明 SNI 值必须是相应虚拟服务主机的子集。
*.com
Portsarray

L4 目标端口列表。

integer

指定主机上要寻址的端口。

443
RouteDestinationsobject []

L4 路由规则加权目的地列表。

Destinationobject

Destination 唯一标识请求或连接应转发到的服务实例。

Hoststring

服务注册表中服务的名称。

reviews
Subsetstring

服务中子集的名称。

v1
Portobject

端口

Numberinteger

端口号

80
Weightinteger

服务子集权重。

80
HTTPAdvancedOptionsobject

HTTP 路由高级配置选项。

HTTPRedirectobject

HTTP 重定向。

Uristring

在重定向时,使用此值覆盖 URL 的路径部分。

/v1/getProductRatings
Authoritystring

在重定向时,使用此值覆盖 URL 的Authority/Host部分。

newratings.default.svc.cluster.local
RedirectCodeinteger

在重定向上,指定要在重定向响应中使用的 HTTP 状态代码。默认响应代码为 301。

301
Delegateobject

虚拟服务流量代理。

Namestring

名称。

reviews
Namespacestring

命名空间。

default
Rewriteobject

重写虚拟服务。

Uristring

用这个值重写 URI 的路径(或前缀)部分。

/v1/getProductRatings
Authoritystring

使用此值重写 Authority 或 Host 头。

newratings.default.svc.cluster.local
Timeoutstring

超时时长。

5s
Retriesobject

请求重试配置。

Attemptsinteger

给定请求允许的重试次数。

3
PerTryTimeoutstring

用于指定给定请求的每次尝试超时,例如5s

5s
RetryOnstring

用于指定重试发生的条件,例如connect-failure,refused-stream,503

connect-failure,refused-stream,503
RetryRemoteLocalitiesobject

用于指定重试是否应重试到其他位置的标志。

Valueboolean

用于指定重试是否应重试到其他位置的标志,取值:

  • true:其他位置也重试。

  • false:其他位置不重试。

默认false

false
Faultobject

故障注入设置。

Delayobject

设置延迟。

FixedDelaystring

固定延迟时间。

5s
Percentageobject

将注入延迟的请求的百分比。

Valuefloat

将注入延迟的请求的百分比,用小数表示。

0.1
Abortobject

提前中止带有预先指定的错误码的请求。

HttpStatusinteger

HTTP 状态码。

400
Percentageobject

使用提供的错误码中止的请求的百分比。

Valuefloat

使用提供的错误码中止的请求的百分比,用小数表示。

0.1
Mirrorobject

除了将请求转发到预期目标之外,还将 HTTP 通信镜像到另一个目标。

Hoststring

服务注册表中服务的名称。

reviews.default.svc.cluster.local
Subsetstring

服务中子集的名称。

v1
MirrorPercentageobject

流量镜像百分比。

Valuefloat

流量镜像百分比,用小数表示。

0.2
Namespacestring

命名空间

default
Domainsarray

请求域名列表。

string

域名。

test.asm.aliyun.com
RawVSRouteany

Json 类型的字符串。和虚拟服务中的三种路由类型对应,提供高级功能的配置入口。此处的配置,将会覆盖 RouteName、RouteType、MatchRequest、HTTPAdvancedOptions 中的配置。

{ "http": { "route": [ { "destination": { "host": "httpbin" } } ], "name": "httpbin", "match": [ { "uri": { "prefix": "/" } } ], "fault": { "delay": { "fixedDelay": "2s", "percentage": { "value": 70 } } } } }
Priorityinteger

路由优先级。整数,数字越小,优先级越高。

1
Statusinteger

网关路由状态,取值:

  • 0:在线。

  • 1:下线。

  • 2:创建或更新错误。

1
Descriptionstring

路由描述。

demo route

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

31d3a0f0-07ed-4f6e-9004-1804498c****

示例

正常返回示例

JSON格式

{
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-06-25API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-25API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈