DescribeIstioGatewayRouteDetail - Alibaba Cloud Service Mesh

Queries the detailed information about a routing rule of an Alibaba Cloud Service Mesh (ASM) gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
ServiceMeshId	string	Yes	The ASM instance ID.	c08ba3fd1e6484b0f8cc1ad8fe10d****
IstioGatewayName	string	No	The name of the ASM gateway.	ingressgateway
RouteName	string	No	The name of the routing rule.	demo-route

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RouteDetail	object	The detailed information about the routing rule.
RouteName	string	The name of the routing rule.	demo-route
RouteType	string	The type of the traffic to be routed. Valid values: `HTTP`, `TLS`, and `TCP`.	HTTP
MatchRequest	object	The matching rules for traffic routing.
URI	object	The matching rule for URIs.
MatchingMode	string	The matching mode. Valid values: `exact`: exact match `prefix`: match by prefix `regex`: match by regular expression	prefix
MatchingContent	string	The content to be matched.	/ratings/v2/
Headers	object []	The request headers to be matched.
Name	string	The header key to be matched.	x-request-id
MatchingMode	string	The matching mode for the header value. Valid values: `exact`: exact match `prefix`: match by prefix `regex`: match by regular expression	exact
MatchingContent	string	The header value to be matched.	v1
TLSMatchAttributes	object []	The matching rules for Transport Layer Security (TLS) traffic.
TLSPort	integer	The TLS port.	443
SNIHosts	array	The Server Name Indication (SNI) values to be matched.
	string	Wildcards can be used as the prefix of an SNI value. For example, the value `.com` matches `foo.example.com` and `example.com`. Note* The SNI values must be a subset of the hostnames of the corresponding virtual hosts.	*.com
Ports	array	The ports.
	integer	The ports of the specified hosts to which the traffic is routed.	443
HTTPAdvancedOptions	object	The advanced settings for routing HTTP traffic.
HTTPRedirect	object	The HTTP redirection rule.
Uri	string	The value to be used to overwrite the URL path during redirection.	/v1/getProductRatings
Authority	string	The value to be used to overwrite the value of the Authority or Host header during redirection.	newratings.default.svc.cluster.local
RedirectCode	integer	The HTTP status code to be used to indicate URL redirection. Default value: 301.	301
Delegate	object	The virtual service that defines traffic routing.
Name	string	The name of the virtual service.	reviews
Namespace	string	The namespace to which the virtual service belongs.	default
Rewrite	object	The configurations for rewriting the virtual service.
Uri	string	The value to be used to overwrite the path or prefix of the URI.	/v1/getProductRatings
Authority	string	The value to be used to overwrite the value of the Authority or Host header.	newratings.default.svc.cluster.local
Timeout	string	The timeout period for requests.	5s
Retries	object	The configurations of retries for failed requests.
Attempts	integer	The number of retries that are allowed for a request.	3
PerTryTimeout	string	The timeout period for each retry.	2s
RetryOn	string	The condition for retries. Example: `connect-failure,refused-stream,503`.	connect-failure,refused-stream,503
RetryRemoteLocalities	object	Specifies whether to allow retries to other localities.
Value	boolean	Specifies whether to allow retries to other localities. Valid values: `true` `false` Default value: `false`.	false
Fault	object	The configurations of fault injection.
Delay	object	The duration to delay a request.
FixedDelay	string	The fixed duration for request delay.	5s
ExponentialDelay	string	The duration for request delay is expressed as 2 raised to the power of x. You must specify the value of x.	3
Percentage	object	The percentage of requests to which the delay fault is injected.
Value	float	The percentage of requests that are aborted with the specified error code, which is expressed as a decimal.	0.1
Abort	object	The configurations for aborting requests with specified error codes.
HttpStatus	integer	The HTTP status code.	400
Percentage	object	The percentage of requests that are aborted with the specified error code.
Value	float	The percentage of requests that are mirrored to another destination except for the original destination, which is expressed as a decimal.	0.1
Mirror	object	The configurations for mirroring HTTP traffic to another destination in addition to forwarding requests to the specified destination.
Host	string	The name of the service defined in the service registry.	reviews.default.svc.cluster.local
Subset	string	The name of the service subset.	v1
MirrorPercentage	object	The percentage of requests that are aborted with the specified error code.
Value	float	The percentage of requests that are aborted with the specified error code, which is expressed as a decimal.	0.2
RouteDestinations	object []	The endpoints of destination services for Layer 4 weighted routing.
Destination	object	The unique endpoint of the destination service to which the specified requests are sent.
Host	string	The name of the service defined in the service registry.	reviews
Subset	string	The name of the service subset.	v1
Port	object	The ports of the specified hosts from which the traffic is routed.
Number	integer	The ports of the specified hosts to which the traffic is routed.	443
Weight	integer	The traffic weight. Valid values: 1 to 100.	80
Headers	object	The list of the request headers to be matched.
Request	object	The request header to be matched.
Set	object	The header key to be used to overwrite the original header key.
	string	The header key that you specify.	key
Add	object	The values to be added to the header key.	key
Remove	array	The header value to be deleted.
	string	The key to be deleted.	key
Response	object	The processing of the headers of the response that is to be returned.
Set	object	The header key to be used to overwrite the original header key.	key
Add	object	The values to be added to the header key.	key
Remove	array	The header value to be deleted.
	string	The key to be deleted.	key
Domains	array	Domain list.
	string	One Domain.	test.asm.aliyun.com
RawVSRoute	string	The original YAML file of the virtual service that is serialized into a JSON string.	{}
HasUnsafeFeatures	boolean	If the value is true, the original YAML file contains features that are not supported on the current interface.	true
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****
Priority	integer	The priority of the routing rule. The value of this parameter is an integer. A smaller value indicates a higher priority.	1
Status	integer	The status of the routing rule. Valid values: `0`: The routing rule is valid. `1`: The routing rule is invalid. `2`: An error occurs during the creation or update of the routing rule.	1
Description	string	The description of the routing rule.	demo route
Namespace	string	The namespace.	default

Examples

Sample success responses

JSONformat

{
  "RouteDetail": {
    "RouteName": "demo-route",
    "RouteType": "HTTP",
    "MatchRequest": {
      "URI": {
        "MatchingMode": "prefix",
        "MatchingContent": "/ratings/v2/"
      },
      "Headers": [
        {
          "Name": "x-request-id",
          "MatchingMode": "exact",
          "MatchingContent": "v1"
        }
      ],
      "TLSMatchAttributes": [
        {
          "TLSPort": 443,
          "SNIHosts": [
            "*.com"
          ]
        }
      ],
      "Ports": [
        443
      ]
    },
    "HTTPAdvancedOptions": {
      "HTTPRedirect": {
        "Uri": "/v1/getProductRatings",
        "Authority": "newratings.default.svc.cluster.local",
        "RedirectCode": 301
      },
      "Delegate": {
        "Name": "reviews",
        "Namespace": "default"
      },
      "Rewrite": {
        "Uri": "/v1/getProductRatings",
        "Authority": "newratings.default.svc.cluster.local"
      },
      "Timeout": "5s",
      "Retries": {
        "Attempts": 3,
        "PerTryTimeout": "2s",
        "RetryOn": "connect-failure,refused-stream,503",
        "RetryRemoteLocalities": {
          "Value": false
        }
      },
      "Fault": {
        "Delay": {
          "FixedDelay": "5s",
          "ExponentialDelay": "3",
          "Percentage": {
            "Value": 0.1
          }
        },
        "Abort": {
          "HttpStatus": 400,
          "Percentage": {
            "Value": 0.1
          }
        }
      },
      "Mirror": {
        "Host": "reviews.default.svc.cluster.local",
        "Subset": "v1"
      },
      "MirrorPercentage": {
        "Value": 0.2
      }
    },
    "RouteDestinations": [
      {
        "Destination": {
          "Host": "reviews",
          "Subset": "v1",
          "Port": {
            "Number": 443
          }
        },
        "Weight": 80,
        "Headers": {
          "Request": {
            "Set": {
              "key": "key"
            },
            "Add": {
              "test": "test",
              "test2": 1
            },
            "Remove": [
              "key"
            ]
          },
          "Response": {
            "Set": {
              "test": "test",
              "test2": 1
            },
            "Add": {
              "test": "test",
              "test2": 1
            },
            "Remove": [
              "key"
            ]
          }
        }
      }
    ],
    "Domains": [
      "test.asm.aliyun.com"
    ],
    "RawVSRoute": "{}",
    "HasUnsafeFeatures": true
  },
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****",
  "Priority": 1,
  "Status": 1,
  "Description": "demo route",
  "Namespace": "default"
}

Error codes

HTTP status code	Error code	Error message
500	ERR500	An internal server error occurred.

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2023-06-25

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 500
Output Parameters	The response structure of the API has changed.