DeleteGatewayInstance-阿里云帮助中心

Deletes the specified database gateway instance.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
GatewayId	string	Yes	The ID of the gateway.	dg-nmz841r7b681****
GatewayInstanceId	string	Yes	The ID of the gateway instance.	dg-node-QeH6VfT8GRnPrYWX****
RegionId	string	Yes	The region where the gateway is located.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	The response.
Code	string	The response code.	200
Data	string	The result of the operation.	SUCCESS
ErrorMsg	string	The error message.	Gateway exception, please launch local dg first
RequestId	string	The request ID. You can use this ID to locate logs and troubleshoot issues.	8F29E3E9-2847-53BF-ADF0-130E3CEA5C63
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
AccessDeniedDetail	object	The details of the request failure.
AuthAction	string	The name of the API operation.	dms-dg:DeleteGatewayInstance
AuthPrincipalDisplayName	string	The display name of the authenticating principal.	23894333884425****
AuthPrincipalOwnerId	string	The owner ID of the principal.	1218522260143***
AuthPrincipalType	string	The type of the principal.	SubUser
EncodedDiagnosticMessage	string	The encrypted full diagnostic message.	AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==
NoPermissionType	string	The reason for the authorization failure.	ExplicitDeny
PolicyType	string	The type of policy that caused the authorization failure.	COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": "SUCCESS",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "8F29E3E9-2847-53BF-ADF0-130E3CEA5C63",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:DeleteGatewayInstance",
    "AuthPrincipalDisplayName": "23894333884425****",
    "AuthPrincipalOwnerId": "1218522260143***",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaKvGBjQwQzQ3OUI0LUVDNjQtNTIwQi1CRENDLTY5MDVDQ0Y3N0MxRA==",
    "NoPermissionType": "ExplicitDeny",
    "PolicyType": "COST_OPTIMIZED"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.