All Products
Search
Document Center

Microservices Engine:DeleteGateway

Last Updated:Oct 11, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
mse:DeleteGateway
  • Gateway
    acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DeleteSlbbooleanNo

Specifies whether to delete the SLB instance purchased for the gateway when you delete the gateway.

true
GatewayUniqueIdstringYes

The unique ID of the gateway.

gw-0fe488252dc44d55a9dd57875193a1d7
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.

2FFEA345-BE30-5FE0-8885-42E2DEFD5FE6
HttpStatusCodeinteger

The HTTP status code returned.

200
Messagestring

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.
Codeinteger

The HTTP status code returned. The value 200 indicates that the request was successful. Other values indicate that the request failed.

200
Successboolean

Indicates whether the request was successful. Valid values:

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

The details of the data.

Idlong

The ID of the primary key.

12
Namestring

The name of the gateway.

mse-bc1a29b0-reg-center-0-1
GatewayUniqueIdstring

The unique ID of the gateway. The ID is automatically generated by the system.

gw-7ea3da97b96543e19f6c597c****
Regionstring

The ID of the region.

cn-hangzhou
PrimaryUserstring

The information about the user.

1231254
Statusinteger

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
Vpcstring

The ID of the virtual private cloud (VPC) where the gateway resides.

vpc-bp1328cm01m6uel42b5zb
Vswitchstring

The ID of the vSwitch.

vsw-bp18zeqxx6mpuq843z4n5
SecurityGroupstring

The ID of the security group.

sg-bp11ufzqn6mmb8dtzz82
Specstring

The specifications of the gateway.

MSE_GTW_16_32_200_c
Replicainteger

The number of gateway replicas.

2
GmtCreatestring

The creation time.

2022-01-07T10:07:57.000+0000
GmtModifiedstring

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 codeError codeError messageDescription
400duplicatedClusterAliasNameduplicated cluster alias nameThe instance name is duplicate. User another name.
400illegalRequestillegal request:%sInvalid request: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404clusterNotFoundcluster not foundThe cluster is not found.
500systemErrorsystem errorAn error occurred on the system. Try again later.

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