Restarts an instance.

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 RestartInstance

The operation that you want to perform.
InstanceId Long Yes 1234

The ID of the instance that you want to modify.
ProjectEnv String Yes PROD

The environment of the workspace, including projects in PROD and DEV.
RegionId String Yes cn-shanghai

Region information, which is usually the region where the service is located. For example, China (Shanghai) is cn-shanghai, and China (Zhangjiakou) is cn-zhangjiakou. You do not need to specify the RegionId because it is automatically resolved based on the endpoint that is called.

Response parameters

Parameter Type Example Description
Data Boolean true

The details of the response after you call the restart instance operation.
ErrorCode String Invalid.Tenant.ConnectionNotExists

The error code.
ErrorMessage String The connection does not exist.

The error message.
HttpStatusCode Integer 200

The HTTP status code.
RequestId String q32ety****

The ID of the request. It is used to locate logs and troubleshoot problems.
Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests


     http(s)://[Endpoint]/? Action=RestartInstance &InstanceId=1234 &ProjectEnv=PROD &RegionId=cn-shanghai &<common request parameters>

Sample success responses

XML format 


     <RequestId>q32ety****</RequestId> <HttpStatusCode>200</HttpStatusCode> <Data>true</Data> <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode> <ErrorMessage>The connection does not exist. </ErrorMessage> <Success>true</Success>

JSON Hint 


     { "RequestId": "q32ety****", "HttpStatusCode": 200, "Data": true, "ErrorCode": "Invalid.Tenant.ConnectionNotExists", "ErrorMessage": "The connection does not exist.", "Success": true }

Error code

Go to the Error Center For more information, see error codes.