Batch Modifying the Power Statuses of Physical Servers

Function

This API is used to modify the power status of a physical server. It is an asynchronous API. The power status modification result can be obtained from the information about the physical server.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/physicalservers/power-state

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. Constraints N/A Range Project ID of the account. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition Requests for calling an API can be authenticated using a token. If token-based authentication is used, this parameter is mandatory and must be set to a user token. Constraints N/A Range N/A Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
action	Yes	String	Definition Power operation type. Constraints N/A Range power on power off rebooting Default Value N/A
server_id_set	No	Array of strings	Definition Server ID list. Constraints A server ID list can contain a maximum of 50 IDs.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
physical_servers	Array of physical_servers objects	Definition Returned information about physical servers. Constraints N/A

**Table 5** physical_servers
Parameter	Type	Description
id	String

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Status code: 429

**Table 8** Response body parameters
Parameter	Type	Description
-	String

Status code: 500

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error description.

Example Requests

Modifying the power status of physical servers in batches

PUT https://{endpoint}/v1/{project_id}/physicalservers/power-state

{
  "action" : "power on",
  "server_id_set" : [ "01939592-e8fe-7d9b-9332-4589486377a4" ]
}

Example Responses

Status code: 200

Power status modified.

{
  "physical_servers" : [ {
    "id" : {
      "$ref" : "#/definitions/UUID"
    }
  } ]
}

Status Codes

Status Code	Description
200	Power status modified.
400	Invalid request parameter.
401	The request is not authenticated.
429	The request is overloaded.
500	Internal server error.

Error Codes

See Error Codes.

Parent topic:Physical Server Management

Previous topic: Exporting Server Logs

Next topic: Querying the Export Status of Logs

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot