ApplyGatewayRoute - Microservices Engine - Alibaba Cloud Documentation Center

Publishes a route for a 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
mse:ApplyGatewayRoute		*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
RouteId	string	Yes	The ID of the route.	950
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-1a4ab101d5924b6f92c5ec98a841761f
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The data structure.
RequestId	string	The ID of the request.	1DB1AB36-8395-540E-AACC-7571D6B2057A
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The message returned.	success
Code	integer	The response code returned.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	boolean	The data of the node.	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "1DB1AB36-8395-540E-AACC-7571D6B2057A",
  "HttpStatusCode": 200,
  "Message": "success",
  "Code": 200,
  "Success": true,
  "Data": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	duplicatedClusterAliasName	duplicated cluster alias name	The instance name is duplicate. User another name.
400	illegalRequest	illegal request:%s	Invalid request: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	clusterNotFound	cluster not found	The cluster is not found.
500	systemError	system error	An error occurred on the system. Try again later.

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

Change history

Change time	Summary of changes	Operation
2022-02-18	Add Operation	View Change Details