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>
242 lines
9.4 KiB
JSON
242 lines
9.4 KiB
JSON
[
|
|
{
|
|
"uri":"dds_api_reference.html",
|
|
"product_code":"dds",
|
|
"code":"1",
|
|
"des":"This document describes application programming interfaces (APIs), syntax, parameters, and examples of Document Database Service (DDS). You can search for information you",
|
|
"doc_type":"api",
|
|
"kw":"Before You Start,API Reference",
|
|
"title":"Before You Start",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0006.html",
|
|
"product_code":"dds",
|
|
"code":"2",
|
|
"des":"DDS provides extension APIs, allowing you to perform specific operations using APIs.",
|
|
"doc_type":"api",
|
|
"kw":"API Overview,API Reference",
|
|
"title":"API Overview",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0007.html",
|
|
"product_code":"dds",
|
|
"code":"3",
|
|
"des":"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.",
|
|
"doc_type":"api",
|
|
"kw":"Environment Preparations",
|
|
"title":"Environment Preparations",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0010.html",
|
|
"product_code":"dds",
|
|
"code":"4",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"Token Authentication,Environment Preparations,API Reference",
|
|
"title":"Token Authentication",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0014.html",
|
|
"product_code":"dds",
|
|
"code":"5",
|
|
"des":"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.",
|
|
"doc_type":"api",
|
|
"kw":"API Calling",
|
|
"title":"API Calling",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0015.html",
|
|
"product_code":"dds",
|
|
"code":"6",
|
|
"des":"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 ",
|
|
"doc_type":"api",
|
|
"kw":"Scenarios,API Calling,API Reference",
|
|
"title":"Scenarios",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0016.html",
|
|
"product_code":"dds",
|
|
"code":"7",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"REST APIs,API Calling,API Reference",
|
|
"title":"REST APIs",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0017.html",
|
|
"product_code":"dds",
|
|
"code":"8",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"Example,API Calling,API Reference",
|
|
"title":"Example",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_description.html",
|
|
"product_code":"dds",
|
|
"code":"9",
|
|
"des":"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.",
|
|
"doc_type":"api",
|
|
"kw":"API Description",
|
|
"title":"API Description",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_version.html",
|
|
"product_code":"dds",
|
|
"code":"10",
|
|
"des":"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.",
|
|
"doc_type":"api",
|
|
"kw":"Querying the API Version",
|
|
"title":"Querying the API Version",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0018.html",
|
|
"product_code":"dds",
|
|
"code":"11",
|
|
"des":"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/",
|
|
"doc_type":"api",
|
|
"kw":"Querying the API Version List,Querying the API Version,API Reference",
|
|
"title":"Querying the API Version List",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0019.html",
|
|
"product_code":"dds",
|
|
"code":"12",
|
|
"des":"This API is used to query the specified API version.URI formatGET /v3Request headerGET https://DDS endpoint/v3Request bodyN/AN/AParameter descriptionParameter description",
|
|
"doc_type":"api",
|
|
"kw":"Querying API Version Information,Querying the API Version,API Reference",
|
|
"title":"Querying API Version Information",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_database_version.html",
|
|
"product_code":"dds",
|
|
"code":"13",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"Querying Database Version Information,API Description,API Reference",
|
|
"title":"Querying Database Version Information",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_instance_specification.html",
|
|
"product_code":"",
|
|
"code":"14",
|
|
"des":"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",
|
|
"doc_type":"",
|
|
"kw":"Querying All DB Instance Specifications,API Description,API Reference",
|
|
"title":"Querying All DB Instance Specifications",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_instance_mgmt.html",
|
|
"product_code":"dds",
|
|
"code":"15",
|
|
"des":"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.",
|
|
"doc_type":"api",
|
|
"kw":"DB Instance Management",
|
|
"title":"DB Instance Management",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0020.html",
|
|
"product_code":"dds",
|
|
"code":"16",
|
|
"des":"This API is used to create cluster, replica set, and single node instances.URI formatPOST /v3/{project_id}/instancesPOST /v3/{project_id}/instancesParameter descriptionPa",
|
|
"doc_type":"api",
|
|
"kw":"Creating a DB Instance,DB Instance Management,API Reference",
|
|
"title":"Creating a DB Instance",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0022.html",
|
|
"product_code":"dds",
|
|
"code":"17",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"Deleting a DB Instance,DB Instance Management,API Reference",
|
|
"title":"Deleting a DB Instance",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_api_0023.html",
|
|
"product_code":"",
|
|
"code":"18",
|
|
"des":"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",
|
|
"doc_type":"",
|
|
"kw":"Querying DB Instances,DB Instance Management,API Reference",
|
|
"title":"Querying DB Instances",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_public_parameters.html",
|
|
"product_code":"dds",
|
|
"code":"19",
|
|
"des":"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.",
|
|
"doc_type":"api",
|
|
"kw":"Appendix",
|
|
"title":"Appendix",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_status_code.html",
|
|
"product_code":"dds",
|
|
"code":"20",
|
|
"des":"NormalStatus CodeMessageDescription200OKRequest succeeded.202AcceptedAsynchronous request submitted successfully.AbnormalStatus CodeMessageDescription400Bad RequestInvali",
|
|
"doc_type":"api",
|
|
"kw":"Status Code,Appendix,API Reference",
|
|
"title":"Status Code",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_error_code.html",
|
|
"product_code":"dds",
|
|
"code":"21",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"Error Code,Appendix,API Reference",
|
|
"title":"Error Code",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_projectid.html",
|
|
"product_code":"",
|
|
"code":"22",
|
|
"des":"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",
|
|
"doc_type":"",
|
|
"kw":"Obtaining a Project ID,Appendix,API Reference",
|
|
"title":"Obtaining a Project ID",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_metrics.html",
|
|
"product_code":"dds",
|
|
"code":"23",
|
|
"des":"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",
|
|
"doc_type":"api",
|
|
"kw":"DDS Metrics,Appendix,API Reference",
|
|
"title":"DDS Metrics",
|
|
"githuburl":""
|
|
},
|
|
{
|
|
"uri":"dds_change_history.html",
|
|
"product_code":"",
|
|
"code":"24",
|
|
"des":"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.",
|
|
"doc_type":"",
|
|
"kw":"Change History,API Reference",
|
|
"title":"Change History",
|
|
"githuburl":""
|
|
}
|
|
] |