Delete an MSE Gateway via DeleteGateway API - Microservices Engine - Alibaba Cloud - Microservices Engine

Deletes a specified gateway.

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

mse:DeleteGateway

delete

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
DeleteSlb	boolean	No	Specifies whether to also delete the SLB instance purchased for the gateway.	true
GatewayUniqueId	string	Yes	The unique ID of the gateway.	gw-0fe488252dc44d55a9dd57875193a1d7
AcceptLanguage	string	No	The language of the response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request.	2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6
HttpStatusCode	integer	The HTTP status code returned.	200
Message	string	The returned message. If the request is successful, a success message is returned. If the request fails, an error message is returned, such as the "TaskId not found" message.	The request is successfully processed.
Code	integer	The HTTP status code. A value of 200 indicates success. Other values indicate failure.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The returned data.
Id	integer	The ID of the primary key.	12
Name	string	The name of the gateway.	mse-bc1a29b0-reg-center-0-1
GatewayUniqueId	string	The unique ID of the gateway, automatically generated by the system.	gw-7ea3da97b96543e19f6c597c****
Region	string	The ID of the region.	cn-hangzhou
PrimaryUser	string	The information about the user.	1231254
Status	integer	The status of the gateway. Valid values: 0: The gateway is being created. 1: The gateway fails to be created. 2: The gateway is running. 3: The gateway is changing. 4: The gateway is scaling down. 6: The gateway is scaling up. 8: The gateway is being deleted. 10: The gateway is restarting. 11: The gateway is being rebuilt. 12: The gateway is updating. 13: The gateway fails to be updated.	1
Vpc	string	The ID of the virtual private cloud (VPC) where the gateway resides.	vpc-bp1328cm01m6uel42b5zb
Vswitch	string	The ID of the vSwitch.	vsw-bp18zeqxx6mpuq843z4n5
SecurityGroup	string	The ID of the security group.	sg-bp11ufzqn6mmb8dtzz82
Spec	string	The specifications of the gateway.	MSE_GTW_16_32_200_c
Replica	integer	The number of gateway replicas.	2
GmtCreate	string	The creation time.	2022-01-07T10:07:57.000+0000
GmtModified	string	The last modification time.	2022-01-07T10:07:57.000+0000

Examples

Success response

JSON format

{
  "RequestId": "2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6",
  "HttpStatusCode": 200,
  "Message": "The request is successfully processed.\n",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 12,
    "Name": "mse-bc1a29b0-reg-center-0-1",
    "GatewayUniqueId": "gw-7ea3da97b96543e19f6c597c****",
    "Region": "cn-hangzhou",
    "PrimaryUser": "1231254",
    "Status": 1,
    "Vpc": "vpc-bp1328cm01m6uel42b5zb",
    "Vswitch": "vsw-bp18zeqxx6mpuq843z4n5",
    "SecurityGroup": "sg-bp11ufzqn6mmb8dtzz82",
    "Spec": "MSE_GTW_16_32_200_c",
    "Replica": 2,
    "GmtCreate": "2022-01-07T10:07:57.000+0000",
    "GmtModified": "2022-01-07T10:07:57.000+0000"
  }
}

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
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.