forked from docs/cloud-connect
Changes to ccn_api-ref from docs/doc-exports#1451 (CCN API 20250121 version)
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com> Co-authored-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com> Co-committed-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>
This commit is contained in:
100
api-ref/source/appendix/error_codes.rst
Normal file
100
api-ref/source/appendix/error_codes.rst
Normal file
File diff suppressed because it is too large
Load Diff
18
api-ref/source/appendix/index.rst
Normal file
18
api-ref/source/appendix/index.rst
Normal file
@ -0,0 +1,18 @@
|
||||
:original_name: cc_01_0024.html
|
||||
|
||||
.. _cc_01_0024:
|
||||
|
||||
Appendix
|
||||
========
|
||||
|
||||
- :ref:`Status Codes <cc_01_0025>`
|
||||
- :ref:`Error Codes <errorcode>`
|
||||
- :ref:`Obtaining a Project ID <cc_01_0027>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
status_codes
|
||||
error_codes
|
||||
obtaining_a_project_id
|
||||
72
api-ref/source/appendix/obtaining_a_project_id.rst
Normal file
72
api-ref/source/appendix/obtaining_a_project_id.rst
Normal file
@ -0,0 +1,72 @@
|
||||
:original_name: cc_01_0027.html
|
||||
|
||||
.. _cc_01_0027:
|
||||
|
||||
Obtaining a Project ID
|
||||
======================
|
||||
|
||||
Scenarios
|
||||
---------
|
||||
|
||||
A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:
|
||||
|
||||
- :ref:`Obtain the Project ID by Calling an API <cc_01_0027__en-us_topic_0121673684_section86806471133>`
|
||||
- :ref:`Obtain the Project ID from the Console <cc_01_0027__en-us_topic_0121673684_section32975495318>`
|
||||
|
||||
.. _cc_01_0027__en-us_topic_0121673684_section86806471133:
|
||||
|
||||
Obtain the Project ID by Calling an API
|
||||
---------------------------------------
|
||||
|
||||
You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.
|
||||
|
||||
The API used to obtain a project ID is GET https://{Endpoint}/v3/projects. {Endpoint} is the IAM endpoint and can be obtained from `Regions and Endpoints <https://docs.otc.t-systems.com/regions-and-endpoints/index.html>`__.
|
||||
|
||||
The following is an example response. The value of **id** is the project ID.
|
||||
|
||||
.. code-block::
|
||||
|
||||
{
|
||||
"projects": [
|
||||
{
|
||||
"domain_id": "65ewtrgaggshhk1223245sghjlse684b",
|
||||
"is_domain": false,
|
||||
"parent_id": "65ewtrgaggshhk1223245sghjlse684b",
|
||||
"name": "project_name",
|
||||
"description": "",
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects/a4adasfjljaaaakla12334jklga9sasfg"
|
||||
},
|
||||
"id": "a4adasfjljaaaakla12334jklga9sasfg",
|
||||
"enabled": true
|
||||
}
|
||||
],
|
||||
"links": {
|
||||
"next": null,
|
||||
"previous": null,
|
||||
"self": "https://www.example.com/v3/projects"
|
||||
}
|
||||
}
|
||||
|
||||
.. _cc_01_0027__en-us_topic_0121673684_section32975495318:
|
||||
|
||||
Obtain a Project ID from the Console
|
||||
------------------------------------
|
||||
|
||||
A project ID needs to be specified in the URIs of some APIs. Therefore, you need to obtain the project ID before calling APIs. The following procedure describes how to obtain a project ID:
|
||||
|
||||
#. Log in to the management console.
|
||||
|
||||
#. Click the username and select **My Credentials** from the drop-down list.
|
||||
|
||||
On the **My Credentials** page, view project IDs in the project list.
|
||||
|
||||
|
||||
.. figure:: /_static/images/en-us_image_0000001508295281.png
|
||||
:alt: **Figure 1** Viewing project IDs
|
||||
|
||||
**Figure 1** Viewing project IDs
|
||||
|
||||
In multi-project scenarios, expand the region, and obtain your sub-project ID from the **Project ID** column.
|
||||
56
api-ref/source/appendix/status_codes.rst
Normal file
56
api-ref/source/appendix/status_codes.rst
Normal file
@ -0,0 +1,56 @@
|
||||
:original_name: cc_01_0025.html
|
||||
|
||||
.. _cc_01_0025:
|
||||
|
||||
Status Codes
|
||||
============
|
||||
|
||||
- Normal
|
||||
|
||||
.. table:: **Table 1** Status codes for successful requests
|
||||
|
||||
+-------------+----------------+-------------------------------------------------------+
|
||||
| Status Code | Returned Value | Description |
|
||||
+=============+================+=======================================================+
|
||||
| 200 | OK | Normal response for the POST, GET, and PUT operations |
|
||||
+-------------+----------------+-------------------------------------------------------+
|
||||
| 201 | Created | Normal response code for POST operations |
|
||||
+-------------+----------------+-------------------------------------------------------+
|
||||
| 204 | No Content | Normal response code for DELETE operations |
|
||||
+-------------+----------------+-------------------------------------------------------+
|
||||
|
||||
- Abnormal
|
||||
|
||||
.. table:: **Table 2** Status codes for failed requests
|
||||
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| Status Code | Returned Value | Description |
|
||||
+=============+===============================+============================================================================================+
|
||||
| 400 | Bad Request | The server failed to process the request. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 401 | Unauthorized | You must enter a username and password to access the requested page. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 403 | Forbidden | You are forbidden to access the requested page. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 404 | Not Found | The server could not find the requested page. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 405 | Method Not Allowed | You are not allowed to use the method specified in the request. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 406 | Not Acceptable | The response generated by the server could not be accepted by the client. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 407 | Proxy Authentication Required | You must use the proxy server for authentication so that the request can be processed. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 408 | Request Timeout | The request timed out. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 409 | Conflict | The request could not be processed due to a conflict. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 500 | Internal Server Error | Failed to complete the request because of an internal service error. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 501 | Not Implemented | Failed to complete the request because the server does not support the requested function. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 502 | Bad Gateway | Failed to complete the request because the server has received an invalid response. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 503 | Service Unavailable | Failed to complete the request because the service is unavailable. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
| 504 | Gateway Timeout | A gateway timeout error occurred. |
|
||||
+-------------+-------------------------------+--------------------------------------------------------------------------------------------+
|
||||
Reference in New Issue
Block a user