From fb8cbefbcb6aca572747b01980df809af91402ed Mon Sep 17 00:00:00 2001 From: Gregor Riepl Date: Mon, 11 Jan 2021 14:49:11 +0100 Subject: [PATCH 1/3] Replaced obsolete apidocs links --- source/_global.rst | 2 +- source/adminguide/api.rst | 2 +- source/adminguide/locale/pot/api.pot | 2 +- .../adminguide/locale/pot/troubleshooting.pot | 2 +- .../locale/zh_CN/LC_MESSAGES/api.mo | Bin 5123 -> 5123 bytes .../locale/zh_CN/LC_MESSAGES/api.po | 4 ++-- .../zh_CN/LC_MESSAGES/troubleshooting.mo | Bin 17260 -> 17260 bytes .../zh_CN/LC_MESSAGES/troubleshooting.po | 6 +++--- source/adminguide/troubleshooting.rst | 2 +- .../conceptsandterminology/locale/pot/dev.pot | 2 +- .../locale/pot/developer_guide.pot | 4 ++-- .../conceptsandterminology/network_setup.rst | 2 +- source/developersguide/dev.rst | 4 ++-- source/developersguide/developer_guide.rst | 4 ++-- .../installguide/locale/pot/network_setup.pot | 2 +- .../locale/zh_CN/LC_MESSAGES/network_setup.mo | Bin 58589 -> 58589 bytes .../locale/zh_CN/LC_MESSAGES/network_setup.po | 4 ++-- 17 files changed, 21 insertions(+), 21 deletions(-) diff --git a/source/_global.rst b/source/_global.rst index 0af4614325..b53f524730 100644 --- a/source/_global.rst +++ b/source/_global.rst @@ -19,7 +19,7 @@ .. _CloudStack Installation Guide: http://docs.cloudstack.apache.org/projects/cloudstack-installation .. _CloudStack Administrator's Guide: http://docs.cloudstack.apache.org/projects/cloudstack-administration -.. _CloudStack Apidocs: http://cloudstack.apache.org/docs/api/ +.. _CloudStack Apidocs: https://cloudstack.apache.org/api.html .. |documentation_home| replace:: http://docs.cloudstack.apache.org/ diff --git a/source/adminguide/api.rst b/source/adminguide/api.rst index 19ad8da8cf..75df8a1f82 100644 --- a/source/adminguide/api.rst +++ b/source/adminguide/api.rst @@ -26,7 +26,7 @@ some indication of their state. The API has a REST-like query basis and returns results in XML or JSON. See `the Developer’s Guide `_ -and `the API Reference `_. +and `the API Reference `_. Provisioning and Authentication API diff --git a/source/adminguide/locale/pot/api.pot b/source/adminguide/locale/pot/api.pot index 70a1475155..f14ae2610b 100644 --- a/source/adminguide/locale/pot/api.pot +++ b/source/adminguide/locale/pot/api.pot @@ -38,7 +38,7 @@ msgstr "" #: ../../api.rst:31 # 1f57015e966c480795b141ba3f87b86a -msgid "See `the Developer’s Guide `_ and `the API Reference `_." +msgid "See `the Developer’s Guide `_ and `the API Reference `_." msgstr "" #: ../../api.rst:36 diff --git a/source/adminguide/locale/pot/troubleshooting.pot b/source/adminguide/locale/pot/troubleshooting.pot index c9164fa31f..979a74e127 100644 --- a/source/adminguide/locale/pot/troubleshooting.pot +++ b/source/adminguide/locale/pot/troubleshooting.pot @@ -173,7 +173,7 @@ msgstr "" #: ../../troubleshooting.rst:132 # 25bdb5c7a6a7454ea25d62c3f0a02c57 -msgid "For more information about the API syntax, see the API Reference at `http://cloudstack.apache.org/docs/api/ `_." +msgid "For more information about the API syntax, see the API Reference at `https://cloudstack.apache.org/api.html `_." msgstr "" #: ../../troubleshooting.rst:137 diff --git a/source/adminguide/locale/zh_CN/LC_MESSAGES/api.mo b/source/adminguide/locale/zh_CN/LC_MESSAGES/api.mo index c4abbf3307b1812d6e3de5ac881cf6c6b84fe013..4028a5a669ce149616ae65d709317a509ad867c7 100644 GIT binary patch delta 47 ocmZqHXx7-^!_HVd*@s<{Be5V;FQX(kXLBC=Gfs4|GQnOZ0Bbf6Y5)KL delta 45 ncmZqHXx7-^!#>%UU6L~;Ke<>xu^>}_a~}IMPBfu1!Coc+Q(+Fy diff --git a/source/adminguide/locale/zh_CN/LC_MESSAGES/api.po b/source/adminguide/locale/zh_CN/LC_MESSAGES/api.po index 8140b9430e..2f5ca2b844 100644 --- a/source/adminguide/locale/zh_CN/LC_MESSAGES/api.po +++ b/source/adminguide/locale/zh_CN/LC_MESSAGES/api.po @@ -50,8 +50,8 @@ msgstr "API基于类似REST的查询, 可以返回XML或JSON格式." msgid "" "See `the Developer’s Guide " "`_ " -"and `the API Reference `_." -msgstr "参阅 `开发指南 `_ 和 `参考API `_." +"and `the API Reference `_." +msgstr "参阅 `开发指南 `_ 和 `参考API `_." # de3d35bb699f45f495251ceb69a2c238 #: ../../api.rst:36 diff --git a/source/adminguide/locale/zh_CN/LC_MESSAGES/troubleshooting.mo b/source/adminguide/locale/zh_CN/LC_MESSAGES/troubleshooting.mo index e0f72018347a7c47ae3ae0ee24e0b3639df803bc..ae671c527fc9f864de78652c9dc4fb7c376670fb 100644 GIT binary patch delta 89 zcmaFU#`va<86 delta 55 rcmaFU#`vaS#3FoKd!jf1U}qI1 diff --git a/source/adminguide/locale/zh_CN/LC_MESSAGES/troubleshooting.po b/source/adminguide/locale/zh_CN/LC_MESSAGES/troubleshooting.po index cd464f779b..b042c29a71 100644 --- a/source/adminguide/locale/zh_CN/LC_MESSAGES/troubleshooting.po +++ b/source/adminguide/locale/zh_CN/LC_MESSAGES/troubleshooting.po @@ -205,9 +205,9 @@ msgstr "使用restartNetwork API（参数cleanup=false）重建丢失的虚拟 #: ../../troubleshooting.rst:132 msgid "" "For more information about the API syntax, see the API Reference at " -"`http://cloudstack.apache.org/docs/api/ " -"`_." -msgstr "关于更多的API语法信息，参见API参考`http://cloudstack.apache.org/docs/api/ `_。" +"`https://cloudstack.apache.org/api.html " +"`_." +msgstr "关于更多的API语法信息，参见API参考`https://cloudstack.apache.org/api.html `_。" # d1a32a2023024c72907911b8c7757cae #: ../../troubleshooting.rst:137 diff --git a/source/adminguide/troubleshooting.rst b/source/adminguide/troubleshooting.rst index 667c727f2a..e519257652 100644 --- a/source/adminguide/troubleshooting.rst +++ b/source/adminguide/troubleshooting.rst @@ -130,7 +130,7 @@ cleanup=false parameter. For more information about redundant router setup, see Creating a New Network Offering. For more information about the API syntax, see the API Reference at -`http://cloudstack.apache.org/docs/api/ `_. +`https://cloudstack.apache.org/api.html `_. Maintenance mode not working on vCenter diff --git a/source/conceptsandterminology/locale/pot/dev.pot b/source/conceptsandterminology/locale/pot/dev.pot index e97c9d1266..da7742a6ed 100644 --- a/source/conceptsandterminology/locale/pot/dev.pot +++ b/source/conceptsandterminology/locale/pot/dev.pot @@ -103,7 +103,7 @@ msgstr "" #: ../../dev.rst:64 # bcdf9d282f994c9e9cfc62a64151533a -msgid "`http://cloudstack.apache.org/docs/api/ `__" +msgid "`https://cloudstack.apache.org/api.html `__" msgstr "" #: ../../dev.rst:68 diff --git a/source/conceptsandterminology/locale/pot/developer_guide.pot b/source/conceptsandterminology/locale/pot/developer_guide.pot index 2e6995bd0a..0c8252b250 100644 --- a/source/conceptsandterminology/locale/pot/developer_guide.pot +++ b/source/conceptsandterminology/locale/pot/developer_guide.pot @@ -443,12 +443,12 @@ msgstr "" #: ../../developer_guide.rst:460 # 7c104d4cd0fe475e863b91f53449a5c5 -msgid "The CloudStack API is a query based API using http that return results in XML or JSON. It is used to implement the default web UI. This API is not a standard like `OGF OCCI `__ or `DMTF CIMI `__ but is easy to learn. Mapping exists between the AWS API and the CloudStack API as will be seen in the next section. Recently a Google Compute Engine interface was also developed that maps the GCE REST API to the CloudStack API described here. The API `docs `__ are a good start to learn the extent of the API. Multiple clients exist on `github `__ to use this API, you should be able to find one in your favorite language. The reference documentation for the API and changes that might occur from version to version is availble `on-line `__. This short section is aimed at providing a quick summary to give you a base understanding of how to use this API. As a quick start, a good way to explore the API is to navigate the dashboard with a firebug console (or similar developer console) to study the queries." +msgid "The CloudStack API is a query based API using http that return results in XML or JSON. It is used to implement the default web UI. This API is not a standard like `OGF OCCI `__ or `DMTF CIMI `__ but is easy to learn. Mapping exists between the AWS API and the CloudStack API as will be seen in the next section. Recently a Google Compute Engine interface was also developed that maps the GCE REST API to the CloudStack API described here. The API `docs `__ are a good start to learn the extent of the API. Multiple clients exist on `github `__ to use this API, you should be able to find one in your favorite language. The reference documentation for the API and changes that might occur from version to version is availble `on-line `__. This short section is aimed at providing a quick summary to give you a base understanding of how to use this API. As a quick start, a good way to explore the API is to navigate the dashboard with a firebug console (or similar developer console) to study the queries." msgstr "" #: ../../developer_guide.rst:481 # 0bcb8dd851254f9b9b0240917b405d84 -msgid "In a succint statement, the CloudStack query API can be used via http GET requests made against your cloud endpoint (e.g http://localhost:8080/client/api). The API name is passed using the ``command`` key and the various parameters for this API call are passed as key value pairs. The request is signed using the access key and secret key of the user making the call. Some calls are synchronous while some are asynchronous, this is documented in the API `docs `__. Asynchronous calls return a ``jobid``, the status and result of a job can be queried with the ``queryAsyncJobResult`` call. Let's get started and give an example of calling the ``listUsers`` API in Python." +msgid "In a succint statement, the CloudStack query API can be used via http GET requests made against your cloud endpoint (e.g http://localhost:8080/client/api). The API name is passed using the ``command`` key and the various parameters for this API call are passed as key value pairs. The request is signed using the access key and secret key of the user making the call. Some calls are synchronous while some are asynchronous, this is documented in the API `docs `__. Asynchronous calls return a ``jobid``, the status and result of a job can be queried with the ``queryAsyncJobResult`` call. Let's get started and give an example of calling the ``listUsers`` API in Python." msgstr "" #: ../../developer_guide.rst:493 diff --git a/source/conceptsandterminology/network_setup.rst b/source/conceptsandterminology/network_setup.rst index 118ce35bdf..0abd15aa21 100644 --- a/source/conceptsandterminology/network_setup.rst +++ b/source/conceptsandterminology/network_setup.rst @@ -1003,7 +1003,7 @@ To set up the integration between CloudStack and Traffic Sentinel: Traffic Sentinel as protocol + host + port (optional); for example, http://10.147.28.100:8080. For the addTrafficMonitor command syntax, see the API Reference at `API Documentation - `_. + `_. For information about how to call the CloudStack API, see the Developer’s Guide at the CloudStack API Developer's Guide :ref:`the-api` diff --git a/source/developersguide/dev.rst b/source/developersguide/dev.rst index 9aa69adfc5..8733e086f3 100644 --- a/source/developersguide/dev.rst +++ b/source/developersguide/dev.rst @@ -64,8 +64,8 @@ API Reference Documentation You can find all the API reference documentation at the below site: -`http://cloudstack.apache.org/docs/api/ -`__ +`https://cloudstack.apache.org/api.html +`__ Making API Requests diff --git a/source/developersguide/developer_guide.rst b/source/developersguide/developer_guide.rst index 01aa636f04..4add3fb8f3 100644 --- a/source/developersguide/developer_guide.rst +++ b/source/developersguide/developer_guide.rst @@ -346,7 +346,7 @@ Mapping exists between the AWS API and the CloudStack API as will be seen in the next section. Recently a Google Compute Engine interface was also developed that maps the GCE REST API to the CloudStack API described here. The API -`docs `__ are a good start to +`docs `__ are a good start to learn the extent of the API. Multiple clients exist on `github `__ to use this API, you should be able to find one in your favorite @@ -365,7 +365,7 @@ http://localhost:8080/client/api). The API name is passed using the as key value pairs. The request is signed using the access key and secret key of the user making the call. Some calls are synchronous while some are asynchronous, this is documented in the API -`docs `__. Asynchronous calls +`docs `__. Asynchronous calls return a ``jobid``, the status and result of a job can be queried with the ``queryAsyncJobResult`` call. Let's get started and give an example of calling the ``listUsers`` API in Python. diff --git a/source/installguide/locale/pot/network_setup.pot b/source/installguide/locale/pot/network_setup.pot index de25f6396a..cd759b0445 100644 --- a/source/installguide/locale/pot/network_setup.pot +++ b/source/installguide/locale/pot/network_setup.pot @@ -1591,7 +1591,7 @@ msgstr "" #: ../../network_setup.rst:1001 # 99d0d664da654239ad897c4d6eb6b08e -msgid "On CloudStack, add the Traffic Sentinel host by calling the CloudStack API command addTrafficMonitor. Pass in the URL of the Traffic Sentinel as protocol + host + port (optional); for example, http://10.147.28.100:8080. For the addTrafficMonitor command syntax, see the API Reference at `API Documentation `_." +msgid "On CloudStack, add the Traffic Sentinel host by calling the CloudStack API command addTrafficMonitor. Pass in the URL of the Traffic Sentinel as protocol + host + port (optional); for example, http://10.147.28.100:8080. For the addTrafficMonitor command syntax, see the API Reference at `API Documentation `_." msgstr "" #: ../../network_setup.rst:1008 diff --git a/source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.mo b/source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.mo index 62eeffe0f27642b191ecade37eeef2eed9828882..803c4b7a322e15eabd5ad66d1635d2683d29e560 100644 GIT binary patch delta 55 ucmcb6lKJjQ<_%E+EX7v(`jgj5iE$(rWa?#<`_." -msgstr "在CloudStack中，使用API中的addTrafficMonitor命令添加流量哨兵主机。传入的流量哨兵URL类似于protocol + host + port (可选)；例如， http://10.147.28.100:8080。 关于addTrafficMonitor命令用法，请参阅API文档 `API Documentation `_." +"Documentation `_." +msgstr "在CloudStack中，使用API中的addTrafficMonitor命令添加流量哨兵主机。传入的流量哨兵URL类似于protocol + host + port (可选)；例如， http://10.147.28.100:8080。 关于addTrafficMonitor命令用法，请参阅API文档 `API Documentation `_." # 382c1696b18d4f25a2e2b5b7cb142225 #: ../../network_setup.rst:1008 From 5a97945e950bf078b8adfbc67ac270c370ce384a Mon Sep 17 00:00:00 2001 From: Gregor Riepl Date: Mon, 11 Jan 2021 14:49:32 +0100 Subject: [PATCH 2/3] Replaced apidocs http links with https --- source/adminguide/virtual_machines/user-data.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/adminguide/virtual_machines/user-data.rst b/source/adminguide/virtual_machines/user-data.rst index 24285e9246..4f5208e13c 100644 --- a/source/adminguide/virtual_machines/user-data.rst +++ b/source/adminguide/virtual_machines/user-data.rst @@ -20,9 +20,9 @@ User-Data and Meta-Data CloudStack provides APIs to attach up to 32KB of user-data to a deployed VM. There are two CloudStack APIs that can be used to store user-data: -`deployVirtualMachine `_ +`deployVirtualMachine `_ and -`updateVirtualMachine `_ +`updateVirtualMachine `_ They both support the parameter ``userdata=``. The value for this parameter must be a `base64 `_-encoded multi-part MIME message. See further below for an example of what this should look like. @@ -89,7 +89,7 @@ Fetching user-data via the API ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ User-data is not included with the normal VM state for historic reasons. -To read out the base64-encoded user-data via the API, use the `getVirtualMachineUserData `_ +To read out the base64-encoded user-data via the API, use the `getVirtualMachineUserData `_ API call: .. code:: bash From 7b1475049720436123d452fa55fa291c9210fbd3 Mon Sep 17 00:00:00 2001 From: Gregor Riepl Date: Fri, 15 Jan 2021 17:54:44 +0100 Subject: [PATCH 3/3] Fixed overzealous api link search&replace --- source/conceptsandterminology/network_setup.rst | 2 +- source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.po | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/source/conceptsandterminology/network_setup.rst b/source/conceptsandterminology/network_setup.rst index 0abd15aa21..e78a450a60 100644 --- a/source/conceptsandterminology/network_setup.rst +++ b/source/conceptsandterminology/network_setup.rst @@ -1003,7 +1003,7 @@ To set up the integration between CloudStack and Traffic Sentinel: Traffic Sentinel as protocol + host + port (optional); for example, http://10.147.28.100:8080. For the addTrafficMonitor command syntax, see the API Reference at `API Documentation - `_. + `_. For information about how to call the CloudStack API, see the Developer’s Guide at the CloudStack API Developer's Guide :ref:`the-api` diff --git a/source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.po b/source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.po index ec5a304446..8957f5d8e4 100644 --- a/source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.po +++ b/source/installguide/locale/zh_CN/LC_MESSAGES/network_setup.po @@ -1915,8 +1915,8 @@ msgid "" "command addTrafficMonitor. Pass in the URL of the Traffic Sentinel as " "protocol + host + port (optional); for example, http://10.147.28.100:8080. " "For the addTrafficMonitor command syntax, see the API Reference at `API " -"Documentation `_." -msgstr "在CloudStack中，使用API中的addTrafficMonitor命令添加流量哨兵主机。传入的流量哨兵URL类似于protocol + host + port (可选)；例如， http://10.147.28.100:8080。 关于addTrafficMonitor命令用法，请参阅API文档 `API Documentation `_." +"Documentation `_." +msgstr "在CloudStack中，使用API中的addTrafficMonitor命令添加流量哨兵主机。传入的流量哨兵URL类似于protocol + host + port (可选)；例如， http://10.147.28.100:8080。 关于addTrafficMonitor命令用法，请参阅API文档 `API Documentation `_." # 382c1696b18d4f25a2e2b5b7cb142225 #: ../../network_setup.rst:1008