Queries the routes of a gateway.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| mse:ListGatewayRoute | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PageNumber | integer | No | The number of the page to return. | 1 |
| PageSize | integer | No | The number of entries to return on each page. | 10 |
| OrderItem | string | No | The item based on which entries are sorted. | GmtCreate |
| DescSort | boolean | No | Specifies whether to enable sorting. This parameter is unavailable. | false |
| FilterParams | object | No | The parameters that specify filter conditions. The parameters are in the format of {"key1":"value1"}. | |
| GatewayId | long | No | The ID of the gateway. | 81 |
| Name | string | No | The name of the gateway. | test |
| Status | integer | No | The status. | 1 |
| DefaultServiceId | long | No | The default service ID. | 1 |
| RouteOrder | integer | No | The order. | 1 |
| DomainId | long | No | The domain ID. | 284 |
| GatewayUniqueId | string | Yes | The unique ID of the gateway. | gw-30a0106924c94bca8712ec4e79fc5acc |
| DomainName | string | No | The associated domain name. | *.alites.com |
| AcceptLanguage | string | No | The language of the response. Valid values:
| zh |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "83F02EAB-ECDF-55C6-B332-8649E5E7AF2C",
"HttpStatusCode": 200,
"Message": "You are not authorized to perform this operation.",
"Code": 200,
"Success": true,
"Data": {
"TotalSize": 36,
"PageNumber": 11,
"PageSize": 10,
"Result": [
{
"Id": 47,
"Name": "test",
"GatewayUniqueId": "gw-cf0e7f52ecc7429dbc7ba4d5e3656100",
"GatewayId": 496,
"Status": 2,
"RouteOrder": 1,
"DefaultServiceName": "test",
"DefaultServiceId": 1,
"Predicates": "{\\\"PathPredicates\\\":{\\\"Path\\\":\\\"/rpc/compute \\\",\\\"Type\\\":\\\"PRE\\\",\\\"IgnoreCase\\\":true}}",
"RoutePredicates": {
"PathPredicates": {
"Path": "/getIp",
"Type": "PRE",
"IgnoreCase": true
},
"MethodPredicates": [
"GET"
],
"HeaderPredicates": [
{
"Key": "userid",
"Value": "test",
"Type": "PRE"
}
],
"QueryPredicates": [
{
"Key": "userid",
"Value": "test",
"Type": "PRE"
}
]
},
"GmtCreate": "2022-01-25T07:14:01.817+0000",
"GmtModified": "2022-01-07 18:07:57",
"Services": "[]",
"RouteServices": [
{
"ServiceId": 1563,
"ServiceName": "hu",
"Percent": 11,
"Version": "v1",
"Name": "test",
"SourceType": "MSE",
"Namespace": "default",
"GroupName": "api",
"AgreementType": "DUBBO",
"HttpDubboTranscoder": {
"DubboServiceName": "org.apache.dubbo.samples.basic.api.DemoService",
"DubboServiceVersion": "0.0.0",
"MothedMapList": [
{
"DubboMothedName": "sayHello",
"HttpMothed": "ALL_GET",
"Mothedpath": "/mytestzbk/sayhello",
"PassThroughAllHeaders": "PASS_NOT",
"PassThroughList": [
"x-forward"
],
"ParamMapsList": [
{
"ExtractKeySpec": "ALL_QUERY_PARAMETER",
"ExtractKey": "name",
"MappingType": "java.lang.String"
}
]
}
],
"DubboServiceGroup": "service group"
},
"ServicePort": 20880
}
],
"DomainId": 265,
"DomainName": "y.com",
"DestinationType": "Single",
"DirectResponse": {
"Code": 200,
"Body": "hello"
},
"DomainIdList": [
123
],
"DomainNameList": [
"test.com"
],
"Redirect": {
"Code": 200,
"Host": "test.com",
"Path": "/test"
},
"Type": "Op",
"Comment": {
"Status": "error"
},
"EnableWaf": "false",
"Fallback": true,
"FallbackServices": [
{
"ServiceId": 353,
"ServiceName": "service name",
"Percent": 100,
"Version": "v1",
"Name": "name",
"SourceType": "MSE\n",
"Namespace": "Namespace",
"GroupName": "test",
"AgreementType": "DUBBO",
"ServicePort": 8848
}
]
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IllegalRequest | Invalid request:%s | Invalid request: %s |
| 400 | InvalidParameter | Parameter error:%s | Request parameter error: %s |
| 403 | NoPermission | You are not authorized to perform this operation:%s | You do not have the permission to use this interface:%s |
| 404 | NotFound | Not found:%s | The resource does not exist:%s |
| 500 | InternalError | Console error. Try again later:%s | Console error. Try again later: %s |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-09-10 | The response structure of the API has changed | View Change Details |
| 2024-01-18 | The response structure of the API has changed | View Change Details |
| 2022-07-28 | The response structure of the API has changed | View Change Details |
| 2022-02-18 | Add Operation | View Change Details |