Skip to content

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

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 merged 2 commits into from
Feb 4, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc4194f
Update content
otcbot Dec 17, 2025
d37e5cd
re-applying changes from gitea
vladimirhasko Feb 3, 2026
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
20 changes: 19 additions & 1 deletion 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 @@ -72,7 +72,25 @@ Request
Response
--------

See :ref:`Responses (Jobs) <en-us_topic_0022067714>`.
:ref:`Table 5 <en-us_topic_0020212649__table2824153181913>` describes the response parameters.

.. _en-us_topic_0020212649__table2824153181913:

.. table:: **Table 5** Response parameters

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================================================================================+
| job_id | String | **Definition** |
| | | |
| | | Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on **job_id**, see :ref:`Job Status Management <en-us_topic_0022225397>`. |
| | | |
| | | **Range** |
| | | |
| | | N/A |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

For details about abnormal responses, see :ref:`Responses (Jobs) <en-us_topic_0022067714>`.

Example Request
---------------
Expand Down
20 changes: 19 additions & 1 deletion api-ref/source/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,25 @@ Request
Response
--------

See :ref:`Responses (Jobs) <en-us_topic_0022067714>`.
:ref:`Table 5 <en-us_topic_0020212207__table2824153181913>` describes the response parameters.

.. _en-us_topic_0020212207__table2824153181913:

.. table:: **Table 5** Response parameters

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================================================================================+
| job_id | String | **Definition** |
| | | |
| | | Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on **job_id**, see :ref:`Job Status Management <en-us_topic_0022225397>`. |
| | | |
| | | **Range** |
| | | |
| | | N/A |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

For details about abnormal responses, see :ref:`Responses (Jobs) <en-us_topic_0022067714>`.

Example Request
---------------
Expand Down
20 changes: 19 additions & 1 deletion api-ref/source/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,25 @@ Request
Response
--------

See :ref:`Responses (Jobs) <en-us_topic_0022067714>`.
:ref:`Table 5 <en-us_topic_0020212651__table2824153181913>` describes the response parameters.

.. _en-us_topic_0020212651__table2824153181913:

.. table:: **Table 5** Response parameters

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================================================================================+
| job_id | String | **Definition** |
| | | |
| | | Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on **job_id**, see :ref:`Job Status Management <en-us_topic_0022225397>`. |
| | | |
| | | **Range** |
| | | |
| | | N/A |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

For details about abnormal responses, see :ref:`Responses (Jobs) <en-us_topic_0022067714>`.

Example Request
---------------
Expand Down
20 changes: 19 additions & 1 deletion api-ref/source/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,25 @@ Request
Response
--------

See :ref:`Responses (Jobs) <en-us_topic_0022067714>`.
:ref:`Table 4 <en-us_topic_0022472987__table2824153181913>` describes the response parameters.

.. _en-us_topic_0022472987__table2824153181913:

.. table:: **Table 4** Response parameters

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================================================================================+
| job_id | String | **Definition** |
| | | |
| | | Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on **job_id**, see :ref:`Job Status Management <en-us_topic_0022225397>`. |
| | | |
| | | **Range** |
| | | |
| | | N/A |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

For details about abnormal responses, see :ref:`Responses (Jobs) <en-us_topic_0022067714>`.

Example Request
---------------
Expand Down
20 changes: 19 additions & 1 deletion ...f/source/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,25 @@ None
Response
--------

See :ref:`Responses (Jobs) <en-us_topic_0022067714>`.
:ref:`Table 2 <en-us_topic_0022472988__table2824153181913>` describes the response parameters.

.. _en-us_topic_0022472988__table2824153181913:

.. table:: **Table 2** Response parameters

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+=============================================================================================================================================================================================================================================================+
| job_id | String | **Definition** |
| | | |
| | | Specifies the job ID returned after a job is delivered. The job ID can be used to query the job execution progress. For details about how to query the job execution status based on **job_id**, see :ref:`Job Status Management <en-us_topic_0022225397>`. |
| | | |
| | | **Range** |
| | | |
| | | N/A |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

For details about abnormal responses, see :ref:`Responses (Jobs) <en-us_topic_0022067714>`.

Example Request
---------------
Expand Down
6 changes: 4 additions & 2 deletions api-ref/source/apis_recommended/disk_management/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
Disk Management
===============

- :ref:`Querying Information About Disks Attached to an ECS <en-us_topic_0122107473>`
- :ref:`Querying Details of a Single Disk Attached to an ECS <en-us_topic_0167811961>`
- :ref:`Listing Details About Disks Attached to an ECS <en-us_topic_0122107473>`
- :ref:`Attaching a Disk to an ECS <en-us_topic_0022472987>`
- :ref:`Detaching an EVS Disk from an ECS <en-us_topic_0022472988>`
- :ref:`Querying Disk Attachment of an ECS <en-us_topic_0101860613>`
Expand All @@ -15,7 +16,8 @@ Disk Management
:maxdepth: 1
:hidden:

querying_information_about_disks_attached_to_an_ecs
querying_details_of_a_single_disk_attached_to_an_ecs
listing_details_about_disks_attached_to_an_ecs
attaching_a_disk_to_an_ecs
detaching_an_evs_disk_from_an_ecs
querying_disk_attachment_of_an_ecs
Expand Down
Loading