DescribeIstioGatewayRouteDetail - Alibaba Cloud Service Mesh

Queries the details of a gateway routing rule.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

servicemesh:DescribeIstioGatewayRouteDetail

get

*All Resource

*

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object	The response content.
RouteDetail	object	The details of the routing rule.
RouteName	string	The name of the routing rule.	demo-route
RouteType	string	The type of the routing rule. Valid values: `HTTP`, `TLS`, and `TCP`.	HTTP
MatchRequest	object	The route matching rules.
URI	object	The URI matching rule.
MatchingMode	string	The matching mode for the routing rule. Valid values: `exact`: exact match. `prefix`: prefix match. `regex`: regular expression match.	prefix
MatchingContent	string	The content to match.	/ratings/v2/
Headers	array<object>	The list of request headers to match.
	object	A request header to match.
Name	string	The key of the header to match.	x-request-id
MatchingMode	string	The matching mode for the header value. Valid values: `exact`: exact match. `prefix`: prefix match. `regex`: regular expression match.	exact
MatchingContent	string	The content to match in the header.	v1
TLSMatchAttributes	array<object>	The list of Transport Layer Security (TLS) connection matching attributes.
	object	A TLS connection matching attribute.
TLSPort	integer	The TLS port.	443
SNIHosts	array	The list of Server Name Indication (SNI) hosts.
	string	You can use a wildcard character prefix in the SNI value. For example, `.com` matches `foo.example.com` and `example.com`. Note* The SNI value must be a subset of the hosts of the corresponding virtual service.	*.com
Ports	array	The list of ports.
	integer	The port on the host to be addressed.	443
HTTPAdvancedOptions	object	The advanced configuration options for HTTP routing.
HTTPRedirect	object	The HTTP redirection.
Uri	string	The value used to overwrite the path of the URL during redirection.	/v1/getProductRatings
Authority	string	The value used to overwrite the authority or host of the URL during redirection.	newratings.default.svc.cluster.local
RedirectCode	integer	The HTTP status code to use in the redirection response. The default is 301.	301
Delegate	object	The proxy for the virtual service traffic.
Name	string	The name.	reviews
Namespace	string	The namespace.	default
Rewrite	object	The virtual service rewrite.
Uri	string	The value used to rewrite the path or prefix of the URI.	/v1/getProductRatings
Authority	string	The value used to rewrite the Authority or Host header.	newratings.default.svc.cluster.local
Timeout	string	The timeout period.	5s
Retries	object	The request retry configuration.
Attempts	integer	The number of retries allowed for a given request.	3
PerTryTimeout	string	The timeout period for each retry.	2s
RetryOn	string	The condition for a retry, such as `connect-failure,refused-stream,503`.	connect-failure,refused-stream,503
RetryRemoteLocalities	object	The settings for retrying requests to other localities.
Value	boolean	Specifies whether to retry requests to other localities. Valid values: `true`: Retries requests to other localities. `false`: Does not retry requests to other localities. Default value: `false`.	false
Fault	object	The fault injection settings.
Delay	object	The delay settings.
FixedDelay	string	The fixed delay time.	5s
ExponentialDelay	string	The exponential delay. The wait time is 2 raised to the power of the input value.	3
Percentage	object	The percentage of requests to which the delay is injected.
Value	number	The percentage of requests to which the delay is injected, specified as a decimal.	0.1
Abort	object	Aborts a request in advance with a pre-specified error code.
HttpStatus	integer	The HTTP status code.	400
Percentage	object	The percentage of requests to be aborted with the provided error code.
Value	number	The percentage of requests to be aborted, specified as a decimal.	0.1
Mirror	object	Mirrors HTTP traffic to another destination in addition to forwarding the requests to the intended destination.
Host	string	The name of the service in the service registry.	reviews.default.svc.cluster.local
Subset	string	The name of the service subset.	v1
MirrorPercentage	object	The percentage of traffic to mirror.
Value	number	The percentage of traffic to mirror, specified as a decimal.	0.2
RouteDestinations	array<object>	The list of weighted destinations for the Layer 4 routing rule.
	object	A weighted destination for the Layer 4 routing rule.
Destination	object	The destination that uniquely identifies the service instance to which the request or connection is forwarded.
Host	string	The name of the service in the service registry.	reviews
Subset	string	The name of the service subset.	v1
Port	object	The list of ports.
Number	integer	The port on the host to be addressed.	443
Weight	integer	The traffic weight. The value ranges from 1 to 100.	80
Headers	object	The request and response headers to be manipulated.
Request	object	The request headers to manipulate.
Set	object	Overwrites the header specified by the key with the given value.
	string	The header value.	key
Add	object	Adds a value to the header.	key
Remove	array	The values to remove from the header.
	string	The key to remove.	key
Response	object	The processing to perform before a response is returned.
Set	object	Overwrites the header specified by the key with the given value.	key
Add	object	Adds a value to the header.	key
Remove	array	The values to remove from the header.
	string	The key to remove.	key
Domains	array	The list of domain names to match.
	string	A domain name to match.	test.asm.aliyun.com
RawVSRoute	string	The raw YAML of the VirtualService, serialized as a JSON string.	{}
HasUnsafeFeatures	boolean	If this parameter is set to `true`, the raw YAML contains features that are not supported by the current interface.	true
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****
Priority	integer	The route priority. The smaller the integer, the higher the priority.	1
Status	integer	The status of the gateway routing rule. Valid values: `0`: The routing rule is published. `1`: The routing rule is unpublished. `2`: An error occurred when the routing rule was created or updated.	1
Description	string	The description of the routing rule.	demo route
Namespace	string	The namespace.	default

Examples

Success response

JSON format

{
  "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	Description
500	ERR500	An internal server error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.