vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

start tracking generated rst to have easier diff

Browse Source
This commit is contained in:
Artem Goncharov 2022-04-07 16:22:09 +02:00
parent eb60ef7f16
commit 47a055a8b5
877 changed files with 93678 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -129,5 +129,4 @@ dmypy.json
.pyre/ .pyre/
**/temp/ **/temp/
**/result/
**/tmp_result/ **/tmp_result/

10
ecs/api-ref/result/api_usage_guidelines.rst Normal file
View File

@ -0,0 +1,10 @@
.. _en-us_topic_0020805967:
API Usage Guidelines
====================
Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: *https://Endpoint/uri*. In the URL, **uri** indicates the resource path, that is, the API access path.
Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by **Application/json**.
For details about how to use APIs, see `API Usage Guidelines <https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API%20Documents>`__.

12
ecs/api-ref/result/apis_recommended/batch_operations/index.rst Normal file
View File

@ -0,0 +1,12 @@
.. _en-us_topic_0167816247:
================
Batch Operations
================
.. toctree::
:maxdepth: 1
starting_ecss_in_a_batch
restarting_ecss_in_a_batch
stopping_ecss_in_a_batch

112
ecs/api-ref/result/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

101
ecs/api-ref/result/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

109
ecs/api-ref/result/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

95
ecs/api-ref/result/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst Normal file
View File

@ -0,0 +1,95 @@
.. _en-us_topic_0022472987:
Attaching a Disk to an ECS
==========================
Function
--------
This API is used to attach a disk to an ECS.
URI
---
POST /v1/{project_id}/cloudservers/{server_id}/attachvolume
:ref:`Table 1 <en-us_topic_0022472987__table35528365105553>` describes the parameters in the URI.
.. _en-us_topic_0022472987__table35528365105553:
.. table:: **Table 1** Parameter description
========== ========= =========================
Parameter Mandatory Description
========== ========= =========================
project_id Yes Specifies the project ID.
server_id Yes Specifies the ECS ID.
========== ========= =========================
Request
-------
.. table:: **Table 2** Request parameters
+------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+==================+===========+========+==========================================================================================================================+
| volumeAttachment | Yes | Object | Specifies the ECS attachment information. For details, see :ref:`Table 3 <en-us_topic_0022472987__table40707503151632>`. |
+------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+
.. _en-us_topic_0022472987__table40707503151632:
.. table:: **Table 3** **volumeAttachment** field description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+
| volumeId | Yes | String | Specifies the ID of the disk to be attached. The value is in UUID format. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| device | No | String | Indicates the disk device name. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | - The new disk device name cannot be the same as an existing one. |
| | | | - For KVM ECSs, set the parameter value to **/dev/vda** for system disks. The device names for data disks of KVM ECSs are optional. If the device names of data disks are required, set them in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to **/dev/vdb** and **/dev/vdc**, respectively. If you set a device name starting with **/dev/sd**, the system uses **/dev/vd** by default. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Response
--------
See :ref:`Responses (Task) <en-us_topic_0022067714>`.
Example Request
---------------
.. code-block::
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/attachvolume
.. code-block::
{
"volumeAttachment": {
"volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",
"device": "/dev/sda"
}
}
Example Response
----------------
.. code-block::
{
"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

69
ecs/api-ref/result/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst Normal file
View File

@ -0,0 +1,69 @@
.. _en-us_topic_0022472988:
Detaching an EVS Disk from an ECS
=================================
Function
--------
This API is used to detach an EVS disk from an ECS.
URI
---
DELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}?delete_flag=0
:ref:`Table 1 <en-us_topic_0022472988__table2814978410562>` describes the parameters in the URI.
.. _en-us_topic_0022472988__table2814978410562:
.. table:: **Table 1** Parameter description
+-----------------------+-----------------------+---------------------------------------------------+
| Parameter | Mandatory | Description |
+=======================+=======================+===================================================+
| project_id | Yes | Specifies the project ID. |
+-----------------------+-----------------------+---------------------------------------------------+
| server_id | Yes | Specifies the ECS ID. |
+-----------------------+-----------------------+---------------------------------------------------+
| volume_id | Yes | Specifies the disk ID. |
+-----------------------+-----------------------+---------------------------------------------------+
| delete_flag | No | Indicates whether to forcibly detach a data disk. |
| | | |
| | | - If yes, set it to **1**. |
| | | - If no, set it to **0**. |
| | | |
| | | It is set to **0** by default. |
+-----------------------+-----------------------+---------------------------------------------------+
Request
-------
None
Response
--------
See :ref:`Responses (Task) <en-us_topic_0022067714>`.
Example Request
---------------
.. code-block::
DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}
Example Response
----------------
None
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

13
ecs/api-ref/result/apis_recommended/disk_management/index.rst Normal file
View File

@ -0,0 +1,13 @@
.. _en-us_topic_0111860831:
===============
Disk Management
===============
.. toctree::
:maxdepth: 1
attaching_a_disk_to_an_ecs
detaching_an_evs_disk_from_an_ecs
querying_disk_attachment_of_an_ecs
querying_a_single_disk_attached_to_an_ecs

113
ecs/api-ref/result/apis_recommended/disk_management/querying_a_single_disk_attached_to_an_ecs.rst Normal file
View File

File diff suppressed because it is too large Load Diff

145
ecs/api-ref/result/apis_recommended/disk_management/querying_disk_attachment_of_an_ecs.rst Normal file
View File

File diff suppressed because it is too large Load Diff

96
ecs/api-ref/result/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst Normal file
View File

@ -0,0 +1,96 @@
.. _en-us_topic_0133622595:
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.
Constraints
-----------
- The ECS to be added has been stopped.
- Only KVM ECSs can be added.
- Only the anti-affinity policy is supported. ECSs in the same ECS group are deployed on different hosts, improving service reliability.
URI
---
POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action
:ref:`Table 1 <en-us_topic_0133622595__table042161072218>` describes the parameters in the URI.
.. _en-us_topic_0133622595__table042161072218:
.. table:: **Table 1** Parameter description
=============== ========= ===========================
Parameter Mandatory Description
=============== ========= ===========================
project_id Yes Specifies the project ID.
server_group_id Yes Specifies the ECS group ID.
=============== ========= ===========================
Request
-------
:ref:`Table 2 <en-us_topic_0133622595__table125642531229>` describes the request parameters.
.. _en-us_topic_0133622595__table125642531229:
.. table:: **Table 2** Request parameters
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+==============================================================================+
| add_member | Yes | Object | Specifies the information of the ECS to be added to an ECS group. |
| | | | |
| | | | For details, see :ref:`Table 3 <en-us_topic_0133622595__table532112610239>`. |
+-----------------+-----------------+-----------------+------------------------------------------------------------------------------+
.. _en-us_topic_0133622595__table532112610239:
.. table:: **Table 3** **add_member** parameters
============= ========= ====== =======================
Parameter Mandatory Type Description
============= ========= ====== =======================
instance_uuid Yes String Specifies the ECS UUID.
============= ========= ====== =======================
Response
--------
None
Example Request
---------------
.. code-block::
POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action
.. code-block::
{
"add_member": {
"instance_uuid":"34dac9a0-c4a7-457b-bab2-e2c696e0e401"
}
}
Example Response
----------------
Status code 200, indicating that the operation is successful
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

148
ecs/api-ref/result/apis_recommended/ecs_group_management/creating_an_ecs_group.rst Normal file
View File

File diff suppressed because it is too large Load Diff

59
ecs/api-ref/result/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst Normal file
View File

@ -0,0 +1,59 @@
.. _en-us_topic_0161097719:
Deleting an ECS Group
=====================
Function
--------
This API is used to delete an ECS group.
URI
---
DELETE /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}
:ref:`Table 1 <en-us_topic_0161097719__table1962114910318>` describes the parameters in the URI.
.. _en-us_topic_0161097719__table1962114910318:
.. table:: **Table 1** Parameter description
=============== ========= =============================
Parameter Mandatory Description
=============== ========= =============================
project_id Yes Specifies the project ID.
server_group_id Yes Specifies the ECS group UUID.
=============== ========= =============================
Request Parameters
------------------
None
Response Parameters
-------------------
None
Example Request
---------------
.. code-block::
DELETE https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}
Example Response
----------------
None
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

15
ecs/api-ref/result/apis_recommended/ecs_group_management/index.rst Normal file
View File

@ -0,0 +1,15 @@
.. _en-us_topic_0161097717:
====================
ECS Group Management
====================
.. toctree::
:maxdepth: 1
creating_an_ecs_group
deleting_an_ecs_group
adding_an_ecs_to_an_ecs_group
removing_an_ecs_from_an_ecs_group
querying_ecs_groups
querying_details_about_an_ecs_group

97
ecs/api-ref/result/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst Normal file
View File

@ -0,0 +1,97 @@
.. _en-us_topic_0175597847:
Querying Details About an ECS Group
===================================
Function
--------
This API is used to query details bout an ECS group.
URI
---
GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}
:ref:`Table 1 <en-us_topic_0175597847__table050833691012>` describes the parameters in the URI.
.. _en-us_topic_0175597847__table050833691012:
.. table:: **Table 1** Parameter description
=============== ========= ============================
Parameter Mandatory Description
=============== ========= ============================
project_id Yes Specifies the project ID.
server_group_id Yes Specifies an ECS group UUID.
=============== ========= ============================
Request
-------
None
Response
--------
:ref:`Table 2 <en-us_topic_0175597847__table4683214181116>` describes the response parameters.
.. _en-us_topic_0175597847__table4683214181116:
.. table:: **Table 2** Response parameters
+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+==============+========+=====================================================================================================================================+
| server_group | Object | Specifies the ECS group information. For details, see :ref:`Table 3 <en-us_topic_0175597847__en-us_topic_0057973159_table5520021>`. |
+--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+
.. _en-us_topic_0175597847__en-us_topic_0057973159_table5520021:
.. table:: **Table 3** **server_group** parameters
+-----------+------------------+-------------------------------------------------------+
| Parameter | Type | Description |
+===========+==================+=======================================================+
| id | String | Specifies an ECS group UUID. |
+-----------+------------------+-------------------------------------------------------+
| name | String | Specifies the ECS group name. |
+-----------+------------------+-------------------------------------------------------+
| policies | Array of strings | Specifies the policies associated with the ECS group. |
+-----------+------------------+-------------------------------------------------------+
| members | Array of strings | Specifies the ECS contained in an ECS group. |
+-----------+------------------+-------------------------------------------------------+
| metadata | Object | Specifies the ECS group metadata. |
+-----------+------------------+-------------------------------------------------------+
Example Request
---------------
.. code-block::
GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}
Example Response
----------------
.. code-block::
{
"server_group": {
"id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9",
"name": "test",
"policies": ["anti-affinity"],
"members": [],
"metadata": {}
}
}
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

134
ecs/api-ref/result/apis_recommended/ecs_group_management/querying_ecs_groups.rst Normal file
View File

File diff suppressed because it is too large Load Diff

90
ecs/api-ref/result/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst Normal file
View File

@ -0,0 +1,90 @@
.. _en-us_topic_0133622596:
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.
Constraints
-----------
Only the anti-affinity policy is supported. ECSs in the same ECS group are deployed on different hosts, improving service reliability.
URI
---
POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action
:ref:`Table 1 <en-us_topic_0133622596__table10769113472410>` describes the parameters in the URI.
.. _en-us_topic_0133622596__table10769113472410:
.. table:: **Table 1** Parameter description
=============== ========= ===========================
Parameter Mandatory Description
=============== ========= ===========================
project_id Yes Specifies the project ID.
server_group_id Yes Specifies the ECS group ID.
=============== ========= ===========================
Request
-------
:ref:`Table 2 <en-us_topic_0133622596__table45526613251>` describes the request parameters.
.. _en-us_topic_0133622596__table45526613251:
.. table:: **Table 2** Request parameters
+---------------+-----------+--------+-----------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===============+===========+========+=======================================================================+
| remove_member | Yes | Object | Specifies the information of the ECS to be removed from an ECS group. |
+---------------+-----------+--------+-----------------------------------------------------------------------+
.. table:: **Table 3** **remove_member** parameters
============= ========= ====== =======================
Parameter Mandatory Type Description
============= ========= ====== =======================
instance_uuid Yes String Specifies the ECS UUID.
============= ========= ====== =======================
Response
--------
None
Example Request
---------------
.. code-block::
POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action
.. code-block::
{
"remove_member": {
"instance_uuid": "34dac9a0-c4a7-457b-bab2-e2c696e0e401"
}
}
Example Response
----------------
Status code 200, indicating that the operation is successful
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

11
ecs/api-ref/result/apis_recommended/flavor_management/index.rst Normal file
View File

@ -0,0 +1,11 @@
.. _en-us_topic_0112708160:
=================
Flavor Management
=================
.. toctree::
:maxdepth: 1
querying_details_about_flavors_and_extended_flavor_information
querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed

314
ecs/api-ref/result/apis_recommended/flavor_management/querying_details_about_flavors_and_extended_flavor_information.rst Normal file
View File

File diff suppressed because it is too large Load Diff

228
ecs/api-ref/result/apis_recommended/flavor_management/querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed.rst Normal file
View File

File diff suppressed because it is too large Load Diff

19
ecs/api-ref/result/apis_recommended/index.rst Normal file
View File

@ -0,0 +1,19 @@
.. _en-us_topic_0124385011:
==================
APIs (Recommended)
==================
.. toctree::
:maxdepth: 1
lifecycle_management/index
status_management/index
batch_operations/index
flavor_management/index
nic_management/index
disk_management/index
tenant_quota_management/index
task_status_management/index
tag_management/index
ecs_group_management/index

609
ecs/api-ref/result/apis_recommended/lifecycle_management/creating_an_ecs.rst Normal file
View File

File diff suppressed because it is too large Load Diff

128
ecs/api-ref/result/apis_recommended/lifecycle_management/deleting_ecss.rst Normal file
View File

File diff suppressed because it is too large Load Diff

11
ecs/api-ref/result/apis_recommended/lifecycle_management/index.rst Normal file
View File

@ -0,0 +1,11 @@
.. _en-us_topic_0020212657:
====================
Lifecycle Management
====================
.. toctree::
:maxdepth: 1
creating_an_ecs
deleting_ecss

110
ecs/api-ref/result/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

98
ecs/api-ref/result/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst Normal file
View File

@ -0,0 +1,98 @@
.. _en-us_topic_0020212665:
Deleting NICs from an ECS in a Batch
====================================
Function
--------
This API is used to uninstall and delete one or multiple NICs from an ECS.
Constraints
-----------
The primary NIC of an ECS has routing rules configured and cannot be deleted.
URI
---
POST /v1/{project_id}/cloudservers/{server_id}/nics/delete
:ref:`Table 1 <en-us_topic_0020212665__table42885739>` describes the parameters in the URI.
.. _en-us_topic_0020212665__table42885739:
.. table:: **Table 1** Parameter description
========== ========= =========================
Parameter Mandatory Description
========== ========= =========================
project_id Yes Specifies the project ID.
server_id Yes Specifies the ECS ID.
========== ========= =========================
Request
-------
:ref:`Table 2 <en-us_topic_0020212665__table35856517>` describes the request parameters.
.. _en-us_topic_0020212665__table35856517:
.. table:: **Table 2** Request parameters
+-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+==================+============================================================================================================+
| nics | Yes | Array of objects | Specifies the NICs to be deleted. For details, see :ref:`Table 3 <en-us_topic_0020212665__table43212049>`. |
+-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------+
.. _en-us_topic_0020212665__table43212049:
.. table:: **Table 3** **nics** field description
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+=================+=================+=================+==============================================================================================+
| id | Yes | String | Specifies the port ID of the NIC. |
| | | | |
| | | | .. note:: |
| | | | |
| | | | When the ID is the same as the ECS primary NIC ID, the system will return error code 403. |
+-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+
Response
--------
See :ref:`Responses (Task) <en-us_topic_0022067714>`.
Example Request
---------------
.. code-block::
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete
.. code-block::
{
"nics": [
{
"id": "d32019d3-bc6e-4319-9c1d-6722fc136a23"
}
]
}
Example Response
----------------
None
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

11
ecs/api-ref/result/apis_recommended/nic_management/index.rst Normal file
View File

@ -0,0 +1,11 @@
.. _en-us_topic_0124385012:
==============
NIC Management
==============
.. toctree::
:maxdepth: 1
adding_nics_to_an_ecs_in_a_batch
deleting_nics_from_an_ecs_in_a_batch

76
ecs/api-ref/result/apis_recommended/status_management/adding_an_ecs_to_the_monitoring_list.rst Normal file
View File

@ -0,0 +1,76 @@
.. _en-us_topic_0081529857:
Adding an ECS to the Monitoring List
====================================
Function
--------
This API is used to add an ECS to the monitoring list.
Ceilometer periodically collects monitoring data on the ECSs added to the monitoring list and reports the data to Cloud Eye. The data includes the platform version, CPU, memory, NICs, disks, and hardware version. For example, the plug-in of an SAP ECS periodically obtains monitoring data from Cloud Eye and reports the data to SAP in reports.
URI
---
POST /v1.0/servers/{server_id}/action
:ref:`Table 1 <en-us_topic_0081529857__table3713317418952>` describes the parameters in the URI.
.. _en-us_topic_0081529857__table3713317418952:
.. table:: **Table 1** Parameter description
========= ========= =====================
Parameter Mandatory Description
========= ========= =====================
server_id Yes Specifies the ECS ID.
========= ========= =====================
Request
-------
:ref:`Table 2 <en-us_topic_0081529857__table20892986181041>` describes the request parameters.
.. _en-us_topic_0081529857__table20892986181041:
.. table:: **Table 2** Request parameters
============== ========= ==== ==============================
Parameter Mandatory Type Description
============== ========= ==== ==============================
monitorMetrics Yes Null Enables monitoring on the ECS.
============== ========= ==== ==============================
Response
--------
None
Example Request
---------------
.. code-block::
POST https://{endpoint}/v1.0/servers/{server_id}/action
.. code-block::
{
"monitorMetrics" : null
}
Example Response
----------------
None
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

207
ecs/api-ref/result/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst Normal file
View File

File diff suppressed because it is too large Load Diff

104
ecs/api-ref/result/apis_recommended/status_management/cold_migrating_an_ecs.rst Normal file
View File

File diff suppressed because it is too large Load Diff

15
ecs/api-ref/result/apis_recommended/status_management/index.rst Normal file
View File

@ -0,0 +1,15 @@
.. _en-us_topic_0020212691:
=================
Status Management
=================
.. toctree::
:maxdepth: 1
reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed
changing_an_ecs_os_using_an_image_with_cloud-init_installed
querying_automatic_recovery_of_an_ecs
cold_migrating_an_ecs
modifying_the_specifications_of_an_ecs
adding_an_ecs_to_the_monitoring_list

94
ecs/api-ref/result/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst Normal file
View File

@ -0,0 +1,94 @@
.. _en-us_topic_0020212653:
Modifying the Specifications of an ECS
======================================
Function
--------
ECS specifications can be modified, for example, upgrading the vCPUs and memory, to meet service requirements. This API is used to modify ECS specifications.
An ECS flavor cannot be changed to certain flavors. For details, see :ref:`Querying the Target Flavors to Which an ECS Flavor Can Be Changed <en-us_topic_0110472767>`.
Constraints
-----------
- You can modify the ECS specifications only when the ECS is stopped.
URI
---
POST /v1/{project_id}/cloudservers/{server_id}/resize
:ref:`Table 1 <en-us_topic_0020212653__table29396722>` describes the parameters in the URI.
.. _en-us_topic_0020212653__table29396722:
.. table:: **Table 1** Parameter description
========== ========= =========================
Parameter Mandatory Description
========== ========= =========================
project_id Yes Specifies the project ID.
server_id Yes Specifies the ECS ID.
========== ========= =========================
Request
-------
:ref:`Table 2 <en-us_topic_0020212653__table6742880>` describes the request parameters.
.. _en-us_topic_0020212653__table6742880:
.. table:: **Table 2** Request parameters
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+===============================================================================================================================+
| resize | Yes | Object | Specifies the operation to modify ECS specifications. For details, see :ref:`Table 3 <en-us_topic_0020212653__table7657338>`. |
+-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------+
.. _en-us_topic_0020212653__table7657338:
.. table:: **Table 3** **resize** field description
+-----------+-----------+--------+------------------------------------------------------------+
| Parameter | Mandatory | Type | Description |
+===========+===========+========+============================================================+
| flavorRef | Yes | String | Specifies the flavor ID of the ECS after the modification. |
+-----------+-----------+--------+------------------------------------------------------------+
Response
--------
See :ref:`Responses (Task) <en-us_topic_0022067714>`.
Example Request
---------------
.. code-block::
POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/resize
.. code-block::
{
"resize": {
"flavorRef": "c3.15xlarge.2"
}
}
Example Response
----------------
None
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

78
ecs/api-ref/result/apis_recommended/status_management/querying_automatic_recovery_of_an_ecs.rst Normal file
View File

@ -0,0 +1,78 @@
.. _en-us_topic_0067600148:
Querying Automatic Recovery of an ECS
=====================================
Function
--------
This API is used to query automatic recovery configured for an ECS.
URI
---
GET /v1/{project_id}/cloudservers/{server_id}/autorecovery
:ref:`Table 1 <en-us_topic_0067600148__table32475667>` describes the parameters in the URI.
.. _en-us_topic_0067600148__table32475667:
.. table:: **Table 1** Parameter description
========== ========= =========================
Parameter Mandatory Description
========== ========= =========================
project_id Yes Specifies the project ID.
server_id Yes Specifies the ECS ID.
========== ========= =========================
Request
-------
None
Response
--------
:ref:`Table 2 <en-us_topic_0067600148__en-us_topic_0057973216_table30138413>` describes the response parameters.
.. _en-us_topic_0067600148__en-us_topic_0057973216_table30138413:
.. table:: **Table 2** Response parameters
+-----------------------+-----------------------+-------------------------------------------------------------------------------+
| Parameter | Type | Description |
+=======================+=======================+===============================================================================+
| support_auto_recovery | String | Queries automatic recovery configured for an ECS. |
| | | |
| | | - **true**: indicates that automatic recovery is configured for an ECS. |
| | | - **false**: indicates that automatic recovery is not configured for an ECS. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------+
Example Request
---------------
None
Example Response
----------------
.. code-block::
GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/autorecovery
.. code-block::
{
"support_auto_recovery": "true"
}
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

201
ecs/api-ref/result/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst Normal file
View File

File diff suppressed because it is too large Load Diff

120
ecs/api-ref/result/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

115
ecs/api-ref/result/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst Normal file
View File

File diff suppressed because it is too large Load Diff

15
ecs/api-ref/result/apis_recommended/tag_management/index.rst Normal file
View File

@ -0,0 +1,15 @@
.. _en-us_topic_0108433461:
==============
Tag Management
==============
.. toctree::
:maxdepth: 1
tag_types
adding_tags_to_an_ecs_in_a_batch
deleting_tags_from_an_ecs_in_a_batch
querying_ecss_by_tag
querying_project_tags
querying_tags_of_an_ecs

241
ecs/api-ref/result/apis_recommended/tag_management/querying_ecss_by_tag.rst Normal file
View File

File diff suppressed because it is too large Load Diff

108
ecs/api-ref/result/apis_recommended/tag_management/querying_project_tags.rst Normal file
View File

File diff suppressed because it is too large Load Diff

94
ecs/api-ref/result/apis_recommended/tag_management/querying_tags_of_an_ecs.rst Normal file
View File

@ -0,0 +1,94 @@
.. _en-us_topic_0167811967:
Querying Tags of an ECS
=======================
Function
--------
- This API is used to query the tags of a specified ECS.
- The Tag Management Service (TMS) uses this API to query all tags of an ECS.
URI
---
GET /v1/{project_id}/cloudservers/{server_id}/tags
:ref:`Table 1 <en-us_topic_0167811967__table194262014152810>` describes the parameters in the URI.
.. _en-us_topic_0167811967__table194262014152810:
.. table:: **Table 1** Parameter description
========== ========= =========================
Parameter Mandatory Description
========== ========= =========================
project_id Yes Specifies the project ID.
server_id Yes Specifies the ECS ID.
========== ========= =========================
Request
-------
None
Response
--------
:ref:`Table 2 <en-us_topic_0167811967__table1972264711286>` describes the response parameters.
.. _en-us_topic_0167811967__table1972264711286:
.. table:: **Table 2** Response parameters
+-----------+------------------+-----------------------------------------------------------------------------------------------+
| Parameter | Type | Description |
+===========+==================+===============================================================================================+
| tags | Array of objects | Specifies tags. For details, see :ref:`Table 3 <en-us_topic_0167811967__table1148911211295>`. |
+-----------+------------------+-----------------------------------------------------------------------------------------------+
.. _en-us_topic_0167811967__table1148911211295:
.. table:: **Table 3** **tags** field description
========= ====== ========================
Parameter Type Description
========= ====== ========================
key String Specifies the tag key.
value String Specifies the tag value.
========= ====== ========================
Example Request
---------------
.. code-block::
GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags
Example Response
----------------
.. code-block::
{
"tags": [
{
"key": "key1",
"value": "value1"
},
{
"key": "key2",
"value": "value3"
}
]
}
Returned Values
---------------
See :ref:`Returned Values for General Requests <en-us_topic_0022067716>`.
Error Codes
-----------
See :ref:`Error Codes <en-us_topic_0022067717>`.

14
ecs/api-ref/result/apis_recommended/tag_management/tag_types.rst Normal file
View File

@ -0,0 +1,14 @@
.. _en-us_topic_0167811962:
Tag Types
=========
Tag management APIs are classified as the APIs for one-dimensional (1D) tags and the APIs for two-dimensional (2D) tags.
- A 1D tag contains a string. All APIs for 1D tags are native OpenStack APIs. For details, see section :ref:`Tag Management <en-us_topic_0108433460>`.
- A 2D tag consists of a key and a value. All APIs for 2D tags are ECS APIs. For details, see this section.
.. note::
- Use the APIs of the same type to add, delete, modify, or query tags.
- 2D tags are recommended.

10
ecs/api-ref/result/apis_recommended/task_status_management/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _en-us_topic_0022225397:
======================
Task Status Management
======================
.. toctree::
:maxdepth: 1
querying_task_execution_status

194
ecs/api-ref/result/apis_recommended/task_status_management/querying_task_execution_status.rst Normal file
View File

File diff suppressed because it is too large Load Diff

10
ecs/api-ref/result/apis_recommended/tenant_quota_management/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _en-us_topic_0020212673:
=======================
Tenant Quota Management
=======================
.. toctree::
:maxdepth: 1
querying_tenant_quotas

148
ecs/api-ref/result/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst Normal file
View File

File diff suppressed because it is too large Load Diff

83
ecs/api-ref/result/appendix/ecs_monitoring_metrics.rst Normal file
View File

@ -0,0 +1,83 @@
.. _en-us_topic_0022067719:
ECS Monitoring Metrics
======================
Function
--------
This section describes metrics reported by ECS to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metrics of the monitored object and alarms generated for ECS.
Namespace
---------
SYS.ECS
Metrics
-------
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| Metric | Name | Description | Value Range | Remarks |
+=========================================+=======================+============================================================================================================================================+=============+========================================================================+
| cpu_util | CPU Usage | This metric is used to show CPU usages (%) of monitored objects. | 0% to 100% | ECS monitored |
| | | | | |
| | | | | .. note:: |
| | | | | |
| | | | | The metrics collected using OTC Tools are accurate. |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| mem_util | Memory Usage | This metric is used to show memory usages (%) of monitored objects. | 0% to 100% | ECS monitored |
| | | | | |
| | | | | .. note:: |
| | | | | |
| | | | | This metric is unavailable if the image has no OTC Tools installed. |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| disk_util_inband | Disks Usage | This metric is used to show disk usages (%) of monitored objects. | 0% to 100% | ECS monitored |
| | | | | |
| | | | | .. note:: |
| | | | | |
| | | | | This metric is unavailable if the image has no OTC Tools installed. |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| disk_read_bytes_rate | Disk Read Bandwidth | This metric is used to show the number of bytes read from the monitored object per second (byte/s). | ≥ 0 | ECS monitored |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| disk_write_bytes_rate | Disk Write Bandwidth | This metric is used to show the number of bytes written to the monitored object per second (byte/s). | ≥ 0 | ECS monitored |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| disk_read_requests_rate | Disk Read IOPS | This metric is used to show the number of read requests sent to the monitored object per second (requests/second). | ≥ 0 | ECS monitored |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| disk_write_requests_rate | Disk Write IOPS | This metric is used to show the number of write requests sent to the monitored object per second (requests/second). | ≥ 0 | ECS monitored |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| network_incoming_bytes_rate_inband | Inband Incoming Rate | This metric is used to show the number of incoming bytes received by the monitored object per second (byte/s). | ≥ 0 | ECS monitored |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| network_outgoing_bytes_rate_inband | Inband Outgoing Rate | This metric is used to show the number of outgoing bytes sent by the monitored object per second (byte/s). | ≥ 0 | ECS monitored |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| network_incoming_bytes_aggregate_rate | Outband Incoming Rate | This metric is used to show the number of incoming bytes received by the monitored object per second (byte/s) at the virtualization layer. | ≥ 0 | ECS monitored |
| | | | | |
| | | | | .. note:: |
| | | | | |
| | | | | This metric is unavailable if SR-IOV is enabled. |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| network_outgoing_bytes\_ aggregate_rate | Outband Outgoing Rate | This metric is used to show the number of outgoing bytes sent by the monitored object per second (byte/s) at the virtualization layer. | ≥ 0 | ECS monitored |
| | | | | |
| | | | | .. note:: |
| | | | | |
| | | | | This metric is unavailable if SR-IOV is enabled. |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
| ib_card_state | InfiniBand NIC status | This metric is used to monitor the status of an InfiniBand NIC on a high-performance h2 ECS to ensure proper InfiniBand NIC running. | 0 or 1 | ECS monitored |
| | | | | |
| | | The system periodically checks the NIC status and returns check results using value **0** or **1**. | | .. note:: |
| | | | | |
| | | - **0**: The system is running properly. That is, the InfiniBand NIC is functional. | | Only Mellanox EDR 100 GB single-port InfiniBand NICs are supported. |
| | | - **1**: The system is not running properly. That is, the InfiniBand NIC malfunctions. | | |
+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+
.. note::
The image based on which the target ECS is created must have OTC Tools installed. Otherwise, the **Memory Usage** and **Disk Usage** metrics are unavailable. For details about how to install the OTC Tools, visit https://github.com/UVP-Tools/UVP-Tools/.
Dimension
---------
=========== =====================
Key Value
=========== =====================
instance_id Specifies the ECS ID.
=========== =====================

181
ecs/api-ref/result/appendix/ecs_statuses.rst Normal file
View File

File diff suppressed because it is too large Load Diff

319
ecs/api-ref/result/appendix/error_codes.rst Normal file
View File

File diff suppressed because it is too large Load Diff

29
ecs/api-ref/result/appendix/http_status_codes.rst Normal file
View File

@ -0,0 +1,29 @@
.. _en-us_topic_0065827313:
HTTP Status Codes
=================
================== ===========
Normal Status Code Description
================== ===========
200 OK
201 Created
202 Accepted
204 No Content
================== ===========
================= ========================
Error Status Code Description
================= ========================
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
405 Method Not Allowed
409 Conflict
413 Request Entity Too Large
415 Unsupported Media Type
500 Internal Server Error
501 Not Implemented
503 Service Unavailable
================= ========================

Some files were not shown because too many files have changed in this diff Show More