Stop

POST

https://openapi.lightnode.com/instance/stop

API Introduction

Stop the cloud server based on the given cloud server ID.

This interface is an asynchronous interface. When a request to shut down the cloud server is successfully issued, it will return a processResult. However, the shutdown process is not completed immediately at this point. You need to check the execution status of the task by calling the task query interface and verify the processResult. When the processResult status shows SUCCESS, it indicates that the cloud server has been successfully shut down.

Request

Header Params

Body Params application/json

Example

{
    "ecsResourceUUID": "ecs-wr00007bgadt",
    "forceStop": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi.lightnode.com/instance/stop' \
--header 'x-open-token: test-token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ecsResourceUUID": "ecs-wr00007bgadt",
    "forceStop": true
}'

Responses

🟢202成功

application/json

Body

Example

{
    "asyncTaskUUID": "cm00007dyy36",
    "httpStatus": 202,
    "rowCount": 0
}

Modified at 2025-09-24 07:43:47

Release

Start