:original_name: dds_api_reference.html

.. _dds_api_reference:

Before You Start
================

This document describes application programming interfaces (APIs), syntax, parameters, and examples of Document Database Service (DDS). You can search for information you need according to :ref:`Table 1 <dds_api_reference__table333417544226>`.

.. _dds_api_reference__table333417544226:

.. table:: **Table 1** Documentation guide

   +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
   | Section                                        | Description                                                                                                                                            |
   +================================================+========================================================================================================================================================+
   | :ref:`API Overview <dds_api_0006>`             | DDS API components and API list                                                                                                                        |
   +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Environment Preparations <dds_api_0007>` | Preparations before using the APIs, including obtaining the request authentication and project ID                                                      |
   +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`API Calling <dds_api_0014>`              | Representational State Transfer (REST) message bodies, calling methods, and examples                                                                   |
   +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`API Description <dds_api_description>`   | DDS APIs, including APIs used for querying information about API version, database version, and DB instance specifications, and managing DB instances. |
   +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Appendix <dds_public_parameters>`        | Understand the status codes and error codes about DDS APIs.                                                                                            |
   +------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+