All Products
Search
Document Center

Microservices Engine:DeleteGatewayRoute

Last Updated:Feb 28, 2023

Deletes a route from a gateway.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
OperateAccess levelResource typeCondition keywordAssociation operation
mse:DeleteGatewayRouteWrite
  • MSE
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RouteIdstringYes

The ID of the route.

252
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-492af9b04bb4474cae9d645be850e3d7
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data structure.

RequestIdstring

The ID of the request.

ADDD8AB7-8D1C-4697-A83E-410D2607****
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

The message returned.

The request is successfully processed.
Codeinteger

The status code returned.

200
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Dataobject

The returned data.

Idlong

The ID.

12
Namestring

The name.

test
GatewayUniqueIdstring

The unique ID of the gateway.

gw-5017305290e14cebbrvec4a5****
GatewayIdlong

The ID of the gateway.

125
Predicatesstring

The matching rules.

{\"PathPredicates\":{\"Path\":\"/metas\",\"Type\":\"PRE\",\"IgnoreCase\":false}}
DefaultServiceIdlong

The default service ID.

1
RouteOrderinteger

The sequence number of the route.

1
Statusinteger

The status of the route. Valid values:

  • 0: unpublished
  • 2: publishing
  • 3: published
  • 4: editing (updated but not published)
  • 5: unpublishing
  • 6: unavailable
2
GmtCreatestring

The creation time.

2022-01-07 18:07:57
GmtModifiedstring

The update time.

2021-12-30T06:41:52.000+0000

Example

Normal return example

JSONFormat

{
  "RequestId": "ADDD8AB7-8D1C-4697-A83E-410D2607****",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "test",
    "GatewayUniqueId": "gw-5017305290e14cebbrvec4a5****",
    "GatewayId": 125,
    "Predicates": "{\\\"PathPredicates\\\":{\\\"Path\\\":\\\"/metas\\\",\\\"Type\\\":\\\"PRE\\\",\\\"IgnoreCase\\\":false}}",
    "DefaultServiceId": 1,
    "RouteOrder": 1,
    "Status": 2,
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2021-12-30T06:41:52.000+0000"
  }
}

Error codes

HTTP status codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
400invalidParameterparameter error:%sInvalid input parameter: %s
403NoPermissionYou are not authorized to perform this operation.-
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.
500regcenterErrorregister center error:%sInstance request error: %s

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
2022-02-18Add Operation