Update content

api-ref/source/api_usage_guidelines.rst

@@ -1,12 +0,0 @@
-:original_name: en-us_topic_0050065465.html
-
-.. _en-us_topic_0050065465:
-
-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 using JSON messages, with the 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>`__.

api-ref/source/api_v3/common_pools/index.rst

@@ -1,14 +0,0 @@
-:original_name: eip_apiv3_0300.html
-
-.. _eip_apiv3_0300:
-
-Common Pools
-============
-
--  :ref:`Querying Common Pools <listcommonpools>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_common_pools

api-ref/source/api_v3/eips/index.rst

@@ -1,20 +0,0 @@
-:original_name: eip_apiv3_0100.html
-
-.. _eip_apiv3_0100:
-
-EIPs
-====
-
--  :ref:`Querying All EIPs <listpublicipsv3>`
--  :ref:`Querying EIP Details <showpublicipv3>`
--  :ref:`Unbinding an EIP <disassociatepublicips>`
--  :ref:`Binding an EIP <associatepublicips>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_all_eips
-   querying_eip_details
-   unbinding_an_eip
-   binding_an_eip

api-ref/source/api_v3/index.rst

@@ -1,16 +0,0 @@
-:original_name: vpc_apiv3_0000.html
-
-.. _vpc_apiv3_0000:
-
-API V3
-======
-
--  :ref:`EIPs <eip_apiv3_0100>`
--  :ref:`Common Pools <eip_apiv3_0300>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   eips/index
-   common_pools/index

api-ref/source/apis/bandwidth/index.rst

@@ -1,18 +0,0 @@
-:original_name: vpc_bandwidth_0000.html
-
-.. _vpc_bandwidth_0000:
-
-Bandwidth
-=========
-
--  :ref:`Querying a Bandwidth <vpc_bandwidth_0001>`
--  :ref:`Querying Bandwidths <vpc_bandwidth_0002>`
--  :ref:`Updating a Bandwidth <vpc_bandwidth_0003>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_a_bandwidth
-   querying_bandwidths
-   updating_a_bandwidth

api-ref/source/apis/bandwidth_v2.0/deleting_a_shared_bandwidth.rst

@@ -1,73 +0,0 @@
-:original_name: vpc_sharebandwidth_0003.html
-
-.. _vpc_sharebandwidth_0003:
-
-Deleting a Shared Bandwidth
-===========================
-
-Function
---------
-
-This API is used to delete a shared bandwidth.
-
-URI
----
-
-DELETE /v2.0/{project_id}/bandwidths/{bandwidth_id}
-
-:ref:`Table 1 <vpc_sharebandwidth_0003__table45251091>` describes the parameters.
-
-.. _vpc_sharebandwidth_0003__table45251091:
-
-.. table:: **Table 1** Parameter description
-
-   +-----------------------+-----------------------+----------------------------------------------------------------------+
-   | Name                  | Mandatory             | Description                                                          |
-   +=======================+=======================+======================================================================+
-   | project_id            | Yes                   | Specifies the project ID.                                            |
-   +-----------------------+-----------------------+----------------------------------------------------------------------+
-   | bandwidth_id          | Yes                   | Specifies the bandwidth ID, which uniquely identifies the bandwidth. |
-   |                       |                       |                                                                      |
-   |                       |                       | Currently, only the shared bandwidth can be deleted.                 |
-   +-----------------------+-----------------------+----------------------------------------------------------------------+
-
-Request Message
----------------
-
--  Request parameter
-
-   None
-
--  Example request
-
-   .. code-block:: text
-
-      DELETE https://{Endpoint}/v2.0/{project_id}/bandwidths/{bandwidth_id}
-
-Response Message
-----------------
-
--  Response parameter
-
-   None
-
--  Example response
-
-   Or
-
-   .. code-block::
-
-      {
-             "code":"xxx",
-             "message":"xxxxx"
-      }
-
-Status Code
------------
-
-See :ref:`Status Codes <vpc_api_0002>`.
-
-Error Code
-----------
-
-See :ref:`Error Codes <vpc_api_0003>`.

api-ref/source/apis/bandwidth_v2.0/index.rst

@@ -1,20 +0,0 @@
-:original_name: vpc_sharebandwidth_0000.html
-
-.. _vpc_sharebandwidth_0000:
-
-Bandwidth (V2.0)
-================
-
--  :ref:`Assigning a Shared Bandwidth <vpc_sharebandwidth_0001>`
--  :ref:`Deleting a Shared Bandwidth <vpc_sharebandwidth_0003>`
--  :ref:`Adding an EIP to a Shared Bandwidth <vpc_sharebandwidth_0004>`
--  :ref:`Removing an EIP from a Shared Bandwidth <vpc_sharebandwidth_0005>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   assigning_a_shared_bandwidth
-   deleting_a_shared_bandwidth
-   adding_an_eip_to_a_shared_bandwidth
-   removing_an_eip_from_a_shared_bandwidth

api-ref/source/apis/eip/index.rst

@@ -1,22 +0,0 @@
-:original_name: vpc_eip_0000.html
-
-.. _vpc_eip_0000:
-
-EIP
-===
-
--  :ref:`Assigning an EIP <en-us_topic_0020090596>`
--  :ref:`Querying an EIP <vpc_eip_0002>`
--  :ref:`Querying EIPs <vpc_eip_0003>`
--  :ref:`Updating an EIP <vpc_eip_0004>`
--  :ref:`Releasing an EIP <vpc_eip_0005>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   assigning_an_eip
-   querying_an_eip
-   querying_eips
-   updating_an_eip
-   releasing_an_eip

api-ref/source/apis/eip/releasing_an_eip.rst

@@ -1,86 +0,0 @@
-:original_name: vpc_eip_0005.html
-
-.. _vpc_eip_0005:
-
-Releasing an EIP
-================
-
-Function
---------
-
-This API is used to release an EIP.
-
-.. note::
-
-   Note the following when you use EIPs of the Dedicated Load Balancer (**5_gray**) type:
-
-   -  In **eu-de**, EIPs of the Dedicated Load Balancer (**5_gray**) type cannot be assigned anymore. You can assign EIPs of the BGP (**5_bgp**) type.
-   -  Existing EIPs of the Dedicated Load Balancer (**5_gray**) type can be bound to dedicated or shared load balancers.
-
-      -  The EIP console cannot be used to bind EIPs to or unbind them from dedicated load balancers.
-      -  You can use APIs to bind EIPs to or unbind them from dedicated load balancers. For details, see `Binding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/binding_an_eip.html>`__ and `Unbinding an EIP <https://docs.otc.t-systems.com/elastic-ip/api-ref/api_v3/eips/unbinding_an_eip.html>`__.
-      -  EIPs of this type can be bound to or unbound from shared load balancers using the EIP console or APIs.
-      -  You are advised to bind BGP EIPs to or unbind them from dedicated load balancers.
-
-   -  Do not add EIPs of the dedicated load balancer type (**5_gray**) and other types to the same shared bandwidth. Otherwise, the bandwidth limit policy will not take effect.
-
-URI
----
-
-DELETE /v1/{project_id}/publicips/{publicip_id}
-
-:ref:`Table 1 <vpc_eip_0005__table45251091>` describes the parameters.
-
-.. _vpc_eip_0005__table45251091:
-
-.. table:: **Table 1** Parameter description
-
-   =========== ========= ==========================================
-   Name        Mandatory Description
-   =========== ========= ==========================================
-   project_id  Yes       Specifies the project ID.
-   publicip_id Yes       Specifies the unique identifier of an EIP.
-   =========== ========= ==========================================
-
-Request Message
----------------
-
--  Request parameter
-
-   None
-
--  Example request
-
-   .. code-block:: text
-
-      DELETE https://{Endpoint}/v1/{project_id}/publicips/{publicip_id}
-
-Response Message
-----------------
-
--  Response parameter
-
-   None
-
--  Example response
-
-   None
-
-   Or
-
-   .. code-block::
-
-      {
-             "code":"xxx",
-             "message":"xxxxx"
-      }
-
-Status Code
------------
-
-See :ref:`Status Codes <vpc_api_0002>`.
-
-Error Code
-----------
-
-See :ref:`Error Codes <vpc_api_0003>`.

api-ref/source/apis/eip_tag_management/deleting_an_eip_tag.rst

@@ -1,73 +0,0 @@
-:original_name: eip_tag_0003.html
-
-.. _eip_tag_0003:
-
-Deleting an EIP Tag
-===================
-
-Function
---------
-
-This API is used to delete an EIP tag.
-
-URI
----
-
-DELETE /v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
-
-:ref:`Table 1 <eip_tag_0003__table5716115334>` describes the parameters.
-
-.. _eip_tag_0003__table5716115334:
-
-.. table:: **Table 1** Parameter description
-
-   =========== ========= ==========================================
-   Name        Mandatory Description
-   =========== ========= ==========================================
-   project_id  Yes       Specifies the project ID.
-   publicip_id Yes       Specifies the unique identifier of an EIP.
-   key         Yes       Specifies the tag key.
-   =========== ========= ==========================================
-
-Request Message
----------------
-
--  Request parameter
-
-   None
-
--  Example request
-
-   .. code-block:: text
-
-      DELETE https://{Endpoint}/v2.0/{project_id}/publicips/{publicip_id}/tags/{key}
-
-Response Message
-----------------
-
--  Response parameter
-
-   None
-
--  Example response
-
-   None
-
-   Or
-
-   .. code-block::
-
-      {
-             "code":"xxx",
-             "message":"xxxxx"
-      }
-
-Status Code
------------
-
-See :ref:`Status Codes <vpc_api_0002>`.
-
-Error Code
-----------
-
-See :ref:`Error Codes <vpc_api_0003>`.

api-ref/source/apis/eip_tag_management/index.rst

@@ -1,24 +0,0 @@
-:original_name: eip_tag_0000.html
-
-.. _eip_tag_0000:
-
-EIP Tag Management
-==================
-
--  :ref:`Creating a Tag for an EIP <eip_tag_0001>`
--  :ref:`Querying EIP Tags <eip_tag_0002>`
--  :ref:`Deleting an EIP Tag <eip_tag_0003>`
--  :ref:`Batch Creating or Deleting EIP Tags <eip_tag_0004>`
--  :ref:`Querying EIPs by Tag <eip_tag_0005>`
--  :ref:`Querying EIP Tags in a Specified Project <eip_tag_0006>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   creating_a_tag_for_an_eip
-   querying_eip_tags
-   deleting_an_eip_tag
-   batch_creating_or_deleting_eip_tags
-   querying_eips_by_tag
-   querying_eip_tags_in_a_specified_project

api-ref/source/apis/floating_ip_address_ipv6/deleting_a_floating_ip_address.rst

@@ -1,50 +0,0 @@
-:original_name: vpc_ipv6_0005.html
-
-.. _vpc_ipv6_0005:
-
-Deleting a Floating IP Address
-==============================
-
-Function
---------
-
-This API is used to delete a floating IP address.
-
-URI
----
-
-DELETE /v2.0/eip/floatingips_v6/{floatingip_id}
-
-Request Message
----------------
-
--  Request parameter
-
-   None
-
--  Example request
-
-   .. code-block:: text
-
-      DELETE https://{Endpoint}/v2.0/eip/floatingips_v6/a95ec431-8473-463b-aede-34fb048ee3a7
-
-Response Message
-----------------
-
--  Response parameter
-
-   None
-
--  Example response
-
-   None
-
-Status Code
------------
-
-See :ref:`Status Codes <vpc_api_0002>`.
-
-Error Code
-----------
-
-See :ref:`Error Codes <vpc_api_0003>`.

api-ref/source/apis/floating_ip_address_ipv6/index.rst

@@ -1,22 +0,0 @@
-:original_name: vpc_ipv6_0000.html
-
-.. _vpc_ipv6_0000:
-
-Floating IP Address (IPv6)
-==========================
-
--  :ref:`Querying Floating IP Addresses <vpc_ipv6_0001>`
--  :ref:`Querying a Floating IP Address <vpc_ipv6_0002>`
--  :ref:`Assigning a Floating IP Address <vpc_ipv6_0003>`
--  :ref:`Updating a Floating IP Address <vpc_ipv6_0004>`
--  :ref:`Deleting a Floating IP Address <vpc_ipv6_0005>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_floating_ip_addresses
-   querying_a_floating_ip_address
-   assigning_a_floating_ip_address
-   updating_a_floating_ip_address
-   deleting_a_floating_ip_address

api-ref/source/apis/index.rst

@@ -1,46 +0,0 @@
-:original_name: vpc_api_0000.html
-
-.. _vpc_api_0000:
-
-APIs
-====
-
--  :ref:`Virtual Private Cloud <vpc_api01_0000>`
--  :ref:`Subnet <vpc_subnet01_0000>`
--  :ref:`EIP <vpc_eip_0000>`
--  :ref:`Floating IP Address (IPv6) <vpc_ipv6_0000>`
--  :ref:`Bandwidth <vpc_bandwidth_0000>`
--  :ref:`Bandwidth (V2.0) <vpc_sharebandwidth_0000>`
--  :ref:`Quota <vpc_quota_0000>`
--  :ref:`Private IP Address <vpc_privateip_0000>`
--  :ref:`Security Group <vpc_sg01_0000>`
--  :ref:`VPC Peering Connection <vpc_peering_0000>`
--  :ref:`VPC Route <vpc_route_0000>`
--  :ref:`Route Table <vpc_apiroutetab_0000>`
--  :ref:`VPC Tag Management <vpc_tag_0000>`
--  :ref:`Subnet Tag Management <subnet_tag_0000>`
--  :ref:`EIP Tag Management <eip_tag_0000>`
--  :ref:`Querying IP Address Usage <vpc_natworkip_0000>`
--  :ref:`VPC Flow Log <vpc_flow_0000>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   virtual_private_cloud/index
-   subnet/index
-   eip/index
-   floating_ip_address_ipv6/index
-   bandwidth/index
-   bandwidth_v2.0/index
-   quota/index
-   private_ip_address/index
-   security_group/index
-   vpc_peering_connection/index
-   vpc_route/index
-   route_table/index
-   vpc_tag_management/index
-   subnet_tag_management/index
-   eip_tag_management/index
-   querying_ip_address_usage/index
-   vpc_flow_log/index

api-ref/source/apis/private_ip_address/deleting_a_private_ip_address.rst

@@ -1,62 +0,0 @@
-:original_name: vpc_privateip_0004.html
-
-.. _vpc_privateip_0004:
-
-Deleting a Private IP Address
-=============================
-
-Function
---------
-
-This API is used to delete a private IP address.
-
-URI
----
-
-DELETE /v1/{project_id}/privateips/{privateip_id}
-
-:ref:`Table 1 <vpc_privateip_0004__table24633528>` describes the parameters.
-
-.. _vpc_privateip_0004__table24633528:
-
-.. table:: **Table 1** Parameter description
-
-   +--------------+-----------+-----------------------------------------------------------------------------------------------+
-   | Name         | Mandatory | Description                                                                                   |
-   +==============+===========+===============================================================================================+
-   | project_id   | Yes       | Specifies the project ID.                                                                     |
-   +--------------+-----------+-----------------------------------------------------------------------------------------------+
-   | privateip_id | Yes       | Specifies the ID of the private IP address, which uniquely identifies the private IP address. |
-   +--------------+-----------+-----------------------------------------------------------------------------------------------+
-
-Request Parameters
-------------------
-
-None
-
-Example Request
----------------
-
-.. code-block:: text
-
-   DELETE https://{Endpoint}/v1/{project_id}/privateips/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
-
-Response Parameters
--------------------
-
-None
-
-Example Response
-----------------
-
-None
-
-Status Code
------------
-
-See :ref:`Status Codes <vpc_api_0002>`.
-
-Error Code
-----------
-
-See :ref:`Error Codes <vpc_api_0003>`.

api-ref/source/apis/private_ip_address/index.rst

@@ -1,20 +0,0 @@
-:original_name: vpc_privateip_0000.html
-
-.. _vpc_privateip_0000:
-
-Private IP Address
-==================
-
--  :ref:`Assigning a Private IP Address <vpc_privateip_0001>`
--  :ref:`Querying Private IP Address Details <vpc_privateip_0002>`
--  :ref:`Querying Private IP Addresses <vpc_privateip_0003>`
--  :ref:`Deleting a Private IP Address <vpc_privateip_0004>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   assigning_a_private_ip_address
-   querying_private_ip_address_details
-   querying_private_ip_addresses
-   deleting_a_private_ip_address

api-ref/source/apis/querying_ip_address_usage/index.rst

@@ -1,14 +0,0 @@
-:original_name: vpc_natworkip_0000.html
-
-.. _vpc_natworkip_0000:
-
-Querying IP Address Usage
-=========================
-
--  :ref:`Querying IP Address Usage on a Specified Network <vpc_natworkip_0001>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_ip_address_usage_on_a_specified_network

api-ref/source/apis/quota/index.rst

@@ -1,14 +0,0 @@
-:original_name: vpc_quota_0000.html
-
-.. _vpc_quota_0000:
-
-Quota
-=====
-
--  :ref:`Querying Quotas <vpc_quota_0001>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   querying_quotas