Skip to content

Propagate changes to elastic-cloud-server-api-ref from PreProd environment #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
otc-zuul-prod merged 1 commit into from
Aug 21, 2026
Merged

Propagate changes to elastic-cloud-server-api-ref from PreProd environment #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 85 additions & 17 deletions api-ref/source/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,25 @@ POST /v1/{project_id}/cloudservers/action

.. table:: **Table 1** Parameter description

========== ========= =========================
Parameter Mandatory Description
========== ========= =========================
project_id Yes Specifies the project ID.
========== ========= =========================
+-----------------------+-----------------------+---------------------------+
| Parameter | Mandatory | Description |
+=======================+=======================+===========================+
| project_id | Yes | **Definition** |
| | | |
| | | Specifies the project ID. |
| | | |
| | | **Constraints** |
| | | |
| | | N/A |
| | | |
| | | **Range** |
| | | |
| | | N/A |
| | | |
| | | **Default Value** |
| | | |
| | | N/A |
+-----------------------+-----------------------+---------------------------+

Request
-------
Expand All @@ -38,11 +52,25 @@ Request

.. table:: **Table 2** Request parameters

+-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+============================================================================================================================+
| reboot | Yes | Object | Specifies the operation to restart the ECS. For details, see :ref:`Table 3 <en-us_topic_0020212649__table64591731162222>`. |
+-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+============================================================================================================================+
| reboot | Yes | Object | **Definition** |
| | | | |
| | | | Specifies the operation to restart the ECS. For details, see :ref:`Table 3 <en-us_topic_0020212649__table64591731162222>`. |
| | | | |
| | | | **Constraints** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Range** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Default Value** |
| | | | |
| | | | N/A |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+

.. _en-us_topic_0020212649__table64591731162222:

Expand All @@ -51,23 +79,63 @@ Request
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+==================+===================================================================================================+
| type | Yes | String | Specifies the type of the restart operation. |
| type | Yes | String | **Definition** |
| | | | |
| | | | Specifies the type of the restart operation. |
| | | | |
| | | | **Constraints** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Range** |
| | | | |
| | | | - **SOFT**: normal restart |
| | | | - **HARD**: forcible restart (hard restart) |
| | | | |
| | | | **Default Value** |
| | | | |
| | | | N/A |
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+
| servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 <en-us_topic_0020212649__table26785545162223>`. |
| servers | Yes | Array of objects | **Definition** |
| | | | |
| | | | Specifies ECS IDs. For details, see :ref:`Table 4 <en-us_topic_0020212649__table26785545162223>`. |
| | | | |
| | | | **Constraints** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Range** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Default Value** |
| | | | |
| | | | N/A |
+-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+

.. _en-us_topic_0020212649__table26785545162223:

.. table:: **Table 4** **servers** field description

========= ========= ====== =====================
Parameter Mandatory Type Description
========= ========= ====== =====================
id Yes String Specifies the ECS ID.
========= ========= ====== =====================
+-----------------+-----------------+-----------------+-----------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+=======================+
| id | Yes | String | **Definition** |
| | | | |
| | | | Specifies the ECS ID. |
| | | | |
| | | | **Constraints** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Range** |
| | | | |
| | | | N/A |
| | | | |
| | | | **Default Value** |
| | | | |
| | | | N/A |
+-----------------+-----------------+-----------------+-----------------------+

Response
--------
Expand Down
Loading
Loading