You can call this operation to stop a gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopGateway

The operation that you want to perform. Set the value to StopGateway.

GatewayId String Yes dg-yhss6sdlaffaq68

The ID of the gateway.

Response parameters

Parameter Type Example Description
Code String OK

The response code.
Data String xxx

The returned result.
ErrorMsg String None

The error message.
RequestId String CDDAAA07-D806-AG67-BEE8-1E43AAE024DE

The ID of the request.
Success Boolean true

Indicates whether the call is successful.

Samples

Sample requests


http(s)://dg.[regionId].aliyuncs.com/?Action=StopGateway
&GatewayId=dg-yhss6sdlaffaq68
&<Common request parameters>

Sample success responses

XML format 

<StopGatewayResponse>
    <RequestId>CDDAAA07-D806-AG67-BEE8-1E43AAE024DE</RequestId>
</StopGatewayResponse>

JSON format 

{
	"RequestId":"CDDAAA07-D806-AG67-BEE8-1E43AAE024DE"
}

Error codes

For a list of error codes, visit the API Error Center.