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

Open
otcbot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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
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
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
8 changes: 4 additions & 4 deletions ...mation_about_disks_attached_to_an_ecs.rst → ...etails_about_disks_attached_to_an_ecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

.. _en-us_topic_0122107473:

Querying Information About Disks Attached to an ECS
===================================================
Listing Details About Disks Attached to an ECS
==============================================

Function
--------

This API is used to query information about disks attached to an ECS.
This API is used to list details about disks attached to an ECS.

URI
---
Expand Down Expand Up @@ -98,7 +98,7 @@ Response
Example Request
---------------

Query information about disks attached to an ECS.
List details about disks attached to an ECS.

.. code-block:: text

Expand Down
120 changes: 120 additions & 0 deletions ...mended/disk_management/querying_details_of_a_single_disk_attached_to_an_ecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
:original_name: en-us_topic_0167811961.html

.. _en-us_topic_0167811961:

Querying Details of a Single Disk Attached to an ECS
====================================================

Function
--------

This API is used to query details of a single disk attached to an ECS.

This API supports checking fine-grained permissions for enterprise projects. For details, see :ref:`ecs:cloudServers:showServerBlockDevice <en-us_topic_0103071514>`.

URI
---

GET /v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}

:ref:`Table 1 <en-us_topic_0167811961__table179834801714>` describes the parameters in the URI.

.. _en-us_topic_0167811961__table179834801714:

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

========== ========= =========================================
Parameter Mandatory Description
========== ========= =========================================
server_id Yes Specifies the ECS ID in UUID format.
project_id Yes Specifies the project ID.
volume_id Yes Specifies the EVS disk ID in UUID format.
========== ========= =========================================

Request
-------

None

Response
--------

:ref:`Table 2 <en-us_topic_0167811961__table11593131681815>` describes the response parameters.

.. _en-us_topic_0167811961__table11593131681815:

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

+------------------+--------+----------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==================+========+======================================================================================================================+
| volumeAttachment | Object | Specifies the disk attached to an ECS. For details, see :ref:`Table 3 <en-us_topic_0167811961__table1128997111919>`. |
+------------------+--------+----------------------------------------------------------------------------------------------------------------------+

.. _en-us_topic_0167811961__table1128997111919:

.. table:: **Table 3** **volumeAttachment** parameters

+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+==========================================================================================+
| serverId | String | Specifies the ECS ID in UUID format. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| volumeId | String | Specifies the EVS disk ID in UUID format. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| id | String | Specifies the mount ID, which is the same as the EVS disk ID. |
| | | |
| | | The value is in UUID format. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| size | Integer | Specifies the EVS disk size, in GiB. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| device | String | Specifies the drive letter of the EVS disk, displayed as the device name on the console. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| pciAddress | String | Specifies the PCI address. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| bootIndex | Integer | Specifies the EVS disk boot sequence. |
| | | |
| | | - **0** indicates the system disk. |
| | | - Non-**0** indicates a data disk. |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+
| bus | String | Specifies the disk bus type. |
| | | |
| | | Options: **virtio** and **scsi** |
+-----------------------+-----------------------+------------------------------------------------------------------------------------------+

Example Request
---------------

Query information about a specified disk attached to an ECS.

.. code-block:: text

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/block_device/{volume_id}

Example Response
----------------

.. code-block::

{
"volumeAttachment": {
"pciAddress": "0000:02:01.0",
"volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r",
"device": "/dev/vda",
"serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0",
"id": "a26887c6-c47b-4654-abb5-asdf234r234r",
"size": "40",
"bootIndex": 0,
"bus":"virtio"
}
}

Returned Values
---------------

See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.

Error Codes
-----------

See :ref:`Error Codes <en-us_topic_0022067717>`.
2 changes: 1 addition & 1 deletion .../source/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Adding an ECS to an ECS Group
Function
--------

This API is used to add an ECS to an ECS group. The system automatically deploys the newly added ECS to a host that is different from the ones accommodating other ECSs in the ECS group.
This API is used to add an ECS to an ECS group. ECSs in the same group are automatically deployed on different hosts if possible.

Constraints
-----------
Expand Down
4 changes: 2 additions & 2 deletions api-ref/source/apis_recommended/ecs_group_management/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ECS Group Management
- :ref:`Deleting an ECS Group <en-us_topic_0161097719>`
- :ref:`Adding an ECS to an ECS Group <en-us_topic_0133622595>`
- :ref:`Removing an ECS from an ECS Group <en-us_topic_0133622596>`
- :ref:`Querying ECS Groups <en-us_topic_0175597846>`
- :ref:`Listing ECS Groups <en-us_topic_0175597846>`
- :ref:`Querying Details About an ECS Group <en-us_topic_0175597847>`

.. toctree::
Expand All @@ -20,5 +20,5 @@ ECS Group Management
deleting_an_ecs_group
adding_an_ecs_to_an_ecs_group
removing_an_ecs_from_an_ecs_group
querying_ecs_groups
listing_ecs_groups
querying_details_about_an_ecs_group
8 changes: 4 additions & 4 deletions ..._group_management/querying_ecs_groups.rst → ...s_group_management/listing_ecs_groups.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

.. _en-us_topic_0175597846:

Querying ECS Groups
===================
Listing ECS Groups
==================

Function
--------

This API is used to query ECS groups.
This API is used to list ECS groups.

URI
---
Expand Down Expand Up @@ -94,7 +94,7 @@ Response
Example Request
---------------

Query ECS groups.
List ECS groups.

.. code-block:: text

Expand Down
4 changes: 2 additions & 2 deletions ...e/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Querying Details About an ECS Group
Function
--------

This API is used to query details bout an ECS group.
This API is used to query details about an ECS group.

URI
---
Expand Down Expand Up @@ -69,7 +69,7 @@ Response
Example Request
---------------

Query details about a specified ECS group.
Query details about the specified ECS group.

.. code-block:: text

Expand Down
2 changes: 1 addition & 1 deletion ...rce/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Removing an ECS from an ECS Group
Function
--------

This API is used to remove an ECS from an ECS group. After being removed, the anti-affinity policy will not take effect on this ECS and other ECSs in the same ECS group.
This API is used to remove an ECS from an ECS group. The anti-affinity policy will not be applied to the ECS after it is removed from the group.

Constraints
-----------
Expand Down
4 changes: 2 additions & 2 deletions api-ref/source/apis_recommended/flavor_management/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
Flavor Management
=================

- :ref:`Querying Details About Flavors and Extended Flavor Information <en-us_topic_0020212656>`
- :ref:`Listing Flavor Details and Extended Information <en-us_topic_0020212656>`
- :ref:`Querying the Target Flavors to Which an ECS Flavor Can Be Changed <en-us_topic_0110472767>`

.. toctree::
:maxdepth: 1
:hidden:

querying_details_about_flavors_and_extended_flavor_information
listing_flavor_details_and_extended_information
querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed
8 changes: 4 additions & 4 deletions ...avors_and_extended_flavor_information.rst → ...avor_details_and_extended_information.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

.. _en-us_topic_0020212656:

Querying Details About Flavors and Extended Flavor Information
==============================================================
Listing Flavor Details and Extended Information
===============================================

Function
--------

This API is used to query details about ECS flavors and extended flavor information.
This API is used to list flavor details and extended information.

URI
---
Expand Down Expand Up @@ -258,7 +258,7 @@ Response
Example Request
---------------

Query details about ECS flavors and extended flavor information.
List ECS flavor details and extended flavor information.

.. code-block:: text

Expand Down
4 changes: 2 additions & 2 deletions .../lifecycle_management/creating_an_ecs.rst → ...ed/lifecycle_management/creating_ecss.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

.. _en-us_topic_0020212668:

Creating an ECS
===============
Creating ECSs
=============

.. _en-us_topic_0020212668__section61372619:

Expand Down
4 changes: 2 additions & 2 deletions api-ref/source/apis_recommended/lifecycle_management/deleting_ecss.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Example Request
],
"delete_publicip": false,
"delete_volume": false
}
}

- Delete ECSs whose IDs are **616fb98f-46ca-475e-917e-2563e5a8cd19**, **616fb98f-46ca-475e-917e-2563e5a8ef20**, and **616fb98f-46ca-475e-917e-2563e5a8gh21** in batches.

Expand All @@ -121,7 +121,7 @@ Example Request
"id": "616fb98f-46ca-475e-917e-2563e5a8gh21"
}
]
}
}

Example Response
----------------
Expand Down
8 changes: 4 additions & 4 deletions api-ref/source/apis_recommended/lifecycle_management/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@
Lifecycle Management
====================

- :ref:`Creating an ECS <en-us_topic_0020212668>`
- :ref:`Creating ECSs <en-us_topic_0020212668>`
- :ref:`Deleting ECSs <en-us_topic_0020212679>`
- :ref:`Querying Details About an ECS <en-us_topic_0094148849>`
- :ref:`Querying Details About ECSs <en-us_topic_0094148850>`
- :ref:`Listing Details About ECSs <en-us_topic_0094148850>`
- :ref:`Modifying ECS Details <en-us_topic_0118308527>`

.. toctree::
:maxdepth: 1
:hidden:

creating_an_ecs
creating_ecss
deleting_ecss
querying_details_about_an_ecs
querying_details_about_ecss
listing_details_about_ecss
modifying_ecs_details
8 changes: 4 additions & 4 deletions ...anagement/querying_details_about_ecss.rst → ...management/listing_details_about_ecss.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

.. _en-us_topic_0094148850:

Querying Details About ECSs
===========================
Listing Details About ECSs
==========================

Function
--------

This API is used to query details about ECSs according to search criteria.
This API is used to list details about ECSs based on search criteria.

The information that can be queried includes the ECS billing mode and whether the ECS is frozen.

Expand Down Expand Up @@ -109,7 +109,7 @@ Response
Example Request
---------------

Query details about ECSs. Ten records are displayed on each page, starting from the first page.
List details about ECSs. Ten records are displayed on each page, starting from the first page.

.. code-block:: text

Expand Down
9 changes: 6 additions & 3 deletions .../source/apis_recommended/lifecycle_management/querying_details_about_an_ecs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Response
| | | |
| | | - **UP**: The nova-compute status is normal. |
| | | - **UNKNOWN**: The nova-compute status is unknown. |
| | | - **DOWN**: the nova-compute status is abnormal. |
| | | - **DOWN**: The nova-compute status is abnormal. |
| | | - **MAINTENANCE**: The nova-compute is in maintenance state. |
| | | - Empty string: There is no host information. |
+--------------------------------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -261,8 +261,11 @@ Example Response
"id": "s3.large.1",
"name": "s3.large.1"
"asic_accelerators": [

]
{
"name":"asic_01",
"count":1,
"memory_mb":1024
}]
},
"accessIPv4": "",
"accessIPv6": "",
Expand Down
Loading