DescribeIstioGatewayRoutes - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries the routing rules for a Service Mesh (ASM) gateway.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
servicemesh:DescribeIstioGatewayRoutes	get	All Resources ``	none	none

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

Response parameters

Parameter	Type	Description	Example
	object	The response body.
ManagementRoutes	array<object>	The routing rules.
managementRoute	object	The information about the routing rules.
ASMGatewayName	string	The name of the ASM gateway.	ingressgateway
RouteName	string	The name of the routing rule.	http-route
RoutePath	string	The path that is used to match request URLs.	/reviews/v1
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
Priority	integer	The priority of the routing rule. The value of this parameter is an integer. A smaller value indicates a higher priority.	1
Description	string	The description of the routing rule.	demo route
Namespace	string	The namespace.	istio-demo
DestinationHost	array	Destination hosts list.
host	string	Destination host.	test.asm.aliyun.com
DestinationSubSet	array	Destination subset list.
subset	string	Destination subset.	v1
RequestId	string	The request ID.	31d3a0f0-07ed-4f6e-9004-1804498c****

Examples

Sample success responses

JSONformat

{
  "ManagementRoutes": [
    {
      "ASMGatewayName": "ingressgateway",
      "RouteName": "http-route",
      "RoutePath": "/reviews/v1",
      "Status": 1,
      "Priority": 1,
      "Description": "demo route",
      "Namespace": "istio-demo",
      "DestinationHost": [
        "test.asm.aliyun.com"
      ],
      "DestinationSubSet": [
        "v1"
      ]
    }
  ],
  "RequestId": "31d3a0f0-07ed-4f6e-9004-1804498c****"
}

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
2022-08-25	The Error code has changed. The response structure of the API has changed	View Change Details