forked from docs/doc-exports
Wang , Deng Ke
daee48595f
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
218 lines
8.2 KiB
JSON
218 lines
8.2 KiB
JSON
[
|
|
{
|
|
"desc":"This document describes application programming interfaces (APIs), syntax, parameters, and examples of Document Database Service (DDS). You can search for information you",
|
|
"product_code":"dds",
|
|
"title":"Before You Start",
|
|
"uri":"dds_api_reference.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"1"
|
|
},
|
|
{
|
|
"desc":"DDS provides extension APIs, allowing you to perform specific operations using APIs.",
|
|
"product_code":"dds",
|
|
"title":"API Overview",
|
|
"uri":"dds_api_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"Environment Preparations",
|
|
"uri":"dds_api_0007.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"3"
|
|
},
|
|
{
|
|
"desc":"If you use a token for authentication, you must obtain the user's token and add X-Auth-Token to the request message header of the service API when making an API call.This",
|
|
"product_code":"dds",
|
|
"title":"Token Authentication",
|
|
"uri":"dds_api_0010.html",
|
|
"doc_type":"api",
|
|
"p_code":"3",
|
|
"code":"4"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"API Calling",
|
|
"uri":"dds_api_0014.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"5"
|
|
},
|
|
{
|
|
"desc":"DDS open APIs allow users to create, view, or delete DB instances, query API versions, DB engines, DB engine versions, and DB instance class supported by the system. The ",
|
|
"product_code":"dds",
|
|
"title":"Scenarios",
|
|
"uri":"dds_api_0015.html",
|
|
"doc_type":"api",
|
|
"p_code":"5",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"API requests sent by third-party applications to public cloud services must be authenticated using signatures.Public cloud APIs follow RESTful API design rules.In REST, s",
|
|
"product_code":"dds",
|
|
"title":"REST APIs",
|
|
"uri":"dds_api_0016.html",
|
|
"doc_type":"api",
|
|
"p_code":"5",
|
|
"code":"7"
|
|
},
|
|
{
|
|
"desc":"This section describes how to create a cluster instance by calling APIs.The validity period of a token obtained from IAM is 24 hours. If you want to use a token for authe",
|
|
"product_code":"dds",
|
|
"title":"Example",
|
|
"uri":"dds_api_0017.html",
|
|
"doc_type":"api",
|
|
"p_code":"5",
|
|
"code":"8"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"API Description",
|
|
"uri":"dds_api_description.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"9"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"Querying the API Version",
|
|
"uri":"dds_api_version.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"10"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the currently supported API version list.URI formatGET /GET /Parameter descriptionN/AN/ARequest headerGET https://DDS endpoint/Request bodyN/AN/",
|
|
"product_code":"dds",
|
|
"title":"Querying the API Version List",
|
|
"uri":"dds_api_0018.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"11"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the specified API version.URI formatGET /v3Request headerGET https://DDS endpoint/v3Request bodyN/AN/AParameter descriptionParameter description",
|
|
"product_code":"dds",
|
|
"title":"Querying API Version Information",
|
|
"uri":"dds_api_0019.html",
|
|
"doc_type":"api",
|
|
"p_code":"10",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain database version information about a specified type of a DB instance.URI formatGET /v3/{project_id}/datastores/{datastore_name}/versionsGET /v3",
|
|
"product_code":"dds",
|
|
"title":"Querying Database Version Information",
|
|
"uri":"dds_database_version.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all DB instance specifications in a specified region.URI formatGET /v3/{project_id}/flavors?region={region}&engine_name={engine_name}GET /v3/{pr",
|
|
"product_code":"dds",
|
|
"title":"Querying All DB Instance Specifications",
|
|
"uri":"dds_instance_specification.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"DB Instance Management",
|
|
"uri":"dds_instance_mgmt.html",
|
|
"doc_type":"api",
|
|
"p_code":"9",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to create cluster, replica set, and single node instances.URI formatPOST /v3/{project_id}/instancesPOST /v3/{project_id}/instancesParameter descriptionPa",
|
|
"product_code":"dds",
|
|
"title":"Creating a DB Instance",
|
|
"uri":"dds_api_0020.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a DB instance.URI formatDELETE /v3/{project_id}/instances/{instance_id}DELETE /v3/{project_id}/instances/{instance_id}Parameter descriptionPara",
|
|
"product_code":"dds",
|
|
"title":"Deleting a DB Instance",
|
|
"uri":"dds_api_0022.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to query DB instances based on specified conditions.URI formatGET /v3/{project_id}/instances?id={id}&name={name}&mode={mode}&datastore_type={datastore_ty",
|
|
"product_code":"dds",
|
|
"title":"Querying DB Instances",
|
|
"uri":"dds_api_0023.html",
|
|
"doc_type":"api",
|
|
"p_code":"15",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"Appendix",
|
|
"uri":"dds_public_parameters.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali",
|
|
"product_code":"dds",
|
|
"title":"Status Code",
|
|
"uri":"dds_status_code.html",
|
|
"doc_type":"api",
|
|
"p_code":"19",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"If an error occurs in an API, no result is returned. You can locate the error cause based on the error codes of each API. When the invocation fails, an HTTP status code i",
|
|
"product_code":"dds",
|
|
"title":"Error Code",
|
|
"uri":"dds_error_code.html",
|
|
"doc_type":"api",
|
|
"p_code":"19",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"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:Obtaining the Project ID by",
|
|
"product_code":"dds",
|
|
"title":"Obtaining a Project ID",
|
|
"uri":"dds_projectid.html",
|
|
"doc_type":"api",
|
|
"p_code":"19",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This section describes metrics reported by Document Database Service (DDS) to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye",
|
|
"product_code":"dds",
|
|
"title":"DDS Metrics",
|
|
"uri":"dds_metrics.html",
|
|
"doc_type":"api",
|
|
"p_code":"19",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"dds",
|
|
"title":"Change History",
|
|
"uri":"dds_change_history.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"24"
|
|
}
|
|
] |