StopGateway-阿里云帮助中心

Stops a 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

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	No	The ID of the gateway node instance.	dg-node-hvsGB7qVCaaW****-v-0

Response elements

Element	Type	Description	Example
	object	The response object.
Code	string	The response code.	200
Data	string	The result of the operation. A value of SUCCESS indicates that the operation is successful.	SUCCESS
ErrorMsg	string	The error message.	Gateway exception, please launch local dg first
RequestId	string	The request ID. You can use the ID to locate logs and troubleshoot issues.	DE3CC21B-E317-5ED7-A212-A62517EA0022
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
AccessDeniedDetail	object	Details about the request failure.
AuthAction	string	The API operation name.	dms-dg:StopGateway
AuthPrincipalDisplayName	string	The identifier of the principal that made the request.	23894333884425****
AuthPrincipalOwnerId	string	The principal owner ID.	1218522260143***
AuthPrincipalType	string	The principal type.	SubUser
EncodedDiagnosticMessage	string	An encoded message that contains detailed diagnostic information.	AQEAAAAAaGXktUZBOTgwNkQwLTY5ODYtNTlGNC1CQTlELTk1NjlEMjA2NDAyRA==
NoPermissionType	string	The reason the authorization check failed.	ExplicitDeny
PolicyType	string	The type of policy that caused the authorization check to fail.	COST_OPTIMIZED

Examples

Success response

JSON format

{
  "Code": "200",
  "Data": "SUCCESS",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "DE3CC21B-E317-5ED7-A212-A62517EA0022",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "dms-dg:StopGateway",
    "AuthPrincipalDisplayName": "23894333884425****\n",
    "AuthPrincipalOwnerId": "1218522260143***\n",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaGXktUZBOTgwNkQwLTY5ODYtNTlGNC1CQTlELTk1NjlEMjA2NDAyRA==",
    "NoPermissionType": "ExplicitDeny\n",
    "PolicyType": "COST_OPTIMIZED\n"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.