DeleteGateway - Microservices Engine - Alibaba Cloud Documentation Center

Deletes 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:DeleteGateway		*Gateway `acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DeleteSlb	boolean	No	Specifies whether to delete the SLB instance purchased for the gateway when you delete 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 parameters

Parameter	Type	Description	Example
	object	The data structure.
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 returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The details of the data.
Id	long	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. The ID is 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 time when the gateway was last updated.	2022-01-07T10:07:57.000+0000

Examples

Sample success responses

JSONformat

{
  "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	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.