diff --git a/docs/geminidb/api-ref/ALL_META.TXT.json b/docs/geminidb/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..bebd18c3 --- /dev/null +++ b/docs/geminidb/api-ref/ALL_META.TXT.json @@ -0,0 +1,1257 @@ +[ + { + "dockw":"" + }, + { + "uri":"nosql_api_reference.html", + "node_id":"nosql_api_reference.xml", + "product_code":"nosql", + "code":"1", + "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":"Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"nosql_05_0001.html", + "node_id":"nosql_05_0001.xml", + "product_code":"nosql", + "code":"2", + "des":"Welcome to GeminiDB API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on GeminiDB, such as creating, delet", + "doc_type":"api", + "kw":"Overview,Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Overview", + "githuburl":"" + }, + { + "uri":"nosql_05_0002.html", + "node_id":"nosql_05_0002.xml", + "product_code":"nosql", + "code":"3", + "des":"GeminiDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", + "doc_type":"api", + "kw":"API Calling,Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"nosql_05_0003.html", + "node_id":"nosql_05_0003.xml", + "product_code":"nosql", + "code":"4", + "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "doc_type":"api", + "kw":"Endpoints,Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Endpoints", + "githuburl":"" + }, + { + "uri":"nosql_05_0004.html", + "node_id":"nosql_05_0004.xml", + "product_code":"nosql", + "code":"5", + "des":"For more constraints, see the description of each API.", + "doc_type":"api", + "kw":"Constraints,Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Constraints", + "githuburl":"" + }, + { + "uri":"nosql_05_0005.html", + "node_id":"nosql_05_0005.xml", + "product_code":"nosql", + "code":"6", + "des":"AccountA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user ", + "doc_type":"api", + "kw":"Concepts,Before You Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"nosql_05_0006.html", + "node_id":"nosql_05_0006.xml", + "product_code":"nosql", + "code":"7", + "des":"GeminiDB provides extended APIs. These APIs enable you to use some functions of GeminiDB.", + "doc_type":"api", + "kw":"API Overview", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"nosql_05_0007.html", + "node_id":"nosql_05_0007.xml", + "product_code":"nosql", + "code":"8", + "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":"Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Calling APIs", + "githuburl":"" + }, + { + "uri":"nosql_05_0008.html", + "node_id":"nosql_05_0008.xml", + "product_code":"nosql", + "code":"9", + "des":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is us", + "doc_type":"api", + "kw":"Making an API Request,Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Making an API Request", + "githuburl":"" + }, + { + "uri":"nosql_05_0009.html", + "node_id":"nosql_05_0009.xml", + "product_code":"nosql", + "code":"10", + "des":"GeminiDB supports token-based authentication.The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.A t", + "doc_type":"api", + "kw":"Authentication,Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Authentication", + "githuburl":"" + }, + { + "uri":"nosql_05_0010.html", + "node_id":"nosql_05_0010.xml", + "product_code":"nosql", + "code":"11", + "des":"After you send a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits ranging from 1xx to ", + "doc_type":"api", + "kw":"Returned Values,Calling APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Returned Values", + "githuburl":"" + }, + { + "uri":"nosql_05_0011.html", + "node_id":"nosql_05_0011.xml", + "product_code":"nosql", + "code":"12", + "des":"This section describes how to create a GeminiDB Cassandra instance by calling APIs.The token obtained from IAM is valid for only 24 hours. If you want to use a token for ", + "doc_type":"api", + "kw":"Quick Start", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Quick Start", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000001404778285.html", + "node_id":"en-us_topic_0000001404778285.xml", + "product_code":"nosql", + "code":"13", + "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":"APIs v3", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"APIs v3", + "githuburl":"" + }, + { + "uri":"topic_300000000.html", + "node_id":"topic_300000000.xml", + "product_code":"nosql", + "code":"14", + "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 Versions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"API Versions", + "githuburl":"" + }, + { + "uri":"ListApiVersion.html", + "node_id":"listapiversion.xml", + "product_code":"nosql", + "code":"15", + "des":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ", + "doc_type":"api", + "kw":"Querying API Versions,API Versions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying API Versions", + "githuburl":"" + }, + { + "uri":"ShowApiVersion.html", + "node_id":"showapiversion.xml", + "product_code":"nosql", + "code":"16", + "des":"This API is used to query version information of a specified API.GET https://{Endpoint}/{versionId}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 20", + "doc_type":"api", + "kw":"Querying Version Information of an API,API Versions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Version Information of an API", + "githuburl":"" + }, + { + "uri":"topic_300000001.html", + "node_id":"topic_300000001.xml", + "product_code":"nosql", + "code":"17", + "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":"Versions and Specifications", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Versions and Specifications", + "githuburl":"" + }, + { + "uri":"nosql_database_version.html", + "node_id":"nosql_database_version.xml", + "product_code":"nosql", + "code":"18", + "des":"This API is used to query version information of a specified type of instances.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/datas", + "doc_type":"api", + "kw":"Querying Version Information,Versions and Specifications", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Version Information", + "githuburl":"" + }, + { + "uri":"nosql_instance_specification.html", + "node_id":"nosql_instance_specification.xml", + "product_code":"nosql", + "code":"19", + "des":"This API is used to query all instance specifications under a specified condition.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{project_id}/", + "doc_type":"api", + "kw":"Querying Instance Specifications,Versions and Specifications", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Instance Specifications", + "githuburl":"" + }, + { + "uri":"topic_300000002.html", + "node_id":"topic_300000002.xml", + "product_code":"nosql", + "code":"20", + "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":"Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Instances", + "githuburl":"" + }, + { + "uri":"nosql_05_0014.html", + "node_id":"nosql_05_0014.xml", + "product_code":"nosql", + "code":"21", + "des":"This API can be used to create an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instancesStatus code: 202URI examplePOST", + "doc_type":"api", + "kw":"Creating an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Creating an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0015.html", + "node_id":"nosql_05_0015.xml", + "product_code":"nosql", + "code":"22", + "des":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This", + "doc_type":"api", + "kw":"Deleting an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Deleting an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0016.html", + "node_id":"nosql_05_0016.xml", + "product_code":"nosql", + "code":"23", + "des":"This API is used to query instances and details based on specified conditions.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instan", + "doc_type":"api", + "kw":"Querying Instances and Details,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Instances and Details", + "githuburl":"" + }, + { + "uri":"nosql_05_0050.html", + "node_id":"nosql_05_0050.xml", + "product_code":"nosql", + "code":"24", + "des":"This API is used to scale up storage space of an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/e", + "doc_type":"api", + "kw":"Scaling Up Storage Space of an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Scaling Up Storage Space of an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0051.html", + "node_id":"nosql_05_0051.xml", + "product_code":"nosql", + "code":"25", + "des":"This API is used to add nodes for a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enla", + "doc_type":"api", + "kw":"Adding Nodes for an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Adding Nodes for an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0052.html", + "node_id":"nosql_05_0052.xml", + "product_code":"nosql", + "code":"26", + "des":"This API is used to delete nodes from a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/", + "doc_type":"api", + "kw":"Deleting Nodes from a Specified Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Deleting Nodes from a Specified Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0100.html", + "node_id":"nosql_05_0100.xml", + "product_code":"nosql", + "code":"27", + "des":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ", + "doc_type":"api", + "kw":"Changing Specifications of an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Changing Specifications of an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0101.html", + "node_id":"nosql_05_0101.xml", + "product_code":"nosql", + "code":"28", + "des":"This API is used to reset the administrator password of an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.Only t", + "doc_type":"api", + "kw":"Resetting the Administrator Password of an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Resetting the Administrator Password of an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0102.html", + "node_id":"nosql_05_0102.xml", + "product_code":"nosql", + "code":"29", + "des":"This API is used to edit the name of an instance.This API supports GeminiDB Cassandra instances.The name of the instance that is being created or fails to be created cann", + "doc_type":"api", + "kw":"Editing the Name of an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Editing the Name of an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0103.html", + "node_id":"nosql_05_0103.xml", + "product_code":"nosql", + "code":"30", + "des":"This API is used to change the security group associated with an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.", + "doc_type":"api", + "kw":"Changing the Security Group of an Instance,Instances", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Changing the Security Group of an Instance", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "node_id":"topic_300000003.xml", + "product_code":"nosql", + "code":"31", + "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":"Backups and Restorations", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Backups and Restorations", + "githuburl":"" + }, + { + "uri":"nosql_api_0030.html", + "node_id":"nosql_api_0030.xml", + "product_code":"nosql", + "code":"32", + "des":"This API is used to query an automated backup policy.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups", + "doc_type":"api", + "kw":"Querying an Automated Backup Policy,Backups and Restorations", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"nosql_api_0031.html", + "node_id":"nosql_api_0031.xml", + "product_code":"nosql", + "code":"33", + "des":"This API is used to configuring an automated backup policy.This API supports GeminiDB Cassandra instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/b", + "doc_type":"api", + "kw":"Configuring an Automated Backup Policy,Backups and Restorations", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Configuring an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"topic_300000004.html", + "node_id":"topic_300000004.xml", + "product_code":"nosql", + "code":"34", + "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":"Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_06_0002.html", + "node_id":"nosql_06_0002.xml", + "product_code":"nosql", + "code":"35", + "des":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API supports GeminiDB Cassandra instances.GET https://{En", + "doc_type":"api", + "kw":"Obtaining Parameter Templates,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Obtaining Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_06_0003.html", + "node_id":"nosql_06_0003.xml", + "product_code":"nosql", + "code":"36", + "des":"This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.This API supports G", + "doc_type":"api", + "kw":"Creating a Parameter Template,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Creating a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0004.html", + "node_id":"nosql_06_0004.xml", + "product_code":"nosql", + "code":"37", + "des":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API supports GeminiDB Cassandra instance", + "doc_type":"api", + "kw":"Modifying Parameters in a Parameter Template,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Modifying Parameters in a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0005.html", + "node_id":"nosql_06_0005.xml", + "product_code":"nosql", + "code":"38", + "des":"This API is used to apply a parameter template to one or more instances.This API supports GeminiDB Cassandra instances.This API is an asynchronous API. A successful respo", + "doc_type":"api", + "kw":"Applying a Parameter Template,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Applying a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0006.html", + "node_id":"nosql_06_0006.xml", + "product_code":"nosql", + "code":"39", + "des":"This API is used to modify parameters of a specified instance.This API supports GeminiDB Cassandra instances.For configuration item values, you can enter system-defined p", + "doc_type":"api", + "kw":"Modifying Parameters of a Specified Instance,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Modifying Parameters of a Specified Instance", + "githuburl":"" + }, + { + "uri":"nosql_06_0007.html", + "node_id":"nosql_06_0007.xml", + "product_code":"nosql", + "code":"40", + "des":"This API is used to query instance parameter settings.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/config", + "doc_type":"api", + "kw":"Querying Instance Parameter Settings,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Instance Parameter Settings", + "githuburl":"" + }, + { + "uri":"nosql_06_0008.html", + "node_id":"nosql_06_0008.xml", + "product_code":"nosql", + "code":"41", + "des":"This API is used to obtain information about parameters of a specified parameter template.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{projec", + "doc_type":"api", + "kw":"Obtaining Parameters of a Specified Parameter Template,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Obtaining Parameters of a Specified Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0009.html", + "node_id":"nosql_06_0009.xml", + "product_code":"nosql", + "code":"42", + "des":"This API is used to delete a specified parameter template.This API supports GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_", + "doc_type":"api", + "kw":"Deleting a Parameter Template,Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Deleting a Parameter Template", + "githuburl":"" + }, + { + "uri":"topic_300000005.html", + "node_id":"topic_300000005.xml", + "product_code":"nosql", + "code":"43", + "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":"Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Tags", + "githuburl":"" + }, + { + "uri":"ListInstancesByResourceTags.html", + "node_id":"listinstancesbyresourcetags.xml", + "product_code":"nosql", + "code":"44", + "des":"This API is used to query a specified instance by tag.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must ", + "doc_type":"api", + "kw":"Querying an Instance by Tag,Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying an Instance by Tag", + "githuburl":"" + }, + { + "uri":"BatchTagAction.html", + "node_id":"batchtagaction.xml", + "product_code":"nosql", + "code":"45", + "des":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to", + "doc_type":"api", + "kw":"Adding or Deleting Resource Tags in Batches,Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Adding or Deleting Resource Tags in Batches", + "githuburl":"" + }, + { + "uri":"ListInstanceTags.html", + "node_id":"listinstancetags.xml", + "product_code":"nosql", + "code":"46", + "des":"This API is used to query tags of a specified instance.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must", + "doc_type":"api", + "kw":"Querying Tags of an Instance,Tags", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Tags of an Instance", + "githuburl":"" + }, + { + "uri":"topic_300000006.html", + "node_id":"topic_300000006.xml", + "product_code":"nosql", + "code":"47", + "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":"Logs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Logs", + "githuburl":"" + }, + { + "uri":"ListSlowLogs.html", + "node_id":"listslowlogs.xml", + "product_code":"nosql", + "code":"48", + "des":"This API is used to query the latest 2,000 slow query logs of an instance. Searching by keyword is not supported.This API supports GeminiDB Cassandra instances.This API c", + "doc_type":"api", + "kw":"Querying Database Slow Logs,Logs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Database Slow Logs", + "githuburl":"" + }, + { + "uri":"topic_300000007.html", + "node_id":"topic_300000007.xml", + "product_code":"nosql", + "code":"49", + "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":"Quotas", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Quotas", + "githuburl":"" + }, + { + "uri":"ShowQuotas.html", + "node_id":"showquotas.xml", + "product_code":"nosql", + "code":"50", + "des":"This API is used to query GeminiDB resource quotas of a tenant.GET https://{Endpoint}/v3/{project_id}/quotasStatus code: 200URI exampleGET https://{Endpoint}/v3/0549b4a43", + "doc_type":"api", + "kw":"Querying Quota,Quotas", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Quota", + "githuburl":"" + }, + { + "uri":"topic_300000016.html", + "node_id":"topic_300000016.xml", + "product_code":"", + "code":"51", + "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":"Task Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Task Management", + "githuburl":"" + }, + { + "uri":"nosql_10_0100.html", + "node_id":"nosql_10_0100.xml", + "product_code":"", + "code":"52", + "des":"This API is used to query tasks (by default) and details.GET https://{Endpoint}/v3/{project_id}/jobsStatus code: 200URI exampleGET https://{endpoint}/v3/0549b4a43100d4f32", + "doc_type":"", + "kw":"Querying Tasks and Details,Task Management", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying Tasks and Details", + "githuburl":"" + }, + { + "uri":"nosql_public_parameters.html", + "node_id":"nosql_public_parameters.xml", + "product_code":"nosql", + "code":"54", + "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":"Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Appendixes", + "githuburl":"" + }, + { + "uri":"nosql_abnormal_result.html", + "node_id":"nosql_abnormal_result.xml", + "product_code":"nosql", + "code":"55", + "des":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", + "doc_type":"api", + "kw":"Abnormal Request Results,Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Abnormal Request Results", + "githuburl":"" + }, + { + "uri":"nosql_status_code.html", + "node_id":"nosql_status_code.xml", + "product_code":"nosql", + "code":"56", + "des":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", + "doc_type":"api", + "kw":"Status Codes,Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"nosql_error_code.html", + "node_id":"nosql_error_code.xml", + "product_code":"nosql", + "code":"57", + "des":"If an error occurs during API calling, no results will be returned. You can locate the error cause based on error codes of each API. If an error occurs, an HTTP status co", + "doc_type":"api", + "kw":"Error Codes,Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"nosql_projectid.html", + "node_id":"nosql_projectid.xml", + "product_code":"nosql", + "code":"58", + "des":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first.You can obtain the required project ID with either o", + "doc_type":"api", + "kw":"Obtaining a Project ID,Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Obtaining a Project ID", + "githuburl":"" + }, + { + "uri":"nosql_metrics.html", + "node_id":"nosql_metrics.xml", + "product_code":"nosql", + "code":"59", + "des":"This section describes GeminiDB metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query metrics of monit", + "doc_type":"api", + "kw":"Metrics,Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Metrics", + "githuburl":"" + }, + { + "uri":"nosql_08_0001.html", + "node_id":"nosql_08_0001.xml", + "product_code":"nosql", + "code":"60", + "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":"Events Supported by Event Monitoring,Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Events Supported by Event Monitoring", + "githuburl":"" + }, + { + "uri":"nosql_change_history02.html", + "node_id":"nosql_change_history02.xml", + "product_code":"nosql", + "code":"61", + "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":"Change History", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"Yes", + "IsMulti":"Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/geminidb/api-ref/BatchTagAction.html b/docs/geminidb/api-ref/BatchTagAction.html new file mode 100644 index 00000000..b9d6e89f --- /dev/null +++ b/docs/geminidb/api-ref/BatchTagAction.html @@ -0,0 +1,179 @@ + + +

Adding or Deleting Resource Tags in Batches

+

Function

This API is used to add tags to or delete tags from a specified DB instance in batches.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

A maximum of 20 tags can be added to an instance. The tag key must be unique.

+

If the request body contains duplicated keys, an error message will be reported when the API is called.

+

If the key in the request body is the same as an existing key in a specified instance, the value of the value parameter that corresponds to the existing key is overwritten.

+

If the tag to be deleted does not exist, the system deems the deletion operation successful by default but does not check whether the tag key and value meets character set rules.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags/action

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

action

+

Yes

+

String

+

Operation identifier. The value can be:

+
  • create, indicating that tags are added.
  • delete, indicating that tags are deleted.
+

tags

+

Yes

+

Array of BatchTagActionTagOption objects

+

All tags.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 BatchTagActionTagOption

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. It can contain a maximum of 36 Unicode characters. The key value cannot be null, an empty string, or spaces. Before using key, delete spaces before and after the value.

+

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

+

value

+

No

+

String

+

Tag value. The tag value can contain a maximum of 43 Unicode characters and can be an empty string.

+

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

+
  • If action is set to create, this parameter is mandatory.
  • If action is set to delete, this parameter is optional.
+
NOTE:

If value is specified, tags are deleted by key and value. If value is not specified, tags are deleted by key.

+
+
+
+
+

Response Parameters

Status code: 200

+

No response parameters

+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Success

+
{ }
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/geminidb/api-ref/CLASS.TXT.json b/docs/geminidb/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..36b94854 --- /dev/null +++ b/docs/geminidb/api-ref/CLASS.TXT.json @@ -0,0 +1,542 @@ +[ + { + "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":"nosql", + "title":"Before You Start", + "uri":"nosql_api_reference.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"Welcome to GeminiDB API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on GeminiDB, such as creating, delet", + "product_code":"nosql", + "title":"Overview", + "uri":"nosql_05_0001.html", + "doc_type":"api", + "p_code":"1", + "code":"2" + }, + { + "desc":"GeminiDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", + "product_code":"nosql", + "title":"API Calling", + "uri":"nosql_05_0002.html", + "doc_type":"api", + "p_code":"1", + "code":"3" + }, + { + "desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", + "product_code":"nosql", + "title":"Endpoints", + "uri":"nosql_05_0003.html", + "doc_type":"api", + "p_code":"1", + "code":"4" + }, + { + "desc":"For more constraints, see the description of each API.", + "product_code":"nosql", + "title":"Constraints", + "uri":"nosql_05_0004.html", + "doc_type":"api", + "p_code":"1", + "code":"5" + }, + { + "desc":"AccountA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user ", + "product_code":"nosql", + "title":"Concepts", + "uri":"nosql_05_0005.html", + "doc_type":"api", + "p_code":"1", + "code":"6" + }, + { + "desc":"GeminiDB provides extended APIs. These APIs enable you to use some functions of GeminiDB.", + "product_code":"nosql", + "title":"API Overview", + "uri":"nosql_05_0006.html", + "doc_type":"api", + "p_code":"", + "code":"7" + }, + { + "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":"nosql", + "title":"Calling APIs", + "uri":"nosql_05_0007.html", + "doc_type":"api", + "p_code":"", + "code":"8" + }, + { + "desc":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is us", + "product_code":"nosql", + "title":"Making an API Request", + "uri":"nosql_05_0008.html", + "doc_type":"api", + "p_code":"8", + "code":"9" + }, + { + "desc":"GeminiDB supports token-based authentication.The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.A t", + "product_code":"nosql", + "title":"Authentication", + "uri":"nosql_05_0009.html", + "doc_type":"api", + "p_code":"8", + "code":"10" + }, + { + "desc":"After you send a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits ranging from 1xx to ", + "product_code":"nosql", + "title":"Returned Values", + "uri":"nosql_05_0010.html", + "doc_type":"api", + "p_code":"8", + "code":"11" + }, + { + "desc":"This section describes how to create a GeminiDB Cassandra instance by calling APIs.The token obtained from IAM is valid for only 24 hours. If you want to use a token for ", + "product_code":"nosql", + "title":"Quick Start", + "uri":"nosql_05_0011.html", + "doc_type":"api", + "p_code":"", + "code":"12" + }, + { + "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":"nosql", + "title":"APIs v3", + "uri":"en-us_topic_0000001404778285.html", + "doc_type":"api", + "p_code":"", + "code":"13" + }, + { + "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":"nosql", + "title":"API Versions", + "uri":"topic_300000000.html", + "doc_type":"api", + "p_code":"13", + "code":"14" + }, + { + "desc":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ", + "product_code":"nosql", + "title":"Querying API Versions", + "uri":"ListApiVersion.html", + "doc_type":"api", + "p_code":"14", + "code":"15" + }, + { + "desc":"This API is used to query version information of a specified API.GET https://{Endpoint}/{versionId}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 20", + "product_code":"nosql", + "title":"Querying Version Information of an API", + "uri":"ShowApiVersion.html", + "doc_type":"api", + "p_code":"14", + "code":"16" + }, + { + "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":"nosql", + "title":"Versions and Specifications", + "uri":"topic_300000001.html", + "doc_type":"api", + "p_code":"13", + "code":"17" + }, + { + "desc":"This API is used to query version information of a specified type of instances.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/datas", + "product_code":"nosql", + "title":"Querying Version Information", + "uri":"nosql_database_version.html", + "doc_type":"api", + "p_code":"17", + "code":"18" + }, + { + "desc":"This API is used to query all instance specifications under a specified condition.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{project_id}/", + "product_code":"nosql", + "title":"Querying Instance Specifications", + "uri":"nosql_instance_specification.html", + "doc_type":"api", + "p_code":"17", + "code":"19" + }, + { + "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":"nosql", + "title":"Instances", + "uri":"topic_300000002.html", + "doc_type":"api", + "p_code":"13", + "code":"20" + }, + { + "desc":"This API can be used to create an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instancesStatus code: 202URI examplePOST", + "product_code":"nosql", + "title":"Creating an Instance", + "uri":"nosql_05_0014.html", + "doc_type":"api", + "p_code":"20", + "code":"21" + }, + { + "desc":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This", + "product_code":"nosql", + "title":"Deleting an Instance", + "uri":"nosql_05_0015.html", + "doc_type":"api", + "p_code":"20", + "code":"22" + }, + { + "desc":"This API is used to query instances and details based on specified conditions.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instan", + "product_code":"nosql", + "title":"Querying Instances and Details", + "uri":"nosql_05_0016.html", + "doc_type":"api", + "p_code":"20", + "code":"23" + }, + { + "desc":"This API is used to scale up storage space of an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/e", + "product_code":"nosql", + "title":"Scaling Up Storage Space of an Instance", + "uri":"nosql_05_0050.html", + "doc_type":"api", + "p_code":"20", + "code":"24" + }, + { + "desc":"This API is used to add nodes for a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enla", + "product_code":"nosql", + "title":"Adding Nodes for an Instance", + "uri":"nosql_05_0051.html", + "doc_type":"api", + "p_code":"20", + "code":"25" + }, + { + "desc":"This API is used to delete nodes from a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/", + "product_code":"nosql", + "title":"Deleting Nodes from a Specified Instance", + "uri":"nosql_05_0052.html", + "doc_type":"api", + "p_code":"20", + "code":"26" + }, + { + "desc":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ", + "product_code":"nosql", + "title":"Changing Specifications of an Instance", + "uri":"nosql_05_0100.html", + "doc_type":"api", + "p_code":"20", + "code":"27" + }, + { + "desc":"This API is used to reset the administrator password of an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.Only t", + "product_code":"nosql", + "title":"Resetting the Administrator Password of an Instance", + "uri":"nosql_05_0101.html", + "doc_type":"api", + "p_code":"20", + "code":"28" + }, + { + "desc":"This API is used to edit the name of an instance.This API supports GeminiDB Cassandra instances.The name of the instance that is being created or fails to be created cann", + "product_code":"nosql", + "title":"Editing the Name of an Instance", + "uri":"nosql_05_0102.html", + "doc_type":"api", + "p_code":"20", + "code":"29" + }, + { + "desc":"This API is used to change the security group associated with an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.", + "product_code":"nosql", + "title":"Changing the Security Group of an Instance", + "uri":"nosql_05_0103.html", + "doc_type":"api", + "p_code":"20", + "code":"30" + }, + { + "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":"nosql", + "title":"Backups and Restorations", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"13", + "code":"31" + }, + { + "desc":"This API is used to query an automated backup policy.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups", + "product_code":"nosql", + "title":"Querying an Automated Backup Policy", + "uri":"nosql_api_0030.html", + "doc_type":"api", + "p_code":"31", + "code":"32" + }, + { + "desc":"This API is used to configuring an automated backup policy.This API supports GeminiDB Cassandra instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/b", + "product_code":"nosql", + "title":"Configuring an Automated Backup Policy", + "uri":"nosql_api_0031.html", + "doc_type":"api", + "p_code":"31", + "code":"33" + }, + { + "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":"nosql", + "title":"Parameter Templates", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"13", + "code":"34" + }, + { + "desc":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API supports GeminiDB Cassandra instances.GET https://{En", + "product_code":"nosql", + "title":"Obtaining Parameter Templates", + "uri":"nosql_06_0002.html", + "doc_type":"api", + "p_code":"34", + "code":"35" + }, + { + "desc":"This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.This API supports G", + "product_code":"nosql", + "title":"Creating a Parameter Template", + "uri":"nosql_06_0003.html", + "doc_type":"api", + "p_code":"34", + "code":"36" + }, + { + "desc":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API supports GeminiDB Cassandra instance", + "product_code":"nosql", + "title":"Modifying Parameters in a Parameter Template", + "uri":"nosql_06_0004.html", + "doc_type":"api", + "p_code":"34", + "code":"37" + }, + { + "desc":"This API is used to apply a parameter template to one or more instances.This API supports GeminiDB Cassandra instances.This API is an asynchronous API. A successful respo", + "product_code":"nosql", + "title":"Applying a Parameter Template", + "uri":"nosql_06_0005.html", + "doc_type":"api", + "p_code":"34", + "code":"38" + }, + { + "desc":"This API is used to modify parameters of a specified instance.This API supports GeminiDB Cassandra instances.For configuration item values, you can enter system-defined p", + "product_code":"nosql", + "title":"Modifying Parameters of a Specified Instance", + "uri":"nosql_06_0006.html", + "doc_type":"api", + "p_code":"34", + "code":"39" + }, + { + "desc":"This API is used to query instance parameter settings.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/config", + "product_code":"nosql", + "title":"Querying Instance Parameter Settings", + "uri":"nosql_06_0007.html", + "doc_type":"api", + "p_code":"34", + "code":"40" + }, + { + "desc":"This API is used to obtain information about parameters of a specified parameter template.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{projec", + "product_code":"nosql", + "title":"Obtaining Parameters of a Specified Parameter Template", + "uri":"nosql_06_0008.html", + "doc_type":"api", + "p_code":"34", + "code":"41" + }, + { + "desc":"This API is used to delete a specified parameter template.This API supports GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_", + "product_code":"nosql", + "title":"Deleting a Parameter Template", + "uri":"nosql_06_0009.html", + "doc_type":"api", + "p_code":"34", + "code":"42" + }, + { + "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":"nosql", + "title":"Tags", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"13", + "code":"43" + }, + { + "desc":"This API is used to query a specified instance by tag.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must ", + "product_code":"nosql", + "title":"Querying an Instance by Tag", + "uri":"ListInstancesByResourceTags.html", + "doc_type":"api", + "p_code":"43", + "code":"44" + }, + { + "desc":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to", + "product_code":"nosql", + "title":"Adding or Deleting Resource Tags in Batches", + "uri":"BatchTagAction.html", + "doc_type":"api", + "p_code":"43", + "code":"45" + }, + { + "desc":"This API is used to query tags of a specified instance.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must", + "product_code":"nosql", + "title":"Querying Tags of an Instance", + "uri":"ListInstanceTags.html", + "doc_type":"api", + "p_code":"43", + "code":"46" + }, + { + "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":"nosql", + "title":"Logs", + "uri":"topic_300000006.html", + "doc_type":"api", + "p_code":"13", + "code":"47" + }, + { + "desc":"This API is used to query the latest 2,000 slow query logs of an instance. Searching by keyword is not supported.This API supports GeminiDB Cassandra instances.This API c", + "product_code":"nosql", + "title":"Querying Database Slow Logs", + "uri":"ListSlowLogs.html", + "doc_type":"api", + "p_code":"47", + "code":"48" + }, + { + "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":"nosql", + "title":"Quotas", + "uri":"topic_300000007.html", + "doc_type":"api", + "p_code":"13", + "code":"49" + }, + { + "desc":"This API is used to query GeminiDB resource quotas of a tenant.GET https://{Endpoint}/v3/{project_id}/quotasStatus code: 200URI exampleGET https://{Endpoint}/v3/0549b4a43", + "product_code":"nosql", + "title":"Querying Quota", + "uri":"ShowQuotas.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "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":"", + "title":"Task Management", + "uri":"topic_300000016.html", + "doc_type":"", + "p_code":"13", + "code":"51" + }, + { + "desc":"This API is used to query tasks (by default) and details.GET https://{Endpoint}/v3/{project_id}/jobsStatus code: 200URI exampleGET https://{endpoint}/v3/0549b4a43100d4f32", + "product_code":"", + "title":"Querying Tasks and Details", + "uri":"nosql_10_0100.html", + "doc_type":"", + "p_code":"51", + "code":"52" + }, + { + "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":"nosql", + "title":"Appendixes", + "uri":"nosql_public_parameters.html", + "doc_type":"api", + "p_code":"", + "code":"54" + }, + { + "desc":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", + "product_code":"nosql", + "title":"Abnormal Request Results", + "uri":"nosql_abnormal_result.html", + "doc_type":"api", + "p_code":"54", + "code":"55" + }, + { + "desc":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", + "product_code":"nosql", + "title":"Status Codes", + "uri":"nosql_status_code.html", + "doc_type":"api", + "p_code":"54", + "code":"56" + }, + { + "desc":"If an error occurs during API calling, no results will be returned. You can locate the error cause based on error codes of each API. If an error occurs, an HTTP status co", + "product_code":"nosql", + "title":"Error Codes", + "uri":"nosql_error_code.html", + "doc_type":"api", + "p_code":"54", + "code":"57" + }, + { + "desc":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first.You can obtain the required project ID with either o", + "product_code":"nosql", + "title":"Obtaining a Project ID", + "uri":"nosql_projectid.html", + "doc_type":"api", + "p_code":"54", + "code":"58" + }, + { + "desc":"This section describes GeminiDB metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query metrics of monit", + "product_code":"nosql", + "title":"Metrics", + "uri":"nosql_metrics.html", + "doc_type":"api", + "p_code":"54", + "code":"59" + }, + { + "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":"nosql", + "title":"Events Supported by Event Monitoring", + "uri":"nosql_08_0001.html", + "doc_type":"api", + "p_code":"54", + "code":"60" + }, + { + "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":"nosql", + "title":"Change History", + "uri":"nosql_change_history02.html", + "doc_type":"api", + "p_code":"", + "code":"61" + } +] \ No newline at end of file diff --git a/docs/geminidb/api-ref/ListApiVersion.html b/docs/geminidb/api-ref/ListApiVersion.html new file mode 100644 index 00000000..9a9f1df0 --- /dev/null +++ b/docs/geminidb/api-ref/ListApiVersion.html @@ -0,0 +1,141 @@ + + +

Querying API Versions

+

Function

This API is used to query the supported API versions.

+
+

URI

GET https://{Endpoint}/

+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 1 Response body parameters

Parameter

+

Type

+

Description

+

versions

+

Array of ApiVersionResponse objects

+

API version information

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 ApiVersionResponse

Parameter

+

Type

+

Description

+

id

+

String

+

API version number

+

links

+

Array of Links objects

+

API link information

+
NOTE:

If the version is v3, the value is [].

+
+

status

+

String

+

Version status

+

version

+

String

+

Subversion information of the API version

+

min_version

+

String

+

Minimum API version number

+

updated

+

String

+

Version update time

+

The format is yyyy-mm-dd Thh:mm:ssZ.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.

+
+
+ +
+ + + + + + + + + + + + + +
Table 3 Links

Parameter

+

Type

+

Description

+

href

+

String

+

API URL. The value is "".

+

rel

+

String

+

The value is self, indicating that URL is a local link.

+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/
+
+
+

Example Response

Status code: 200

+

Success

+
{
+  "versions" : [ {
+    "id" : "v3",
+    "links" : [ ],
+    "status" : "CURRENT",
+    "version" : "",
+    "min_version" : "",
+    "updated" : "2019-10-30T17:34:02Z"
+  } ]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: API Versions
+
+
+ diff --git a/docs/geminidb/api-ref/ListInstanceTags.html b/docs/geminidb/api-ref/ListInstanceTags.html new file mode 100644 index 00000000..d830dd19 --- /dev/null +++ b/docs/geminidb/api-ref/ListInstanceTags.html @@ -0,0 +1,141 @@ + + +

Querying Tags of an Instance

+

Function

This API is used to query tags of a specified instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

A maximum of 20 tags can be added to a DB instance. The tag key must be unique.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of ListInstanceTagsResult objects

+

Tags of the instance.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 ListInstanceTagsResult

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. The tag key can contain a maximum of 36 Unicode characters and must be specified.

+

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

+

value

+

String

+

Tag value. The tag value can contain a maximum of 43 Unicode characters and can be an empty string.

+

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags
+
+
+

Example Responses

Status code: 200

+

Success

+
{
+  "tags" : [ {
+    "key" : "key1",
+    "value" : "value1"
+  }, {
+    "key" : "key2",
+    "value" : "value2"
+  } ]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/geminidb/api-ref/ListInstancesByResourceTags.html b/docs/geminidb/api-ref/ListInstancesByResourceTags.html new file mode 100644 index 00000000..bd246c13 --- /dev/null +++ b/docs/geminidb/api-ref/ListInstancesByResourceTags.html @@ -0,0 +1,339 @@ + + +

Querying an Instance by Tag

+

Function

This API is used to query a specified instance by tag.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

A maximum of 20 tags can be added to a DB instance. The tag key must be unique.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/instances/resource-instances/action

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

String

+

Index offset. The query starts from the next piece of data indexed by this parameter.

+
  • If action is set to count, this parameter does not need to be transferred.
  • If action is set to filter, the parameter value must be a positive integer. The default value is 0, indicating that the query starts from the first piece of data. '
+

limit

+

No

+

String

+

Number of records to be queried.

+
  • If action is set to count, this parameter does not need to be transferred.
  • If action is set to filter, the value ranges from 1 to 100. If this parameter is not transferred, the first 100 instances are queried by default.
+

action

+

Yes

+

String

+

Operation identifier.

+
  • If action is set to filter, instances are queried based on tag filters.
  • If action is set to count, only the total number of records is returned.
+

matches

+

No

+

Array of MatchOption objects

+

Search parameter.

+
  • If this parameter is not specified, the query is not based on the instance name or ID.
  • This parameter cannot be left blank.
+

tags

+

No

+

Array of TagOption objects

+

Included tags. Each tag contains a maximum of 20 keys.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 MatchOption

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Query criteria. The value can be instance_name or instance_id, indicating that the query is based on the instance name or instance ID.

+

value

+

Yes

+

String

+

Name or ID of the instance to be queried

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 5 TagOption

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. It can contain a maximum of 36 Unicode characters. The key value cannot be null, an empty string, or spaces. Before using key, delete spaces before and after the value.

+
NOTE:

The character set of this parameter is not verified during search.

+
+

values

+

Yes

+

Array of strings

+

Tag values. Each tag value can contain a maximum of 43 Unicode characters and cannot contain spaces. Before using values, delete spaces before and after the value.

+

If the values is not specified, any parameter value can be queried. All values are in the OR relationship.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

instances

+

Array of InstanceResult objects

+

All instances.

+

total_count

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 InstanceResult

Parameter

+

Type

+

Description

+

instance_id

+

String

+

Instance ID.

+

instance_name

+

String

+

Instance name.

+

tags

+

Array of InstanceTagResult objects

+

All tags. If there are no tags, tags is taken as an empty array by default.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 InstanceTagResult

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. The tag key must be specified and can include a maximum of 36 Unicode characters.

+

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

+

value

+

String

+

Tag value. The tag value can contain a maximum of 43 Unicode characters and can be an empty string.

+

It is case-sensitive and can contain digits, letters, underscores (_), and hyphens (-).

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Success

+
{
+  "total_count": 1,
+  "instances" : [{
+    "instance_id" : "2acbf2223caf3bac3c33c6153423c3ccin06",
+    "instance_name" : "test-single",
+    "tags" : [ {
+      "key" : "key1",
+      "value" : "value1"
+    }, {
+      "key" : "key2",
+      "value" : "value1"
+    } ]
+  }]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Tags
+
+
+ diff --git a/docs/geminidb/api-ref/ListSlowLogs.html b/docs/geminidb/api-ref/ListSlowLogs.html new file mode 100644 index 00000000..3f6dfb12 --- /dev/null +++ b/docs/geminidb/api-ref/ListSlowLogs.html @@ -0,0 +1,247 @@ + + +

Querying Database Slow Logs

+

Function

This API is used to query the latest 2,000 slow query logs of an instance. Searching by keyword is not supported.

+
+

Constraints

+
+

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

start_date

+

Yes

+

String

+

Start time in the yyyy-mm-ddThh:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

The start time is at most 30 days earlier than the current time.

+

end_date

+

Yes

+

String

+

End time in the yyyy-mm-ddThh:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. You can only query slow query logs generated in the last one month.

+

The end time cannot be later than the current time.

+

offset

+

No

+

Integer

+

Index offset. Its value ranges from 0 to 1999.

+

If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.

+

limit

+

No

+

Integer

+

Number of records to be queried. The value ranges from 1 to 100.

+

The sum of values of limit and offset must be 2000 or lower.

+

node_id

+

No

+

String

+

Node ID. If this parameter is not specified, all nodes of the instance are queried.

+

For details about the value, see id in table Table 10 in Querying Instances and Details.

+

type

+

No

+

String

+

SQL statement type. If this parameter is not specified, all types of SQL statements are queried. You can also specify the following log type:

+
  • SELECT
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

slow_log_list

+

Array of SlowlogResult objects

+

Information about slow query logs.

+

total_record

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 SlowlogResult

Parameter

+

Type

+

Description

+

time

+

String

+

Execution time.

+

database

+

String

+

Database which slow query logs belong to.

+

query_sample

+

String

+

Execution syntax.

+

type

+

String

+

SQL statement type.

+

start_time

+

String

+

UTC time when logs are generated.

+
+
+
+

Example Requests

+
+ +

Example Responses

Status code: 200

+

Success

+
{
+  "total_record" : 1,
+  "slow_log_list" : [ {
+    "time" : "513 ms",
+    "database" : "cassandra",
+    "query_sample" : "SELECT * FROM cassandra.sz_user_hw LIMIT 100;",
+    "type" : "SELECT",
+    "start_time" : "2020-11-15T22:49:38.643000Z"
+  } ]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Logs
+
+
+ diff --git a/docs/geminidb/api-ref/PARAMETERS.txt b/docs/geminidb/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/geminidb/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/geminidb/api-ref/ShowApiVersion.html b/docs/geminidb/api-ref/ShowApiVersion.html new file mode 100644 index 00000000..38f2ca92 --- /dev/null +++ b/docs/geminidb/api-ref/ShowApiVersion.html @@ -0,0 +1,164 @@ + + +

Querying Version Information of an API

+

Function

This API is used to query version information of a specified API.

+
+

URI

GET https://{Endpoint}/{versionId}

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

versionId

+

Yes

+

String

+

API version

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

version

+

ApiVersionResponse object

+

API version information

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 ApiVersionResponse

Parameter

+

Type

+

Description

+

id

+

String

+

API version number

+

links

+

Array of Links objects

+

API link information

+
NOTE:

If the version is v3, the value is [].

+
+

status

+

String

+

Version status

+

version

+

String

+

Subversion information of the API version

+

min_version

+

String

+

Minimum API version number

+

updated

+

String

+

Version update time

+

The format is yyyy-mm-dd Thh:mm:ssZ.

+

T is the separator between the calendar and the hourly notation of time. Z indicates the UTC.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Links

Parameter

+

Type

+

Description

+

href

+

String

+

API URL. The value is "".

+

rel

+

String

+

The value is self, indicating that URL is a local link.

+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3
+
+
+

Example Response

Status code: 200

+

Success

+
{
+  "version" : {
+    "id" : "v3",
+    "links" : [ ],
+    "status" : "CURRENT",
+    "version" : "",
+    "min_version" : "",
+    "updated" : "2019-10-30T17:34:02Z"
+  }
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: API Versions
+
+
+ diff --git a/docs/geminidb/api-ref/ShowQuotas.html b/docs/geminidb/api-ref/ShowQuotas.html new file mode 100644 index 00000000..44f160ff --- /dev/null +++ b/docs/geminidb/api-ref/ShowQuotas.html @@ -0,0 +1,154 @@ + + +

Querying Quota

+

Function

This API is used to query GeminiDB resource quotas of a tenant.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/quotas

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

quotas

+

ShowResourcesListResponseBody object

+

Quota information.

+
+
+ +
+ + + + + + + + + +
Table 4 ShowResourcesListResponseBody

Parameter

+

Type

+

Description

+

resources

+

Array of ShowResourcesDetailResponseBody objects

+

All resources.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 ShowResourcesDetailResponseBody

Parameter

+

Type

+

Description

+

type

+

String

+

Quota resource type. Only the instance type is supported.

+

quota

+

Integer

+

Current quota.

+

If this parameter is set to 0, no quantity limit is set for resources.

+

used

+

Integer

+

Number of used resources.

+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/quotas
+
+
+

Example Responses

Status code: 200

+

Success

+
{
+  "quotas" : {
+    "resources" : [ {
+      "type" : "instance",
+      "quota" : 200,
+      "used" : 58
+    } ]
+  }
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Quotas
+
+
+ diff --git a/docs/geminidb/api-ref/en-us_image_0000001354698252.png b/docs/geminidb/api-ref/en-us_image_0000001354698252.png new file mode 100644 index 00000000..e892e305 Binary files /dev/null and b/docs/geminidb/api-ref/en-us_image_0000001354698252.png differ diff --git a/docs/geminidb/api-ref/en-us_image_0000001354858484.jpg b/docs/geminidb/api-ref/en-us_image_0000001354858484.jpg new file mode 100644 index 00000000..b0e263d9 Binary files /dev/null and b/docs/geminidb/api-ref/en-us_image_0000001354858484.jpg differ diff --git a/docs/geminidb/api-ref/en-us_image_0000001355018024.png b/docs/geminidb/api-ref/en-us_image_0000001355018024.png new file mode 100644 index 00000000..d4a37a97 Binary files /dev/null and b/docs/geminidb/api-ref/en-us_image_0000001355018024.png differ diff --git a/docs/geminidb/api-ref/en-us_topic_0000001404778285.html b/docs/geminidb/api-ref/en-us_topic_0000001404778285.html new file mode 100644 index 00000000..1e27856e --- /dev/null +++ b/docs/geminidb/api-ref/en-us_topic_0000001404778285.html @@ -0,0 +1,27 @@ + + +

APIs v3

+
+
+ +
+ diff --git a/docs/geminidb/api-ref/nosql_05_0001.html b/docs/geminidb/api-ref/nosql_05_0001.html new file mode 100644 index 00000000..37fecf22 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0001.html @@ -0,0 +1,12 @@ + + +

Overview

+

Welcome to GeminiDB API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on GeminiDB, such as creating, deleting, and querying DB instances. For details about all supported operations, see API Overview.

+

If you want to access GeminiDB using an API, ensure that you are familiar with GeminiDB concepts. For details, see the GeminiDB User Guide.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0002.html b/docs/geminidb/api-ref/nosql_05_0002.html new file mode 100644 index 00000000..1c1c29c9 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0002.html @@ -0,0 +1,11 @@ + + +

API Calling

+

GeminiDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0003.html b/docs/geminidb/api-ref/nosql_05_0003.html new file mode 100644 index 00000000..f62b82ce --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0003.html @@ -0,0 +1,11 @@ + + +

Endpoints

+

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0004.html b/docs/geminidb/api-ref/nosql_05_0004.html new file mode 100644 index 00000000..b21c06fe --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0004.html @@ -0,0 +1,11 @@ + + +

Constraints

+

For more constraints, see the description of each API.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0005.html b/docs/geminidb/api-ref/nosql_05_0005.html new file mode 100644 index 00000000..d6263aef --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0005.html @@ -0,0 +1,19 @@ + + +

Concepts

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0006.html b/docs/geminidb/api-ref/nosql_05_0006.html new file mode 100644 index 00000000..343d60f7 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0006.html @@ -0,0 +1,56 @@ + + +

API Overview

+

GeminiDB provides extended APIs. These APIs enable you to use some functions of GeminiDB.

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 API description

Type

+

Description

+

API Version Queries

+
  • Query API versions.
  • Query version information of a specific API.
+

DB Version Queries

+

Query version information of a specified type of instances.

+

Instance Specifications Queries

+

Query all instance specifications under a specified condition.

+

Instance Management

+

Create, delete, and query instances, scale up or down the instance storage space, add or delete cluster instance nodes, change instance specifications, and change the instance administrator password, instance name, and instance security group.

+

Backup and Restoration

+

Query and set automated backup policies.

+

Parameter Management

+

Obtain parameter templates, create a parameter template, modify parameters in a parameter template, apply a parameter template, modify or obtain parameters of a specified instance, obtain parameters of a specified parameter template, and delete a parameter template.

+

Tag Management

+

Query resources by tag, batch add and delete tags, and query resource tags.

+

Log Management

+

Query database slow query logs.

+
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0007.html b/docs/geminidb/api-ref/nosql_05_0007.html new file mode 100644 index 00000000..a7615d99 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0007.html @@ -0,0 +1,16 @@ + + +

Calling APIs

+

+
+
+ +
+ diff --git a/docs/geminidb/api-ref/nosql_05_0008.html b/docs/geminidb/api-ref/nosql_05_0008.html new file mode 100644 index 00000000..e9a94c9e --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0008.html @@ -0,0 +1,171 @@ + + +

Making an API Request

+

This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is used to authenticate the calling of other APIs.

+

Request URI

A request URI consists of the following:

+

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

+

Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be separately transmitted, rather than being conveyed in a request message separately.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 URI parameter description

Parameter

+

Description

+

URI-scheme

+

Protocol used to transmit requests. All APIs use HTTPS.

+

Endpoint

+

Domain name or IP address of the server bearing the REST service endpoint. The endpoint varies depending on services and regions. It can be obtained from Regions and Endpoints.

+

resource-path

+

Access path of an API for performing a specified operation. Obtain the path from the URI of the API. For example, the resource-path of the API for obtaining a user token is /v3/auth/tokens.

+

query-string

+

Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ? limit=10 indicates that up to 10 data records will be displayed.

+
+
+
+

Request Methods

The HTTP protocol defines the following request methods that can be used to send a request to the server: +
+ + + + + + + + + + + + + + + + +
Table 2 HTTP methods

Method

+

Description

+

GET

+

Requests a server to return specified resources.

+

PUT

+

Requests a server to update specified resources.

+

POST

+

Requests a server to add a resource or perform a special operation.

+

DELETE

+

Requests a server to delete a specified resource (for example, an object).

+
+
+
+

For example, in the URI for obtaining a user token, the request method is POST. The request is as follows:

+
POST https://{{endpoint}}/v3/auth/tokens
+
+

Request Header

You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, add Content-Type that defines a request body type to request for authentication information.

+
Table 3 lists common request header fields. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Common request headers

Parameter

+

Description

+

Mandatory

+

Example Value

+

Content-Type

+

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

+

Yes

+

application/json

+

Content-Length

+

Length of the request body. The unit is byte.

+

This field is optional for POST requests, but must be left blank for GET requests.

+

3495

+

X-Project-Id

+

Project ID. To obtain the project ID, see Obtaining a Project ID.

+

No

+

e9993fc787d94b6c886cbaa340f9c0f4

+

X-Auth-Token

+

User token.

+

After a request is processed, the value of X-Subject-Token in the header is the token value.

+

Yes

+

The following is part of an example token:

+

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

+
+
+
+

The API used to obtain a user token does not require authentication. Therefore, this API only requires adding the Content-Type field. The following is an example request:

+
POST https://{{endpoint}}/v3/auth/tokens
+Content-Type: application/json
+
+

(Optional) Request Body

This part is optional. The request body is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. If the request body contains full-width characters, these characters must be coded in UTF-8.

+

Request bodies vary depending on APIs. Some APIs do not require a request body, such as the APIs requested using the GET and DELETE methods.

+

For the API of obtaining a user token, request parameters and parameter description can be obtained from the API request. The following is an example request with a body included. Replace username, domianname, ******** (login password), and xxxxxxxxxxxxxxxxxx (project name) with required values. You can obtain the values from Regions and Endpoints.

+

The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For details, see Obtaining a User Token.

+
+
+POST https://{{endpoint}}/v3/auth/tokens
+Content-Type: application/json
+
+{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "username",
+                    "password": "********",
+                    "domain": {
+                        "name": "domianname"
+                    }
+                }
+            }
+        },
+        "scope": {
+            "project": {
+                "name": "xxxxxxxxxxxxxxxxxx"
+            }
+        }
+    }
+}
+

If all data required for the API request is available, you can send a request to call an API through curl, Postman, or coding. For the API of obtaining a user token, x-subject-token in the response header is the required user token. Then, this token can be used to authenticate the calling of other APIs.

+
+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0009.html b/docs/geminidb/api-ref/nosql_05_0009.html new file mode 100644 index 00000000..f84c93b6 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0009.html @@ -0,0 +1,44 @@ + + +

Authentication

+

GeminiDB supports token-based authentication.

+

The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.

+
+

A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to a request to get permissions for calling the API.

+

If you want to use a token for authentication, you need to obtain the user's token and add X-Auth-Token to the request header of the service API to make an API call.

+

When you call an API to obtain a user token, set auth.scope in the request body to project.

+
{
+    "auth": {
+        "identity": {
+            "methods": [
+                "password"
+            ],
+            "password": {
+                "user": {
+                    "name": "username",
+                    "password": "password",
+                    "domain": {
+                        "name": "domainname"
+                    }
+                }
+            }
+        },
+        "scope": {
+            "project": {
+               "name": "xxxxxxxx"
+             }
+        }
+    }
+}
+

After a token is obtained, add field X-Auth-Token to the request header to specify the token when other APIs are called. For example, if the token is ABCDEFJ...., add X-Auth-Token: ABCDEFJ.... to a request header as follows:

+
 
+POST https://{{Endpoint}}/v3/auth/projects
+Content-Type: application/json 
+X-Auth-Token: ABCDEFJ....
+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0010.html b/docs/geminidb/api-ref/nosql_05_0010.html new file mode 100644 index 00000000..cff1e8c8 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0010.html @@ -0,0 +1,39 @@ + + +

Returned Values

+

Status Code

After you send a request, you will receive a response, including a status code, response header, and response body.

+

A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see Status Codes.

+

If status code 201 is returned for calling the API used to obtain a user token, the request is successful.

+
+

Response Header

Similar to a request, a response also has a header, for example, Content-Type.

+

Figure 1 shows the response header for the API used to obtain a user token, in which x-subject-token is the required user token. Then, this token can be used to authenticate the calling of other APIs.

+
Figure 1 Response header for the API used to obtain a user token
+
+

(Optional) Response Body

This part is optional. A response body is generally returned in a structured format (for example, JSON or XML), corresponding to Content-Type in the response header, and is used to transfer content other than the response header.

+
+

If the following information is returned for calling the API used to obtain a user token, the request is successful. The following describes part of the request body.

+
{
+    "token": {
+        "expires_at": "2019-02-13T06:52:13.855000Z",
+        "methods": [
+            "password"
+        ],
+        "catalog": [
+            {
+                "endpoints": [
+                    {
+                        "region_id": "aaa",
+......
+

If an error occurs during API calling, an error code and error message will be displayed. The following is an error response body:

+
{
+    "error_msg": "Parameter error",
+    "error_code": "DBS.200001"
+}
+

In the response, error_code indicates an error code, and error_msg describes the error.

+
+
+
+
Parent topic: Calling APIs
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0011.html b/docs/geminidb/api-ref/nosql_05_0011.html new file mode 100644 index 00000000..4da138d6 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0011.html @@ -0,0 +1,77 @@ + + +

Quick Start

+

This section describes how to create a GeminiDB Cassandra instance by calling APIs.

+

The token obtained from IAM is valid for only 24 hours. If you want to use a token for authentication, you can cache it to avoid frequently obtaining the token.

+
+

Involved APIs

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.

+ +
+

Procedure

  1. Use a token for authentication by referring to Authentication.
  2. Send POST https://{Endpoint}/v3/{project_id}/instances.
  3. Add X-Auth-Token to the request header.
  4. Transfer the following parameters in the request body:

    Values of region and availability_zone are only for reference.

    +

    For details about the API for creating instances, see Creating an Instance.

    +
    +
    {
+    "name": "test-cassandra-01",//Instance name
+    "datastore": {
+         "type": "cassandra",//Database type
+        "version": "3.11", //DB engine version
+        "storage_engine": "rocksDB"//Storage engine
+    },
+    "region": "aaa",//Region
+    "availability_zone": "bbb", //AZ
+    "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",//VPC ID
+    "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",//Subnet ID
+    "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",//Security group ID
+    "password": "xxxx",//Administrator password
+    "mode": "Cluster", //Instance type
+    "flavor": [
+        {
+            "num": 3,//Nodes
+            "size": 500,//Storage space
+            "storage": "ULTRAHIGH", //Disk type
+            "spec_code": "geminidb.cassandra.4xlarge.4" //Resource specification code
+        }
+    ],
+    "backup_strategy": {
+        "start_time": "08:00-09:00",//Backup time window
+        "keep_days": "8"//Retention period of backup files
+    },
+    "enterprise_project_id": "0"//Enterprise project ID
+}
    +

    If the following information is displayed, the request is successful:

    +
    {
+    "id": "39b6a1a278844ac48119d86512e0000bin06",
+    "name": "test-cassandra-01",
+    "datastore": {
+        "type": "cassandra",
+        "version": "3.11",
+        "storage_engine": "rocksDB"
+    },
+    "created": "2019-10-28 14:10:54",
+    "status": "creating",
+    "region": "aaa",
+    "availability_zone": "bbb",
+    "vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
+    "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",
+    "security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58",
+    "mode": "Cluster",
+    "flavor": [
+        {
+            "num": 3,
+            "size": 500,
+            "storage": "ULTRAHIGH",
+            "spec_code": "geminidb.cassandra.4xlarge.4"
+        }
+    ],
+    "backup_strategy": {
+        "start_time": "08:00-09:00",
+        "keep_days": "8"
+    },
+    "job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f",
+    "enterprise_project_id": "0"
+}
    +

    If the request fails, an error code and error information are returned. For details, see Error Codes.

    +
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0014.html b/docs/geminidb/api-ref/nosql_05_0014.html new file mode 100644 index 00000000..8b774bb9 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0014.html @@ -0,0 +1,646 @@ + + +

Creating an Instance

+

Function

This API can be used to create an instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/instances

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Instance name, which can be the same as an existing instance name.

+

The name must start with a letter and can include 4 to 64 characters. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

+

datastore

+

Yes

+

Datastore object

+

Database information.

+

region

+

Yes

+

String

+

Region ID.

+

The value cannot be empty. For value details, see Regions and Endpoints.

+

availability_zone

+

Yes

+

String

+

AZ ID.

+

For details about the value, see az_status returned in Querying Instance Specifications. If an instance can be created across three AZs, separate multiple AZ IDs by commas (,).

+

vpc_id

+

Yes

+

String

+

VPC ID. You can obtain the value with either of the following methods:

+
  • Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.
  • Method 2: See section "Querying VPCs" in the Virtual Private Cloud API Reference.
+

subnet_id

+

Yes

+

String

+

Subnet ID. You can obtain the subnet ID with either of the following methods:

+
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: See section "Querying Subnets" in the Virtual Private Cloud API Reference.
+

security_group_id

+

Yes

+

String

+

Security group ID. You can obtain the security group ID with either of the following methods:

+
  • Method 1: Log in to the VPC console. Choose Access Control > Security Groups in the navigation pane on the left. On the displayed page, click the target security group. You can view the security group ID on the displayed page.
  • Method 2: See section "Querying Security Groups" in the Virtual Private Cloud API Reference.
+

password

+

Yes

+

String

+

Database password.

+

The password can include 8 to 32 characters and contain uppercase letters, lowercase letters, digits, and the following special characters: ~!@#%^*-_=+?

+

Enter a strong password against security risks such as brute force cracking.

+

mode

+

Yes

+

String

+

Instance type. The value can be:

+
  • Cluster, indicating that GeminiDB Cassandra supports the cluster type.
+

flavor

+

Yes

+

Array of Flavor objects

+

Instance specifications.

+

For details about the specifications, see parameter values under flavors in Querying Instance Specifications.

+

configuration_id

+

No

+

String

+

Parameter template ID.

+

backup_strategy

+

No

+

BackupStrategy object

+

Advanced backup policy.

+

enterprise_project_id

+

No

+

String

+

Enterprise project ID.

+
  • Do not transfer this parameter if EPS is not enabled.
  • If EPS is enabled but this parameter is not transferred, the default enterprise project is used. For the enterprise project ID, see the id value in the enterprise_project field data structure table in section "Querying the Enterprise Project List" of the Enterprise Project Management Service API Reference.
+

ssl_option

+

No

+

String

+

Whether SSL is enabled.

+

The value can be:

+
  • 0, indicating that SSL is disabled by default.
  • 1, indicating that SSL is enabled by default.
  • If this parameter is not transferred, SSL is disabled by default.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 4 Datastore

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Database type.

+
  • If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
+

version

+

Yes

+

String

+

Database version. The value can be:

+
  • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
+

storage_engine

+

Yes

+

String

+

Storage engine.

+
  • rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Flavor

Parameter

+

Mandatory

+

Type

+

Description

+

num

+

Yes

+

String

+

Number of nodes.

+
  • Each GeminiDB Cassandra instance can contain 3 to 200 nodes.
+

size

+

Yes

+

String

+

Storage space. It must be an integer, in GB.

+ +

storage

+

Yes

+

String

+

Disk type.

+

If you set this parameter to ULTRAHIGH, SSD disks are used.

+

spec_code

+

Yes

+

String

+

Resource specification code.

+

For the code, see the value of response parameter spec_code in Querying Instance Specifications.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 6 BackupStrategy

Parameter

+

Mandatory

+

Type

+

Description

+

start_time

+

Yes

+

String

+

Backup time window. Automated backup will be triggered during the backup time window.

+

The value cannot be empty. It must be the UTC time in the hh:mm-HH:MM format.

+
  • The HH value must be 1 greater than the hh value.
  • The values of mm and MM must be the same and must be set to 00, 15, 30, or 45.
  • If this parameter is not transferred, the default backup time window is from 00:00 to 01:00.
  • Example value: 23:00–00:00
+

keep_days

+

No

+

String

+

Backup retention days.

+

The value ranges from 0 to 35.

+
  • If this parameter is set to 0, the automated backup policy is not set.
  • If this parameter is not transferred, the automated backup policy is enabled by default. Backup files are stored for 7 days by default.
+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Instance ID.

+

name

+

String

+

Instance name. This parameter is the same as the corresponding request parameter.

+

datastore

+

Datastore object

+

Database information. This parameter is the same as the corresponding request parameter.

+

created

+

String

+

Creation time, which is in the yyyy-mm-dd hh:mm:ss format.

+

status

+

String

+

Instance status. The value is creating.

+

region

+

String

+

Region ID. This parameter is the same as the corresponding request parameter.

+

availability_zone

+

String

+

AZ ID. This parameter is the same as the corresponding request parameter.

+

vpc_id

+

String

+

VPC ID. This parameter is the same as the corresponding request parameter.

+

subnet_id

+

String

+

Subnet ID. This parameter is the same as the corresponding request parameter.

+

security_group_id

+

String

+

Security group ID. This parameter is the same as the corresponding request parameter.

+

mode

+

String

+

Instance type. This parameter is the same as the corresponding request parameter.

+

flavor

+

Array of Flavor objects

+

Instance specifications. This parameter is the same as the corresponding request parameter.

+

backup_strategy

+

BackupStrategy object

+

Advanced backup policy. This parameter is the same as the corresponding request parameter.

+

ssl_option

+

String

+

Whether SSL is enabled. This parameter has the same effect as the corresponding request parameter.

+

job_id

+

String

+

ID of the job for creating an instance.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Datastore

Parameter

+

Type

+

Description

+

type

+

String

+

Database type.

+
  • If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
+

version

+

String

+

Database version. The value can be:

+
  • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
+

storage_engine

+

String

+

Storage engine.

+
  • rocksDB, indicating that the GeminiDB Cassandra instance support the RocksDB storage engine.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 9 Flavor

Parameter

+

Type

+

Description

+

num

+

String

+

Number of nodes.

+
  • Each GeminiDB Cassandra instance can contain 3 to 200 nodes.
+

size

+

String

+

Storage space. It must be an integer, in GB.

+ +

storage

+

String

+

Disk type.

+

If you set this parameter to ULTRAHIGH, SSD disks are used.

+

spec_code

+

String

+

Resource specification code.

+

For the code, see the value of response parameter spec_code in Querying Instance Specifications.

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 BackupStrategy

Parameter

+

Type

+

Description

+

start_time

+

String

+

Backup time window. Automated backup will be triggered during the backup time window.

+

The value cannot be empty. It must be the UTC time in the hh:mm-HH:MM format.

+
  • The HH value must be 1 greater than the hh value.
  • The values of mm and MM must be the same and must be set to 00, 15, 30, or 45.
  • If this parameter is not transferred, the default backup time window is from 00:00 to 01:00.
  • Example value: 23:00–00:00
+

keep_days

+

String

+

Backup retention days.

+

The value ranges from 0 to 35.

+
  • If this parameter is set to 0, the automated backup policy is not set.
  • If this parameter is not transferred, the automated backup policy is enabled by default. Backup files are stored for 7 days by default.
+
+
+
+

Example Requests

+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "id" : "39b6a1a278844ac48119d86512e0000bin06",
+  "name" : "test-cassandra-01",
+  "datastore" : {
+    "type" : "cassandra",
+    "version" : "3.11",
+    "storage_engine" : "rocksDB"
+  },
+  "created" : "2019-10-28 14:10:54",
+  "status" : "creating",
+  "region" : "aaa",
+  "availability_zone" : "bbb,ccc,ddd",
+  "vpc_id" : "490a4a08-ef4b-44c5-94be-3051ef9e4fce",
+  "subnet_id" : "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f",
+  "security_group_id" : "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5",
+  "mode" : "Cluster",
+  "flavor" : [ {
+    "num" : 3,
+    "size" : 500,
+    "storage" : "ULTRAHIGH",
+    "spec_code" : "geminidb.cassandra.4xlarge.4"
+  } ],
+  "backup_strategy" : {
+    "start_time" : "08:15-09:15",
+    "keep_days" : "8"
+  },
+  "ssl_option" : "1",
+  "job_id" : "c010abd0-48cf-4fa8-8cbc-090f093eaa2f"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0015.html b/docs/geminidb/api-ref/nosql_05_0015.html new file mode 100644 index 00000000..3bb279c1 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0015.html @@ -0,0 +1,106 @@ + + +

Deleting an Instance

+

Function

This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+
+

Example Requests

URI example
DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02
+
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0016.html b/docs/geminidb/api-ref/nosql_05_0016.html new file mode 100644 index 00000000..8d1af08d --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0016.html @@ -0,0 +1,698 @@ + + +

Querying Instances and Details

+

Function

This API is used to query instances and details based on specified conditions.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/instances

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Instance ID.

+

If you enter an instance ID starting with an asterisk (*), fuzzy search results are returned. If you enter a valid instance ID, an exact result is returned.

+

name

+

No

+

String

+

Instance name.

+

If you enter an instance name starting with an asterisk (*), fuzzy search results are returned. If you enter a valid instance name, an exact result is returned.

+

datastore_type

+

No

+

String

+

Database type. The value can be:

+

cassandra, indicating that GeminiDB Cassandra instances are queried.

+

+

mode

+

No

+

String

+

Instance type. The value can be:

+

Cluster, indicating that GeminiDB Cassandra cluster instances are queried.

+

The system ignores this parameter if parameter datastore_type is not transferred.

+

vpc_id

+

No

+

String

+

VPC ID. You can obtain the value with either of the following methods:

+
  • Method 1: Log in to the VPC console and view the VPC ID on the VPC details page.
  • Method 2: See section "Querying VPCs" in the Virtual Private Cloud API Reference.
+

subnet_id

+

No

+

String

+

Subnet ID. You can obtain the subnet ID with either of the following methods:

+
  • Method 1: Log in to the VPC console and click the target subnet on the Subnets page. You can view the network ID on the displayed page.
  • Method 2: See section "Querying Subnets" in the Virtual Private Cloud API Reference.
+

offset

+

No

+

Integer

+

Index position. The query starts from the next instance creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.

+

The value must be no less than 0. If this parameter is not transferred, the index offset is 0 by default, indicating that the query starts from the latest created instance.

+

limit

+

No

+

Integer

+

Maximum number of instances that can be queried.

+

The value ranges from 1 to 100. If this parameter is not transferred, the first 100 instances are queried by default.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

instances

+

Array of ListInstancesResult objects

+

Instance information.

+

total_count

+

Integer

+

Total number of records.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ListInstancesResult

Parameter

+

Type

+

Description

+

id

+

String

+

Instance ID.

+

name

+

String

+

Instance name.

+

status

+

String

+

Instance status.

+

The value can be:

+
  • normal, indicating that the instance is running normally.
  • abnormal, indicating that the instance is abnormal.
  • creating, indicating that the instance is being created.
  • frozen, indicating that the instance is frozen.
  • data_disk_full, indicating that the instance disk is full.
  • createfail, indicating that the instance failed to be created.
  • enlargefail, indicating that nodes failed to be added to the instance.
+

port

+

String

+

Database port.

+

mode

+

String

+

Instance type. This parameter is the same as the corresponding request parameter.

+

region

+

String

+

Region where the instance is deployed.

+

datastore

+

ListInstancesDatastoreResult object

+

Database information.

+

engine

+

String

+

Storage engine.

+

The value is rocksDB.

+

created

+

String

+

Instance creation time.

+

updated

+

String

+

Time when an instance is updated.

+

db_user_name

+

String

+

Default username. The value is rwuser.

+

vpc_id

+

String

+

VPC ID.

+

subnet_id

+

String

+

Subnet ID.

+

One GeminiDB Cassandra instance may use multiple subnets. For the subnet ID, see Table 10.

+

security_group_id

+

String

+

Security group ID.

+

backup_strategy

+

ListInstancesBackupStrategyResult object

+

Backup policy.

+

pay_mode

+

String

+

The value is 0.

+

maintenance_window

+

String

+

Maintenance time window.

+

groups

+

Array of ListInstancesGroupResult objects

+

Group information.

+

enterprise_project_id

+

String

+

Enterprise project ID.

+

If you set this parameter to 0, the resource belongs to the default enterprise project.

+

time_zone

+

String

+

Time zone.

+

actions

+

Array of strings

+

Operation that is executed on the instance. Example values:

+
  • CREATE
  • REBOOT
  • RESTORE
+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 ListInstancesDatastoreResult

Parameter

+

Type

+

Description

+

type

+

String

+

DB API.

+

version

+

String

+

DB version number.

+

whole_version

+

String

+

Complete database version number. This parameter is available only to GeminiDB Cassandra.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 ListInstancesBackupStrategyResult

Parameter

+

Type

+

Description

+

start_time

+

String

+

Backup time window. Automated backup will be triggered during the backup time window. The current time is the UTC time.

+

keep_days

+

Integer

+

Backup retention days. The value ranges from 0 to 35.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 8 ListInstancesGroupResult

Parameter

+

Type

+

Description

+

id

+

String

+

Group ID.

+

status

+

String

+

Group status.

+

The value can be:

+
  • normal, indicating that the group is normal.
  • abnormal, indicating that the group is abnormal.
  • creating, indicating that the group is being created.
  • createfail, indicating that the group failed to be created.
  • deleted: indicating that the group has been deleted.
  • resizefailed: indicating that the group specifications failed to be changed.
  • enlargefail: indicating the group failed to be scaled out.
+

volume

+

Volume object

+

Volume information.

+

nodes

+

Array of ListInstancesNodeResult objects

+

Node information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 Volume

Parameter

+

Type

+

Description

+

size

+

String

+

Storage space in GB.

+

used

+

String

+

Used storage space, in GB.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 10 ListInstancesNodeResult

Parameter

+

Type

+

Description

+

id

+

String

+

Node ID.

+

name

+

String

+

Node name.

+

status

+

String

+

Node status.

+

The value can be:

+
  • normal, indicating that the node is running normally.
  • abnormal, indicating that the node is abnormal.
  • creating, indicating that the node is being created.
  • createfail, indicating that the node failed to be created.
  • deleted, indicating that the node has been deleted.
  • resizefailed: indicating that the node specifications failed to be changed.
  • enlargefail: indicating nodes failed to be added.
+

subnet_id

+

String

+

ID of the subnet where the instance node is deployed.

+

private_ip

+

String

+

Private IP address of the node. This parameter value is available after an ECS is created. Otherwise, the value is "".

+

public_ip

+

String

+

Bound EIP. This parameter is valid only for nodes bound with EIPs.

+

spec_code

+

String

+

Resource specification code. For the code, see the value of parameter flavors.spec_code in Querying Instance Specifications.

+

availability_zone

+

String

+

AZ.

+

support_reduce

+

Boolean

+

Whether instance nodes can be deleted. The value can be:

+
  • true, indicating that instance nodes can be deleted.
  • false, indicating that instance nodes cannot be deleted.
+
+
+
+

Example Requests

+ +
+

Example Responses

Status code: 200

+

Success

+
{
+  "instances" : [ {
+    "id" : "8436a91546294036b75931e879882200in06",
+    "name" : "nno-efa6",
+    "status" : "normal",
+    "port" : "8635",
+    "mode" : "Cluster",
+    "region" : "aaa",
+    "datastore" : {
+      "type" : "cassandra",
+      "version" : "3.11",
+      "patch_available" : false
+    },
+    "engine" : "rocksDB",
+    "created" : "2019-01-17T07:05:52",
+    "updated" : "2019-01-17T07:05:47",
+    "db_user_name" : "rwuser",
+    "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
+    "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+    "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
+    "backup_strategy" : {
+      "start_time" : "16:00-17:00",
+      "keep_days" : 7
+    },
+    "pay_mode" : 0,
+    "maintenance_window" : "02:00-06:00",
+    "groups" : [ {
+      "id" : "0b0ff12541794e1084f6827e424be2d6gr06",
+      "status" : "creating",
+      "volume" : {
+        "size" : 100,
+        "used" : 0.003
+      },
+      "nodes" : [ {
+        "id" : "233eaac9c6f245c0bb9c2d21eea12d1bno06",
+        "name" : "nosql-efa6_priam_node_2",
+        "status" : "normal",
+        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+        "private_ip" : "192.168.0.174",
+        "spec_code" : "geminidb.cassandra.xlarge.4",
+        "availability_zone" : "bbb"
+      }, {
+        "id" : "d57d76d6320a4a7b86db82c317550c4ano02",
+        "name" : "nosql-efa6_priam_node_1",
+        "status" : "normal",
+        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+        "private_ip" : "192.168.0.39",
+        "spec_code" : "geminidb.cassandra.xlarge.4",
+        "availability_zone" : "bbb"
+      }, {
+        "id" : "f46b0a1cf4d9400e9fd7af17f8742d37no02",
+        "name" : "nosql-efa6_priam_node_3",
+        "status" : "normal",
+        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+        "private_ip" : "192.168.0.176",
+        "spec_code" : "geminidb.cassandra.xlarge.4",
+        "availability_zone" : "bbb"
+      } ]
+    } ],
+      "enterprise_project_id" : "0",
+      "time_zone" : "",
+      "actions" : [ "CREATE" ]
+  }, {
+    "id" : "1236a91546294036b75931e879882200in06",
+    "name" : "nosql-efa7",
+    "status" : "Cluster",
+    "port" : "8635",
+    "mode" : "ReplicaSet",
+    "region" : "aaa",
+    "datastore" : {
+      "type" : "cassandra",
+      "version" : "3.11",
+      "patch_available" : false
+    },
+    "engine" : "rocksDB",
+    "created" : "2019-01-17T07:05:52",
+    "updated" : "2019-01-17T07:05:47",
+    "db_user_name" : "rwuser",
+    "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961",
+    "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+    "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58",
+    "backup_strategy" : {
+      "start_time" : "16:00-17:00",
+      "keep_days" : 7
+    },
+    "pay_mode" : 0,
+    "maintenance_window" : "02:00-06:00",
+    "groups" : [ {
+      "id" : "0b0ff12541794e1084f6827e424be2d1gr07",
+      "status" : "creating",
+      "volume" : {
+        "size" : 100,
+        "used" : 0.003
+      },
+      "nodes" : [ {
+        "id" : "233eaac9c6f245c0bb9c2d21eea12d1bno06",
+        "name" : "nosql-efa7_priam_node_2",
+        "status" : "normal",
+        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+        "private_ip" : "192.168.0.174",
+        "spec_code" : "geminidb.cassandra.xlarge.4",
+        "availability_zone" : "bbb"
+      }, {
+        "id" : "d57d76d6320a4a7b86db82c317550c4ano02",
+        "name" : "nosql-efa7_priam_node_1",
+        "status" : "normal",
+        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+        "private_ip" : "192.168.0.39",
+        "spec_code" : "geminidb.cassandra.xlarge.4",
+        "availability_zone" : "bbb"
+      }, {
+        "id" : "f46b0a1cf4d9400e9fd7af17f8742d37no02",
+        "name" : "nosql-efa7_prima_node_3",
+        "status" : "normal",
+        "role" : "Secondary",
+        "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007b",
+        "private_ip" : "192.168.0.176",
+        "spec_code" : "geminidb.cassandra.xlarge.4",
+        "availability_zone" : "bbb"
+      } ]
+    } ],
+      "enterprise_project_id" : "0",
+      "time_zone" : "",
+      "actions" : [ "CREATE" ]
+  } ],
+  "total_count" : 2
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0050.html b/docs/geminidb/api-ref/nosql_05_0050.html new file mode 100644 index 00000000..6d1c65c0 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0050.html @@ -0,0 +1,134 @@ + + +

Scaling Up Storage Space of an Instance

+

Function

This API is used to scale up storage space of an instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/extend-volume

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

size

+

Yes

+

Integer

+

Requested storage space. It must be an integer greater than the current storage space.

+

The maximum storage space depends on the API type and specifications.

+ +
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0051.html b/docs/geminidb/api-ref/nosql_05_0051.html new file mode 100644 index 00000000..08531c0d --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0051.html @@ -0,0 +1,142 @@ + + +

Adding Nodes for an Instance

+

Function

This API is used to add nodes for a specified instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-node

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

num

+

Yes

+

Integer

+

Number of new nodes.

+

subnet_id

+

No

+

String

+

ID of the subnet where the new node is deployed.

+
  • This parameter can be transferred when nodes are added to the GeminiDB Cassandra database instances.
  • The transferred subnet ID must belong to the VPC where the current instance is deployed.
  • If this parameter is not transferred, the system will allocate a subnet with sufficient IP addresses for the new node.
+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0052.html b/docs/geminidb/api-ref/nosql_05_0052.html new file mode 100644 index 00000000..e11827d1 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0052.html @@ -0,0 +1,148 @@ + + +

Deleting Nodes from a Specified Instance

+

Function

This API is used to delete nodes from a specified instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/reduce-node

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

num

+

No

+

Integer

+

Number of nodes to be deleted randomly.

+

For GeminiDB Cassandra instances, the value ranges from 1 to 10.

+
NOTE:

If users connect to nodes using the client, do no choose to delete node randomly.

+
+

node_list

+

No

+

Array of strings

+

ID of the node to be deleted. Make sure that the node can be deleted. If this parameter is not transferred, the number of nodes to be deleted is based on the internal policy of the system.

+
NOTE:
  • Either num or node_list must be set.
    • If node_list is transferred, its value can contain 1 to 10 characters for GeminiDB Cassandra.
    • If num and node_list are both transferred, the value of node_list takes effect.
    +
  • If node_list is empty, instance nodes are deleted randomly. If node_list is not empty, only the node whose ID is specified is deleted.
  • Before a node is deleted, do not connect to the node directly to avoid service interruptions.
+
+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID. This parameter is returned only for pay-per-use instances.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0100.html b/docs/geminidb/api-ref/nosql_05_0100.html new file mode 100644 index 00000000..0d1e826f --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0100.html @@ -0,0 +1,164 @@ + + +

Changing Specifications of an Instance

+

Function

This API is used to change specifications of an instance.

+

Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution when performing this operation.

+
+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

This API can be used to scale up or down specifications of an instance.

+

The new specifications cannot be the same as the original specifications.

+

Specifications can be modified only when the instance status is normal.

+

If specifications cannot meet the requirements for running the instance, the specifications cannot be changed.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

resize

+

Yes

+

ResizeInstanceOption object

+

Target specification information.

+
+
+ +
+ + + + + + + + + + + +
Table 4 ResizeInstanceOption

Parameter

+

Mandatory

+

Type

+

Description

+

target_spec_code

+

Yes

+

String

+

Target resource specification code.

+

For the code, see the value of response parameter flavors.spec_code in Querying Instance Specifications.

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0101.html b/docs/geminidb/api-ref/nosql_05_0101.html new file mode 100644 index 00000000..414204cc --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0101.html @@ -0,0 +1,115 @@ + + +

Resetting the Administrator Password of an Instance

+

Function

This API is used to reset the administrator password of an instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

Abnormal instances do not support this operation.

+

Only the password of user rwuser can be reset.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

password

+

Yes

+

String

+

Database password.

+

The password can include 8 to 32 characters and contain uppercase letters, lowercase letters, digits, and a combination of any two of the following special characters: ~!@#%^*-_=+?

+

Enter a strong password against security risks such as brute force cracking.

+
+
+
+

Response Parameters

Status code: 204

+

No response parameters

+
+

Example Requests

+
+

Example Responses

Status code: 204

+

No Content

+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0102.html b/docs/geminidb/api-ref/nosql_05_0102.html new file mode 100644 index 00000000..30d7dad8 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0102.html @@ -0,0 +1,113 @@ + + +

Editing the Name of an Instance

+

Function

This API is used to edit the name of an instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

The name of the instance that is being created or fails to be created cannot be edited.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

New instance name.

+

The name:

+

Must start with a letter and can include 4 to 64 characters. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).

+
+
+
+

Response Parameters

Status code: 204

+

No response parameters

+
+

Example Requests

+
+

Example Responses

None

+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_05_0103.html b/docs/geminidb/api-ref/nosql_05_0103.html new file mode 100644 index 00000000..a893ed6b --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0103.html @@ -0,0 +1,134 @@ + + +

Changing the Security Group of an Instance

+

Function

This API is used to change the security group associated with an instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

Abnormal instances do not support this operation.

+

Please confirm the modified security group rule. This policy may affect connections to the current instance, interrupting services.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/security-group

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

security_group_id

+

Yes

+

String

+

ID of the new security group.

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 202

+

No Content

+
{
+  "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Instances
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0002.html b/docs/geminidb/api-ref/nosql_06_0002.html new file mode 100644 index 00000000..9d6bd568 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0002.html @@ -0,0 +1,247 @@ + + +

Obtaining Parameter Templates

+

Function

This API is used to obtain parameter templates, including all of the default and custom parameter templates.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

GET https://{Endpoint}/v3.1/{project_id}/configurations

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Index offset.

+
  • If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data.
  • The value must be a positive integer.
+

limit

+

No

+

Integer

+

Maximum number of instances that can be queried.

+
  • The value ranges from 1 to 100.
  • If this parameter is not transferred, the first 100 records are queried by default.
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

count

+

Integer

+

Total number of records.

+

quota

+

Integer

+

Maximum number of custom parameter templates that a user can create.

+

configurations

+

Array of ListConfigurationsResult objects

+

Parameter templates.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ListConfigurationsResult

Parameter

+

Type

+

Description

+

id

+

String

+

Parameter template ID.

+

name

+

String

+

Parameter template name.

+

description

+

String

+

Parameter template description.

+

datastore_version_name

+

String

+

Database version name.

+

datastore_name

+

String

+

Database name.

+

created

+

String

+

Creation time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

updated

+

String

+

Update time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

mode

+

String

+

Instance type. The value can be:

+

Cluster, indicating that the instance is of the GeminiDB Cassandra cluster type.

+

Cluster, indicating that the instance is of the GeminiDB Influx cluster type.

+

user_defined

+

Boolean

+

Whether the parameter template is a custom template. The value can be:

+
  • false, indicating that the parameter template is a default parameter template.
  • true, indicating that the parameter template is a custom template.
+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations?offset=0&limit=10
+
+
+

Example Responses

Status code: 200

+

Success

+
{
+  "count" : 2,
+  "quota": 100,
+  "configurations" : [ {
+    "id" : "887ea0d1bb0843c49e8d8e5a09a95652pr06",
+    "name" : "configuration_test",
+    "description" : "configuration_test",
+    "datastore_version_name" : "3.11",
+    "datastore_name" : "cassandra",
+    "created" : "2019-05-15T11:53:34+0000",
+    "updated" : "2019-05-15T11:53:34+0000",
+    "mode": "Cluster",
+    "user_defined" : true
+  }, {
+    "id" : "3bc1e9cc0d34404b9225ed7a58fb284epr06",
+    "name" : "Default-Cassandra-3.11",
+    "description" : "Default parameter group for cassandra 3.11",
+    "datastore_version_name" : "3.11",
+    "datastore_name" : "cassandra",
+    "created" : "2019-05-27T03:38:51+0000",
+    "updated" : "2019-05-27T03:38:51+0000",
+    "mode": "Cluster",
+    "user_defined" : false
+  } ]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0003.html b/docs/geminidb/api-ref/nosql_06_0003.html new file mode 100644 index 00000000..5177d707 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0003.html @@ -0,0 +1,266 @@ + + +

Creating a Parameter Template

+

Function

This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

The new parameter template cannot have the same name as any existing parameter template.

+

For configuration item values, you can enter system-defined parameters that allow for modification.

+
+

URI

POST https://{Endpoint}/v3/{project_id}/configurations

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Parameter template name. It can include a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).

+

description

+

No

+

String

+

Parameter template description. It can contain a maximum of 256 characters except the following special characters: >!<"&'= The value is left blank by default.

+

values

+

No

+

Map<String,String>

+

Parameter values defined by users based on a default parameter template. Keep the parameter values unchanged by default.

+

datastore

+

Yes

+

ConfigurationDatastoreOption object

+

Database object.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ConfigurationDatastoreOption

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

Yes

+

String

+

Database type. The value can be:

+

cassandra, indicating that the instances are of the GeminiDB Cassandra type.

+

version

+

Yes

+

String

+

Database version. The value can be:

+

3.11, indicating that GeminiDB Cassandra 3.11 is supported.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

configuration

+

ConfigurationResult object

+

Parameter template information.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 ConfigurationResult

Parameter

+

Type

+

Description

+

id

+

String

+

Parameter template ID.

+

name

+

String

+

Parameter template name.

+

datastore_version_name

+

String

+

Database version name.

+

datastore_name

+

String

+

Database name.

+

description

+

String

+

Parameter template description

+

created

+

String

+

Creation time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

updated

+

String

+

Update time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Success

+
{
+  "configuration" : {
+    "id" : "463b4b58d0e84e2b95605dea4552fdpr06",
+    "name" : "configuration_test",
+    "datastore_version_name" : "3.11",
+    "datastore_name" : "cassandra",
+    "description" : "configuration_test",
+    "created" : "2020-03-09T08:27:56+0800",
+    "updated" : "2020-03-09T08:27:56+0800"
+  }
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0004.html b/docs/geminidb/api-ref/nosql_06_0004.html new file mode 100644 index 00000000..0e53dab3 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0004.html @@ -0,0 +1,137 @@ + + +

Modifying Parameters in a Parameter Template

+

Function

This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

The modified parameter template name must be different from the name of any existing or default parameter template.

+

Default parameter templates cannot be modified.

+

For configuration item values, you can enter system-defined parameters that allow for modification.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

config_id

+

Yes

+

String

+

Parameter template ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Parameter template name. It can include a maximum of 64 characters and can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).

+

description

+

No

+

String

+

Parameter template description. It can include a maximum of 256 characters and cannot contain the following special characters: >!<"&'= The value is left blank by default.

+

values

+

No

+

Map<String,String>

+

Parameter values defined by users based on a default parameter template. If this parameter is not specified, no parameter values are to be changed.

+
+
+
+

Response Parameters

Status code: 200

+

No response parameters

+
+

Example Requests

+
+

Example Responses

None

+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0005.html b/docs/geminidb/api-ref/nosql_06_0005.html new file mode 100644 index 00000000..6186dea6 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0005.html @@ -0,0 +1,142 @@ + + +

Applying a Parameter Template

+

Function

This API is used to apply a parameter template to one or more instances.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

This API is an asynchronous API. A successful response does not indicate that the parameter template is successfully applied.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

config_id

+

Yes

+

String

+

Parameter template ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

instance_ids

+

Yes

+

Array of strings

+

Instance IDs.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the asynchronous task that applies the parameter template.

+

success

+

Boolean

+

Whether the task for applying the parameter template is successfully submitted. The value can be:

+
  • true, indicating the task is successfully submitted.
  • false, indicating the task fails to be submitted.
+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Success

+
{
+  "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
+  "success" : true
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0006.html b/docs/geminidb/api-ref/nosql_06_0006.html new file mode 100644 index 00000000..e4e45883 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0006.html @@ -0,0 +1,145 @@ + + +

Modifying Parameters of a Specified Instance

+

Function

This API is used to modify parameters of a specified instance.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+

For configuration item values, you can enter system-defined parameters that allow for modification.

+

This API is an asynchronous API. A successful response does not indicate that the parameters are successfully modified.

+
+

URI

PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

values

+

Yes

+

Map<String,String>

+

Parameter values defined by users based on a default parameter template.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

job_id

+

String

+

ID of the asynchronous task for modifying instance parameters.

+

restart_required

+

Boolean

+

Whether the instance needs to be restarted. The value can be:

+
  • true, indicating that the instance needs to be restarted.
  • false, indicating that the instance does not need to be restarted.
+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Success

+
{
+  "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
+  "restart_required" : false
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0007.html b/docs/geminidb/api-ref/nosql_06_0007.html new file mode 100644 index 00000000..c7442f6d --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0007.html @@ -0,0 +1,229 @@ + + +

Querying Instance Parameter Settings

+

Function

This API is used to query instance parameter settings.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

datastore_version_name

+

String

+

Database version name.

+

datastore_name

+

String

+

Database name.

+

created

+

String

+

Creation time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

updated

+

String

+

Update time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

id

+

String

+

Parameter template ID.

+

mode

+

String

+

Instance type. The value can be:

+

Cluster, indicating that the instance is of the GeminiDB Cassandra cluster type.

+

Cluster, indicating that the instance is of the GeminiDB Influx cluster type.

+

configuration_parameters

+

Array of ConfigurationParameterResult objects

+

Parameters defined by users based on a default parameter template.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ConfigurationParameterResult

Parameter

+

Type

+

Description

+

name

+

String

+

Parameter name.

+

value

+

String

+

Parameter value.

+

restart_required

+

Boolean

+

Whether the instance needs to be restarted. The value can be:

+
  • false, indicating that the instance does not need to be restarted.
  • true, indicating that the instance needs to be restarted.
+

readonly

+

Boolean

+

Whether the parameter is read-only. The value can be:

+
  • false, indicating that the parameter is not read-only.
  • true, indicating that the parameter is read-only.
+

value_range

+

String

+

Value range. For example, the value of the Integer type ranges from 0 to 1, and the value of the Boolean type is true or false.

+

type

+

String

+

Parameter type. The value can be string, integer, boolean, list, or float.

+

description

+

String

+

Parameter description.

+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/configurations
+
+
+

Example Responses

Status code: 200

+

Success

+
{
+  "datastore_version_name" : "3.11",
+  "datastore_name" : "cassandra",
+  "created" : "2020-03-21 11:40:44",
+  "updated" : "2020-03-21 11:40:44",
+  "id": "9ad6bc82146e4043a50c963ab3bf09adpr06",
+  "mode": "Cluster",
+  "configuration_parameters" : [ {
+    "name" : "concurrent_reads",
+    "value" : "64",
+    "restart_required" : true,
+    "readonly" : true,
+    "value_range" : "4-512",
+    "type" : "integer",
+    "description" : "Number of concurrent read threads."
+  } ]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0008.html b/docs/geminidb/api-ref/nosql_06_0008.html new file mode 100644 index 00000000..6b786f03 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0008.html @@ -0,0 +1,235 @@ + + +

Obtaining Parameters of a Specified Parameter Template

+

Function

This API is used to obtain information about parameters of a specified parameter template.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

config_id

+

Yes

+

String

+

Parameter template ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Parameter template ID.

+

name

+

String

+

Parameter template name.

+

description

+

String

+

Parameter template description.

+

datastore_version_name

+

String

+

Database version name.

+

datastore_name

+

String

+

Database name.

+

created

+

String

+

Creation time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

updated

+

String

+

Update time in the yyyy-MM-ddTHH:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

configuration_parameters

+

Array of ConfigurationParameterResult objects

+

Parameters defined by users based on a default parameter template.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 ConfigurationParameterResult

Parameter

+

Type

+

Description

+

name

+

String

+

Parameter name.

+

value

+

String

+

Parameter value.

+

restart_required

+

Boolean

+

Whether the instance needs to be restarted. The value can be:

+
  • false, indicating that the instance does not need to be restarted.
  • true, indicating that the instance needs to be restarted.
+

readonly

+

Boolean

+

Whether the parameter is read-only. The value can be:

+
  • false, indicating that the parameter is not read-only.
  • true, indicating that the parameter is read-only.
+

value_range

+

String

+

Value range. For example, the value of the Integer type ranges from 0 to 1, and the value of the Boolean type is true or false.

+

type

+

String

+

Parameter type. The value can be string, integer, boolean, list, or float.

+

description

+

String

+

Parameter description.

+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
+
+
+

Example Responses

Status code: 200

+

Success

+
{
+  "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr06",
+  "name" : "default-cassandra-3.11",
+  "datastore_version_name" : "3.11",
+  "datastore_name" : "cassandra",
+  "description" : "Default parameter group for cassandra 3.11",
+  "created" : "2020-03-21T04:40:51+0800",
+  "updated" : "2020-03-21T04:40:51+0800",
+  "configuration_parameters" : [ {
+    "name" : "concurrent_reads",
+    "value" : "64",
+    "restart_required" : true,
+    "readonly" : true,
+    "value_range" : "4-512",
+    "type" : "integer",
+    "description" : "Number of concurrent read threads."
+  } ]
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_06_0009.html b/docs/geminidb/api-ref/nosql_06_0009.html new file mode 100644 index 00000000..6f8fa236 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0009.html @@ -0,0 +1,84 @@ + + +

Deleting a Parameter Template

+

Function

This API is used to delete a specified parameter template.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

config_id

+

Yes

+

String

+

Parameter template ID.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+

No response parameters

+
+

Example Requests

URI example
DELETE https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
+
+
+

Example Responses

None

+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Parameter Templates
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_08_0001.html b/docs/geminidb/api-ref/nosql_08_0001.html new file mode 100644 index 00000000..30562d38 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_08_0001.html @@ -0,0 +1,470 @@ + + +

Events Supported by Event Monitoring

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Events Supported by Event Monitoring for GeminiDB

Event Source

+

Event Name

+

Event ID

+

Event Severity

+

Description

+

Solution

+

Impact

+

NoSQL

+

Instance creation failure

+

NoSQLCreateInstanceFailed

+

Major

+

The instance quota or underlying resources are insufficient.

+

Release the instances that are no longer used and try to provision them again, or submit a service ticket to adjust the quota.

+

Instances fail to be created.

+

Specifications change failure

+

NoSQLResizeInstanceFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket to ask O&M personnel to coordinate resources, and then try again.

+

Services are interrupted.

+

Node adding failure

+

NoSQLAddNodesFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket to ask O&M personnel to coordinate resources, delete the node that failed to be added, and add a new one.

+

None

+

Node deletion failure

+

NoSQLDeleteNodesFailed

+

Major

+

Releasing underlying resources failed.

+

Delete the node again.

+

None

+

Storage space scale-up failure

+

+

NoSQLScaleUpStorageFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket to ask O&M personnel to coordinate resources, and then try again.

+

Services may be interrupted.

+

Password resetting failure

+

NoSQLResetPasswordFailed

+

Major

+

Resetting the password times out.

+

Reset the password again.

+

None

+

Parameter template change failure

+

NoSQLUpdateInstanceParamGroupFailed

+

Major

+

Changing a parameter template times out.

+

Change the parameter template again.

+

None

+

Backup policy configuration failure

+

NoSQLSetBackupPolicyFailed

+

Major

+

The database connection is abnormal.

+

Configure the backup policy again.

+

None

+

Manual backup creation failure

+

NoSQLCreateManualBackupFailed

+

Major

+

The backup files fail to be exported or uploaded.

+

Submit a service ticket to O&M personnel.

+

Data cannot be backed up.

+

Automated backup creation failure

+

NoSQLCreateAutomatedBackupFailed

+

Major

+

The backup files fail to be exported or uploaded.

+

Submit a service ticket to O&M personnel.

+

Data cannot be backed up.

+

Instance status abnormal

+

NoSQLFaultyDBInstance

+

Major

+

This event is a key alarm event and is reported when an instance is faulty due to a disaster or a server failure.

+

Submit a service ticket.

+

The database service may be unavailable.

+

Instance status recovery

+

NoSQLDBInstanceRecovered

+

Major

+

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

+

No further action is required.

+

None

+

Node status abnormal

+

NoSQLFaultyDBNode

+

Major

+

This event is a key alarm event and is reported when a database node is faulty due to a disaster or a server failure.

+

Check whether the database service is available and submit a service ticket.

+

The database service may be unavailable.

+

Node status recovery

+

NoSQLDBNodeRecovered

+

Major

+

If a disaster occurs, NoSQL provides an HA tool to automatically or manually rectify the fault. After the fault is rectified, this event is reported.

+

No further action is required.

+

None

+

Primary/standby switchover or failover

+

NoSQLPrimaryStandbySwitched

+

Major

+

This event is reported when a primary/secondary switchover or a failover is triggered.

+

No further action is required.

+

None

+

Occurrence of hotspot partitioning keys

+

HotKeyOccurs

+

Major

+

Hotspot data is stored in one partition because the primary key is improper. Improper application design causes frequent read and write operations on a key.

+

1. Choose a proper partition key.

+

2. Add service cache so that service applications read hotspot data from the cache first.

+

The service request success rate is affected, and the cluster performance and stability deteriorates.

+

BigKey occurrence

+

BigKeyOccurs

+

Major

+

The primary key design is improper. There are too many records or too much data in a single partition, causing load imbalance on nodes.

+

1. Choose a proper partition key.

+

2. Add a new partition key for hashing data.

+

As more and more data is stored in the partition, cluster stability deteriorates.

+

Insufficient storage space

+

NoSQLRiskyDataDiskUsage

+

Major

+

The storage space is insufficient.

+

Scale up storage space. For details, see section "Scaling Up Storage Space" in the user guide of GeminiDB.

+

The instance is set to read-only and data cannot be written to the instance.

+

Data disk expanded and being writable

+

NoSQLDataDiskUsageRecovered

+

Major

+

The data disk has been expanded and becomes writable.

+

No further action is required.

+

None

+

Index creation failure

+

NoSQLCreateIndexFailed

+

Major

+

The service load exceeds what the instance specifications can take. In this case, creating indexes consumes more instance resources. As a result, the response is slow or even frame freezing occurs, and the creation times out.

+

Select matched instance specifications based on service load.

+

Create indexes during off-peak hours.

+

Create indexes in the background.

+

Select indexes as required.

+

The index fails to be created or is incomplete. Delete the index and create a new one.

+

Write speed decrease

+

NoSQLStallingOccurs

+

Major

+

The write speed is close to the maximum write speed allowed by the cluster scale and instance specifications. As a result, the database flow control mechanism is triggered, and requests may fail.

+

1. Adjust the cluster scale or node specifications based on the maximum write rate of services.

+

2. Measure the maximum write rate of services.

+

The success rate of service requests is affected.

+

Data write stopped

+

NoSQLStoppingOccurs

+

Major

+

The data write is too fast, reaching the maximum write capability allowed by the cluster scale and instance specifications. As a result, the database flow control mechanism is triggered, and requests may fail.

+

1. Change the cluster scale or node specifications based on the maximum write rate of services.

+

2. Measure the maximum write rate of services.

+

The success rate of service requests is affected.

+

Database restart failure

+

NoSQLRestartDBFailed

+

Major

+

The instance status is abnormal.

+

Submit a service ticket to O&M personnel.

+

The instance status may be abnormal.

+

Restoration to new instance failure

+

NoSQLRestoreToNewInstanceFailed

+

Major

+

The underlying resources are insufficient.

+

Submit a service ticket to ask O&M personnel to coordinate resources, and then add new nodes.

+

Data cannot be restored to a new instance.

+

Restoration to existing instance failure

+

NoSQLRestoreToExistInstanceFailed

+

Major

+

The backup file fails to be downloaded or restored.

+

Submit a service ticket to O&M personnel.

+

The current instance may be unavailable.

+

Backup file deletion failure

+

NoSQLDeleteBackupFailed

+

Major

+

The backup files fail to be deleted from OBS.

+

Delete the backup files again.

+

None

+

Failure to display slow query logs in plaintext

+

NoSQLSwitchSlowlogPlainTextFailed

+

Major

+

The DB API does not support this function.

+

Refer to the GeminiDB User Guide to check whether that the DB API supports the display of slow query logs in plaintext. Submit a service ticket to O&M personnel.

+

None

+

EIP binding failure

+

NoSQLBindEipFailed

+

Major

+

The node status is abnormal, an EIP has been bound to the node, or the EIP to be bound is invalid.

+

Check whether the node is normal and whether the EIP is valid.

+

The instance cannot be accessed from a public network.

+

EIP unbinding failure

+

NoSQLUnbindEipFailed

+

Major

+

The node status is abnormal or the EIP has been unbound from the node.

+

Check whether the node and EIP status are normal.

+

None

+

Parameter modification failure

+

NoSQLModifyParameterFailed

+

Major

+

The parameter value is invalid.

+

Check whether the parameter value is within the valid range and submit a service ticket to O&M personnel.

+

None

+

Parameter template application failure

+

NoSQLApplyParameterGroupFailed

+

Major

+

The instance status is abnormal. So, the parameter template cannot be applied.

+

Submit a service ticket to O&M personnel.

+

None

+

Enabling or disabling SSL failure

+

NoSQLSwitchSSLFailed

+

Major

+

Enabling or disabling SSL times out.

+

Try again or submit a service ticket. Do not change the connection mode.

+

The SSL connection mode cannot be changed.

+

Too much data in a single row

+

LargeRowOccurs

+

Major

+

If there is too much data in a single row, queries may time out, causing faults like OOM error.

+

1. Limit the write length of each column and row so that the key and value length of each row does not exceed the preset threshold.

+

2. Check whether there are abnormal writes or coding, causing large rows.

+

If there are too many records in a single row, cluster stability will deteriorate as the data volume increases.

+
+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_10_0100.html b/docs/geminidb/api-ref/nosql_10_0100.html new file mode 100644 index 00000000..1c09222d --- /dev/null +++ b/docs/geminidb/api-ref/nosql_10_0100.html @@ -0,0 +1,294 @@ + + +

Querying Tasks and Details

+

Function

This API is used to query tasks (by default) and details.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/jobs

+ +
+ + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Task ID.

+

start_time

+

No

+

String

+

Query start time in the "yyyy-mm-ddThh:mm:ssZ" format. The default value is 30 days before the current date.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

end_time

+

No

+

String

+

End time (the current time by default) in the "yyyy-mm-ddThh:mm:ssZ" format. It must be later than the start time and the time span cannot exceed 30 days.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

+

status

+

No

+

String

+

Task status. The value can be: Running, indicating that the task is being executed. Completed, indicating that the task is completed. Failed, indicating that the task fails.

+

name

+

No

+

String

+

Task name.

+
  • CreateInstance: Create an instance.
  • RestoreNewInstance: Restore data to a new instance.
  • EnlargeInstance: Add nodes.
  • ReduceInstance: Delete nodes.
  • RestartInstance: Restart an instance.
  • RestartNode: Restart a node.
  • EnlargeInstanceVolume: Scale up storage space of an instance.
  • ReduceInstanceVolume: Scale in storage space of an instance.
  • ResizeInstance: Change the specifications of an instance.
  • UpgradeDbVersion: Upgrade the engine version.
  • BindPublicIP: Bind an EIP to an instance.
  • UnbindPublicIP: Unbind an EIP from an instance.
  • DeleteInstance: Delete an instance.
  • EnlargeInstanceColdVolume: Scale up cold storage of an instance.
  • AddInstanceColdVolume: Enable cold storage for an instance.
  • ModifySecurityGroup: Modify a security group.
  • ModifyCcmCert: Modify a CCM certificate.
  • ModifyPort: Change a port.
  • ConstructDisasterRecovery: Establish a DR relationship.
  • DeConstructDisasterRecovery: Remove a DR relationship.
  • SwitchOverDisasterRecovery: Switch a DR relationship.
  • BuildBiActiveInstance: Create an instance with a dual-active DR relationship.
  • ReleaseBiActiveInstance: Remove a dual-active relationship from an instance.
  • BackupInstance: Back up an instance.
+

offset

+

No

+

Integer

+

Index offset.

+

If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.

+

limit

+

No

+

Integer

+

Number of records to be queried. The value can be 10, 20, or 50. The default value is 50.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

jobs

+

Array of objects (Table 5)

+

Task list.

+

total_count

+

Integer

+

Total number of tasks in the task list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 JobDetail

Parameter

+

Type

+

Description

+

id

+

String

+

Task ID.

+

name

+

String

+

Task name.

+

status

+

String

+

Task execution status. The value can be: Running, indicating that the task is being executed. Completed indicating that the task has been successfully executed. Failed indicating that the task fails to be executed.

+

start_time

+

String

+

Creation time in the "yyyy-mm-ddThh:mm:ssZ" format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.

+

end_time

+

String

+

End time in the yyyy-mm-ddThh:mm:ssZ format.

+

T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.

+

progress

+

String

+

Task execution progress.

+
NOTE:

The execution progress (such as "60%", indicating the task execution progress is 60%) is displayed only when the task is being executed. Otherwise, "" is returned.

+
+

instance

+

Objects in Table 6

+

Details of the instance associated with the task.

+

fail_reason

+

String

+

Task failure information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 JobInstanceInfo

Parameter

+

Type

+

Description

+

id

+

String

+

Instance ID.

+

name

+

String

+

Instance name.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Success

+
{ 
+  "total_count" : 1, 
+  "jobs" : [ { 
+    "id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e", 
+    "name" : "CreateCassandra", 
+    "status" : "Running", 
+    "start_time" : "2023-09-12T06:44:01+0000", 
+    "end_time" : "2023-09-12T06:44:03+0000", 
+    "progress" : "14%", 
+    "instance" : { 
+      "id" : "27a045b6bf9e46f691f81366d398cb04in06", 
+      "name" : "nosql-12f5" 
+    }, 
+    "fail_reason" : "" 
+  } ] 
+}
+
+

Status Codes

For details, see Status Codes.

+
+

Error Codes

For details, see Error Codes.

+
+
+
+
+
Parent topic: Task Management
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_abnormal_result.html b/docs/geminidb/api-ref/nosql_abnormal_result.html new file mode 100644 index 00000000..63df06fe --- /dev/null +++ b/docs/geminidb/api-ref/nosql_abnormal_result.html @@ -0,0 +1,47 @@ + + +

Abnormal Request Results

+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/geminidb/api-ref/nosql_api_0030.html b/docs/geminidb/api-ref/nosql_api_0030.html new file mode 100644 index 00000000..f8268a48 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_api_0030.html @@ -0,0 +1,228 @@ + + +

Querying an Automated Backup Policy

+

Function

This API is used to query an automated backup policy.

+
+

Constraints

This API supports GeminiDB Cassandra instances.

+
+

URI

GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

instance_id

+

Yes

+

String

+

Instance ID.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query parameters

Parameter

+

Mandatory

+

Type

+

Description

+

type

+

No

+

String

+

Backup policy type. This parameter is available only to GeminiDB Cassandra. The value can be:

+
  • Instance, indicating that an instance backup is queried.
  • DatabaseTable, indicating that a database or table backup is queried.
+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

Yes

+

String

+

User token.

+
+
+
+

Response Parameters

Status code: 202

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

backup_policy

+

object

+

Backup policy objects, including backup retention period (days) and start time For details, see Table 5.

+

database_tables

+

Array of objects

+

Database and table information in the backup. This parameter is available only to GeminiDB Cassandra. For details, see Table 6.

+
  • Keep this parameter empty or ignore it when you query an instance backup.
  • Remember to specify this parameter when you query a database or table backup (if any).
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ShowBackupPolicyResult

Parameter

+

Type

+

Description

+

keep_days

+

Integer

+

Backup retention days.

+

differential_period

+

String

+

Differential backup interval. Interval for automatic differential backup. Its value can be 30, 60, 180, 360, 720, or 1440. The unit is minute. If the value is 0, differential backup is disabled. Differential backup works based on incremental backup, and differential backup interval must be longer than incremental backup interval.

+

incremental_period

+

String

+

Incremental backup interval, in minutes. If the value is 0, incremental backup is disabled.

+

start_time

+

String

+

Backup time window. Automated backup will be triggered during the backup time window.

+

period

+

String

+

Backup period. After a backup period is specified, data will be automatically backed up on the selected days every week.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 QueryDatabaseTableInfo

Parameter

+

Type

+

Description

+

database_name

+

String

+

Database name.

+

table_names

+

Array of strings

+

Table names.

+
  • If this parameter is empty, database names are queried.
  • If this parameter is not empty, table names are queried.
+
+
+
+

Example Requests

URI example
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy?type=Instance
+
+
+

Example Responses

Status code: 202

+

Success

+

Response when an automated backup policy is enabled

+
{
+  "backup_policy" : {
+    "keep_days" : 7,
+    "start_time" : "19:00-20:00",
+    "period" : "1,2,4,5,6",
+    "incremental_period": "0",
+    "differential_period": "0"
+  }, 
+   "database_tables" : [ { 
+     "database_name" : "databaseNameA", 
+     "table_names" : [ "table_A", "table_B" ] 
+   }, { 
+     "database_name" : "databaseNameB", 
+     "table_names" : null 
+   } ] 
+}
+

Response when an automated backup policy is disabled

+

+

+
Status Codes
For details, see Status Codes.

+

+
Error Codes
For details, see Error Codes.

+

+

+

+

+
Parent topic: Backups and Restorations

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_api_0031.html b/docs/geminidb/api-ref/nosql_api_0031.html
new file mode 100644
index 00000000..f40ebfd5
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_api_0031.html
@@ -0,0 +1,219 @@
+
+
+
Configuring an Automated Backup Policy

+
Function
This API is used to configuring an automated backup policy.

+

+
Constraints
This API supports GeminiDB Cassandra instances.

+

+
URI
PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 1 Path parameters
Parameter

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
instance_id

+
Yes

+
String

+
Instance ID.

+

+

+

+
Request Parameters

+

+
+
+
+
+
+
+
+
+
+
+
+
Table 2 Request header parameters
Parameter

+
Mandatory

+
Type

+
Description

+
X-Auth-Token

+
Yes

+
String

+
User token.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 3 Request body parameters
Parameter

+
Mandatory

+
Type

+
Description

+
backup_policy

+
Yes

+
object

+
Backup policy objects, including backup retention period (days) and start time For details, see Table 4.

+
database_tables

+
No

+
Array of objects

+
Database and table information in the backup policy. This parameter is available only to GeminiDB Cassandra. For details, see Table 5.

+
  • If this parameter is empty, an automated backup policy for an instance is set.
  • If this parameter is not empty, an automated backup policy for a databases or table is set.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 4 BackupPolicy
Parameter

+
Mandatory

+
Type

+
Description

+
keep_days

+
Yes

+
Integer

+
Backup retention days.

+
The value ranges from 0 to 35. The value 0 indicates that the automated backup policy is disabled.

+
start_time

+
No

+
String

+
Backup time window. Automated backup will be triggered during the backup time window. This parameter is mandatory if the automated backup policy is enabled. If the policy is disabled, you do not need to transfer this parameter.

+
The value must be the UTC time in the hh:mm-HH:MM format.

+
  • The HH value must be 1 greater than the hh value.
  • The values of mm and MM must be the same and must be set to 00, 15, 30, or 45.
  • Example value: 23:00–00:00

+
period

+
No

+
String

+
Backup period. After a backup period is specified, data will be automatically backed up on the selected days every week. This parameter is mandatory if the automated backup policy is enabled. If the policy is disabled, you do not need to transfer this parameter.

+
The value is a list of digits separated by commas (,). Each digit indicates a day of the week. The restrictions on the backup period are as follows:

+
  • If you set keep_days to 0, this parameter is not transferred.
  • If you set keep_days to 1 to 6, set this parameter to 1, 2, 3, 4, 5, 6, 7.
  • If you set keep_days to 7 to 35, select at least one day of the week for the backup cycle. Example value: 1,2,3,4

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 5 PutDatabaseTablePolicy
Parameter

+
Mandatory

+
Type

+
Description

+
database_name

+
Yes

+
String

+
Database name.

+
table_names

+
No

+
Array of strings

+
Table names.

+
  • If this parameter is empty, a backup policy for an instance is set.
  • If this parameter is not empty, a backup policy for a databases or table is set.

+

+

+

+
Response Parameters
Status code: 204

+
No response parameters

+

+
Example Requests

+

+
Example Responses
Status code: 204

+
No Content

+
{ }

+

+
Status Codes
For details, see Status Codes.

+

+
Error Codes
For details, see Error Codes.

+

+

+

+

+
Parent topic: Backups and Restorations

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_api_reference.html b/docs/geminidb/api-ref/nosql_api_reference.html
new file mode 100644
index 00000000..b51cfedd
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_api_reference.html
@@ -0,0 +1,19 @@
+
+
+
Before You Start

+

+

+
+

+
diff --git a/docs/geminidb/api-ref/nosql_change_history02.html b/docs/geminidb/api-ref/nosql_change_history02.html
new file mode 100644
index 00000000..2165c16a
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_change_history02.html
@@ -0,0 +1,35 @@
+
+
+
Change History

+

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Released On

+
Description

+
2023-08-10

+
This issue is the third official release.

+
Updated status codes in Deleting an Instance.

+
Updated status codes in Scaling Up Storage Space of an Instance.

+
Updated status codes in Adding Nodes for an Instance.

+
Updated the descriptions of keep_days, start_time, and period in Configuring an Automated Backup Policy.

+
Updated status codes in Changing Specifications of an Instance.

+
2023-03-15

+
This issue is the second official release.

+
2022-07-22

+
This issue is the first official release.

+

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_database_version.html b/docs/geminidb/api-ref/nosql_database_version.html
new file mode 100644
index 00000000..7798c755
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_database_version.html
@@ -0,0 +1,108 @@
+
+
+
Querying Version Information

+
Function
This API is used to query version information of a specified type of instances.

+

+
Constraints
This API supports GeminiDB Cassandra instances.

+

+
URI
GET https://{Endpoint}/v3/{project_id}/datastores/{datastore_name}/versions

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 1 Path parameters
Parameter

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+
datastore_name

+
Yes

+
String

+
Database type. The value can be:

+
  • cassandra, indicating that the instances are of the GeminiDB Cassandra type.

+

+

+

+
Request Parameters

+

+
+
+
+
+
+
+
+
+
+
+
+
Table 2 Request header parameters
Parameter

+
Mandatory

+
Type

+
Description

+
X-Auth-Token

+
Yes

+
String

+
User token

+

+

+

+
Response Parameters
Status code: 200

+
+

+
+
+
+
+
+
+
+
+
+
Table 3 Response body parameters
Parameter

+
Type

+
Description

+
versions

+
Array of strings

+
Database version. The supported versions are:

+
  • GeminiDB Cassandra instance 3.11

+

+

+

+
Example Requests
URI example
GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/datastores/cassandra/versions

+

+

+
Example Responses
Status code: 200

+
Success

+
{
+  "versions" : [ "3.11" ]
+}

+

+
Status Codes
For details, see Status Codes.

+

+
Error Codes
For details, see Error Codes.

+

+

+

+

+
Parent topic: Versions and Specifications

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_error_code.html b/docs/geminidb/api-ref/nosql_error_code.html
new file mode 100644
index 00000000..59ce6c3c
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_error_code.html
@@ -0,0 +1,2217 @@
+
+
+
Error Codes

+
If an error occurs during API calling, no results will be returned. You can locate the error cause based on error codes of each API. If an error occurs, an HTTP status code is returned. The returned message body contains a specific error code and error message.

+
Error Code Description

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 1 Error code description
HTTP Status Code

+
Error Code

+
Error Message

+
Description

+
Handling Measure

+
400

+
DBS.200001

+
Parameter error.

+
Parameter error.

+
Check whether transferred parameters or URLs are correct.

+
404

+
DBS.200002

+
The DB instance does not exist.

+
Instance not found.

+
Check whether the instance and its ID are correct and whether the instance exists.

+
400

+
DBS.200010

+
Authentication failed.

+
Authentication failed.

+
Check whether the tenant and instance match.

+
403

+
DBS.200011

+
This instance {0} status makes it not be allowed to do this {1} operation now.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
404

+
DBS.200013

+
This node does not exist.

+
Node not found.

+
Check whether the node ID or group ID is correct.

+
403

+
DBS.200018

+
This instance's status or its node's status makes it not be allowed to do this operation now.

+
Unavailable instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
403

+
DBS.200019

+
Another operation is being performed on the DB instance or the DB instance is faulty.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.200022

+
The DB instance name {0} already exists.

+
Instance name already exists.

+
Check whether the instance name exists.

+
400

+
DBS.200024

+
The region is unavailable.

+
Unavailable region.

+
Check whether the region name is correct and whether the region is available.

+
400

+
DBS.200025

+
Invalid AZ.

+
Invalid AZ.

+
Check whether the AZ name is correct and whether the AZ is available.

+
403

+
DBS.200028

+
Volume size reach limit.

+
Maximum storage space has been reached.

+
Check whether the storage space exceeds the upper limit.

+
400

+
DBS.200029

+
Invalid username and password.

+
Invalid username and password.

+
Check whether the username and password match and whether the password meets password strength requirements.

+
400

+
DBS.200041

+
Invalid datastore version.

+
Invalid database version.

+
Check whether the database version is supported.

+
404

+
DBS.200042

+
Invalid database engine.

+
Invalid DB API.

+
Check whether the DB version is supported.

+
400

+
DBS.200047

+
Operation cannot be executed in current state of the DB instance or node.

+
Operation cannot be executed in current state of the instance or node.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.200048

+
Invalid VPC.

+
Invalid VPC.

+
Check whether the VPC ID and name are correct and meet the requirements.

+
400

+
DBS.200049

+
Invalid subnet.

+
Invalid subnet.

+
Check whether the subnet ID and name are correct and meet the requirements.

+
400

+
DBS.200050

+
Invalid security group.

+
Invalid security group.

+
Check whether the security group ID and name are correct and meet the requirements.

+
400

+
DBS.200052

+
Invalid password.

+
Invalid password.

+
Check whether the username and password match and whether the password meets password strength requirements.

+
400

+
DBS.200053

+
The DB instance specifications do not exist.

+
Instance specifications not found.

+
Check whether the specifications are correct and supported in the current AZ.

+
400

+
DBS.200054

+
Invalid DB instance specifications.

+
Invalid instance specifications.

+
Check whether the specifications are correct and supported in the current AZ.

+
400

+
DBS.200057

+
Invalid parameter group ID.

+
Invalid parameter template.

+
Check whether the parameter template is supported.

+
404

+
DBS.200058

+
Parameter template does not exist.

+
Parameter template not found.

+
Check whether the parameter template exists.

+
400

+
DBS.200059

+
Invalid database port.

+
Invalid database port.

+
Check whether the database port is missing or valid.

+
400

+
DBS.200060

+
The database port number is out of the specified range.

+
Database port is not in the specified range.

+
Check whether the database port is valid.

+
400

+
DBS.200063

+
Invalid DB instance type.

+
Invalid instance type.

+
Check whether the instance type is valid.

+
400

+
DBS.200068

+
Weak password.

+
Weak password.

+
Password is too easy to guess. Change it to a strong password.

+
400

+
DBS.200072

+
Invalid storage space.

+
Invalid storage space.

+
Check whether the storage space exceeds the upper limit.

+
400

+
DBS.200075

+
Invalid node role.

+
Invalid node role.

+
Check whether the role of the node meets the requirements and whether the instance is normal.

+
403

+
DBS.200076

+
Operation cannot be executed in current state of the DB instance.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.200077

+
Failed to change the password.

+
Updating password failed.

+
Check whether the username is correct.

+
400

+
DBS.200091

+
Invalid IP address.

+
Invalid IP address. 

+
Check whether the required IP address is missing or whether the input IP address is valid.

+
400

+
DBS.200092

+
The IP address already exists.

+
IP address already exists.

+
Check whether the IP address exists.

+
400

+
DBS.200095

+
Invalid parameter.

+
Parameter error.

+
Check whether parameters in the request and URLs are correct.

+
500

+
DBS.200165

+
Insufficient enterprise project instance quota range.

+
Enterprise project quota of the instance is insufficient.

+
Increase the enterprise project quota on the GeminiDB console.

+
500

+
DBS.200166

+
Insufficient enterprise project cpu quota range.

+
CPU quota of the enterprise project is insufficient.

+
Increase the CPU quota on the GeminiDB console.

+
500

+
DBS.200167

+
Insufficient enterprise project mem quota range.

+
Memory quota of the enterprise project is insufficient.

+
Increase the memory quota on the GeminiDB console.

+
400

+
DBS.200302

+
The storage space increase must be a positive integer.

+
Storage space increase is not a positive integer.

+
Check whether the storage space increase is a positive integer.

+
400

+
DBS.200303

+
The maximum number of times that the storage space can be scaled up has been reached.

+
Storage space has reached its upper limit and cannot be scaled up anymore.

+
Contact technical support to scale upt the storage space.

+
400

+
DBS.200304

+
The storage space can be scaled up for a maximum of four times.

+
Storage space can be scaled up at most four times.

+
Check how many times the instance has been scaled up.

+
400

+
DBS.200306

+
Invalid storage space.

+
Invalid storage space.

+
Check whether the storage space is correct and meets the requirements.

+
400

+
DBS.200311

+
Scaling up storage space is not allowed in current state of the node.

+
Scaling up storage space not allowed on the current node.

+
Check whether the node type, instance type, and node ID are correct.

+
400

+
DBS.200434

+
Failed to restart the DB instance.

+
Restarting instance failed.

+
Check whether the instance is available or ongoing other operations.

+
400

+
DBS.200451

+
The node does not exist.

+
Node not found.

+
Check whether the node ID is correct.

+
400

+
DBS.200462

+
The database port is the same as the current port.

+
Database port is the same as current port.

+
Check whether the new port number is the same as the original port number.

+
400

+
DBS.200470

+
Invalid AZ.

+
Invalid AZ.

+
Check whether the AZ is correct.

+
400

+
DBS.200501

+
The subnet does not exist.

+
Subnet deleted.

+
Check whether the subnet ID and name exist and whether the subnet matches the VPC.

+
400

+
DBS.200502

+
The security group does not exist.

+
Security group is not found or does not belong to the VPC.

+
Check whether the security group ID and name exist and whether the security group matches the VPC.

+
400

+
DBS.200503

+
The VPC does not exist.

+
VPC deleted.

+
Check whether the VPC is available to the tenant.

+
400

+
DBS.200506

+
The encryption key does not exist.

+
Storage encryption key ID not found.

+
Check whether the disk encryption key ID exists.

+
400

+
DBS.200507

+
The encryption key is not available.

+
Storage encryption key unavailable.

+
Check whether the disk encryption key is available.

+
400

+
DBS.200604

+
The instance is not owned by the current user.

+
Instance does not belong to the current user.

+
Check whether the project ID is subordinate to the instance ID.

+
400

+
DBS.200700

+
The EIP status does not allow EIP binding.

+
EIP is being bound and cannot be bound again.

+
Check whether there is an EIP being bound to the instance.

+
400

+
DBS.200701

+
The EIP status does not allow EIP unbinding.

+
EIP cannot be unbound.

+
Check whether the EIP status allows an unbinding operation.

+
400

+
DBS.200702

+
The node has been bound to a public IP address and cannot be bound again.

+
Node has already an EIP bound and cannot be bound with another EIP.

+
Check whether an EIP has been bound to the node.

+
400

+
DBS.200705

+
The PublicIp does not exist.

+
Target EIP not found.

+
Check whether the EIP exists and whether the EIP and its ID match.

+
400

+
DBS.200816

+
Failed to create the database user.

+
Creating database user failed.

+
Check whether the database user name is valid and check the database status and instance status.

+
400

+
DBS.200817

+
Failed to obtain the database user list.

+
Obtaining database users failed.

+
Check the database status and instance status.

+
400

+
DBS.200818

+
Failed to delete the database user.

+
Deleting database user failed.

+
Check the database status and instance status.

+
400

+
DBS.200823

+
The database does not exist.

+
Database not found.

+
Check whether the database name is valid.

+
400

+
DBS.200824

+
The database account does not exist.

+
Database account not found.

+
Check whether the database user name is valid.

+
400

+
DBS.200826

+
The database name already exists.

+
Database name already exists.

+
Check whether the database name is valid.

+
400

+
DBS.200827

+
The database user already exists.

+
Database account name already exists.

+
Check whether the database user is valid.

+
400

+
DBS.200828

+
Built-in database accounts cannot be edited.

+
This is an internal database account and cannot be operated by users.

+
Check whether the database user is valid.

+
500

+
DBS.200998

+
The system is busy. Try again later.

+
The system is busy. Try again later.

+
The system is busy. Try again later.

+
403

+
DBS.201000

+
The status of DB instance {0} does not allow the {1} operation.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.201006

+
Parameter error.

+
Parameter error.

+
Check whether transferred parameters or URLs are correct.

+
403

+
DBS.201014

+
Operation cannot be executed in current state of the DB instance.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
403

+
DBS.201015

+
This operation cannot be performed because another operation is being performed on the DB instance or the DB instance is faulty. Try again later.

+
Operation cannot be performed because another operation is being performed.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.201020

+
Invalid DB engine.

+
Invalid DB API.

+
Check whether the database API is the API supported by the GeminiDB service.

+
403

+
DBS.201028

+
The DB instance does not exist.

+
Instance not found.

+
Check whether the instance belongs to the tenant and whether the instance exists.

+
400

+
DBS.201035

+
The database name must be different.

+
Database name already exists.

+
Check whether the same database name exists.

+
400

+
DBS.201038

+
The collection name must be different.

+
Collection name already exists.

+
Check whether the same collection name exists.

+
400

+
DBS.201101

+
Invalid backup period.

+
Invalid backup cycle.

+
Check whether the backup cycle meets the requirements.

+
400

+
DBS.201106

+
Invalid retention period.

+
Invalid retention period.

+
Check whether the backup retention period is correct.

+
400

+
DBS.201201

+
The backup already exists.

+
Backup file already exists.

+
Check whether the backup name or ID already exists.

+
400

+
DBS.201202

+
Operation cannot be executed in current state of the DB instance.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.201204

+
Operation cannot be executed in current state of the DB instance.

+
Backup file not found.

+
Check whether the backup file exists and matches the instance.

+
400

+
DBS.201212

+
Backup ID is illegal.

+
Invalid backup ID.

+
Check whether the backup ID exists.

+
400

+
DBS.201214

+
The backup file does not exist.

+
Backup file not found.

+
Check whether the backup file exists and matches the instance.

+
400

+
DBS.201215

+
Time is illegal.

+
Invalid time.

+
Check whether the time meets the requirements.

+
400

+
DBS.201319

+
Deleting backup file is not allowed because a restoration task is currently in progress. Please wait.

+
Original backup file cannot be deleted during restoration.

+
Check whether the backup is being used to restore instances.

+
400

+
DBS.201501

+
The DB instance does not exist.

+
Instance not found.

+
Check whether the instance belongs to the tenant, whether the instance name or ID is correct, and whether the instance exists.

+
400

+
DBS.201502

+
The DB instance does not exist.

+
Instance not found.

+
Check whether the instance belongs to the tenant, whether the instance name or ID is correct, and whether the instance exists.

+
400

+
DBS.212001

+
The parameter group {0} does not exist.

+
Parameter template not found.

+
Check whether the parameter template exists.

+
400

+
DBS.212003

+
This operation is not permitted.

+
Operation not allowed.

+
Check whether the instance status or the ongoing operation on the instance conflicts with the request.

+
400

+
DBS.212006

+
The node associated with this parameter group is not available.

+
Node associated with the parameter template is abnormal.

+
Check whether the node associated with the parameter template is normal.

+
400

+
DBS.212008

+
The database type does not exist.

+
Unsupported database version.

+
Check whether the database version supports this operation.

+
400

+
DBS.212013

+
The parameter group does not exist.

+
Parameter template not found.

+
Check whether the parameter template exists or belongs to the current tenant.

+
400

+
DBS.212017

+
The parameter is invalid.

+
Invalid parameter.

+
Check whether transferred parameters or URLs are correct and meet the requirements.

+
400

+
DBS.212019

+
Invalid parameter.

+
Invalid parameter.

+
Check whether transferred parameters or URLs are correct and meet the requirements.

+
400

+
DBS.212028

+
Invalid description.

+
Invalid parameter template description.

+
Check whether the parameter template description is valid.

+
400

+
DBS.212030

+
The parameter group name already exists.

+
Parameter template name already exists.

+
Check whether the parameter template name exists.

+
400

+
DBS.212031

+
Invalid parameter group name.

+
Invalid parameter template name.

+
Check whether the parameter template name is valid.

+
400

+
DBS.212032

+
The operation cannot be performed because this parameter group is being applied to one or more DB instance nodes.

+
Operation is not allowed because the parameter template is applied to one or more instance nodes.

+
Check whether the parameter template has been applied to the instance.

+
400

+
DBS.212035

+
Failed to associate this parameter group with the DB instance because the DB instance is currently being operated.

+
Operation cannot be performed in current state of the instance.

+
Check whether the instance is ongoing other operations.

+
400

+
DBS.212037

+
Parameters are incorrectly set.

+
Parameter error.

+
Check whether the parameter value is valid or within the valid range.

+
400

+
DBS.216016

+
DB instance does not exist.

+
Instance not found.

+
Check whether the instance exists.

+
400

+
DBS.216029

+
This operation is not allowed.

+
Operation not allowed.

+
Check whether the operation is valid or whether the current engine supports the operation.

+
400

+
DBS.216030

+
The queried node does not belong to the current instance.

+
Queried node does not belong to the current instance.

+
Check whether the input node belongs to the current instance.

+
400

+
DBS.238007

+
This operation cannot be performed in the current IP address status.

+
Operation cannot be performed in the current IP address state.

+
Check whether the delivered IP address is in use.

+
400

+
DBS.239010

+
Reduce num or target invalid.

+
Invalid quantity of nodes to be deleted or invalid nodes.

+
Check whether the input node belongs to the current instance.

+
400

+
DBS.239011

+
Reduce num invalid.

+
Invalid number of nodes to be deleted.

+
Check whether the number of input nodes is valid.

+
400

+
DBS.239012

+
Reduce target invalid.

+
Invalid node to be deleted.

+
Check whether the input node belongs to the current instance.

+
400

+
DBS.239013

+
resize flavor invalid.

+
Inappropriate specifications.

+
Check whether the input specifications are valid.

+
400

+
DBS.239014

+
Current disk capacity does not support scaling in the number of nodes.

+
Current storage space does not allow deleting nodes.

+
Check the storage space of the instance.

+
400

+
DBS.240001

+
node num inconsistent.

+
Inconsistent nodes.

+
Check whether the number of nodes is consistent.

+
400

+
DBS.240002

+
node num incorrect.

+
Invalid quantity of nodes.

+
Check whether the number of nodes is valid.

+
400

+
DBS.240009

+
Deleting nodes cannot be executed in current state of the DB instance.

+
Deleting nodes is not allowed in current state of the instance.

+
Check whether the current instance has nodes that can be deleted.

+
400

+
DBS.240010

+
The selected nodes do not support shrinkage.

+
Selected nodes cannot be deleted.

+
Check whether the selected nodes can be deleted.

+
400

+
DBS.240012

+
The maximum number of resources that can be changed has been reached.

+
The maximum number of resources that can be changed has been reached.

+
Check whether the number of nodes in the current instance exceeds the upper limit.

+
400

+
DBS.240013

+
The current disk capacity cannot be changed to the target flavor.

+
Specifications cannot be changed because the storage space is too small.

+
Check whether the storage space of the current instance exceeds the upper limit defined by the target instance specifications.

+
400

+
DBS.280001

+
Parameter error.

+
Parameter error.

+
Check whether transferred parameters or URLs are correct and meet the requirements.

+
500

+
DBS.280005

+
Server error. Try again later.

+
Server error. Try again later.

+
Contact technical support.

+
400

+
DBS.280015

+
Permission denied.

+
Insufficient permissions.

+
Check whether the token expires and whether the instance matches the tenant.

+
400

+
DBS.280016

+
Resource not found.

+
Resource not found.

+
Check whether transferred parameters are correct and whether the instance exists.

+
403

+
DBS.280032

+
You do not have permission to perform this operation. Contact the administrator to obtain permission.

+
Permission denied.

+
Check whether the user group to which the current user belongs has the corresponding operation permission.

+
400

+
DBS.280042

+
Invalid request.

+
Invalid request.

+
Check whether the current instance status and the ongoing operation allow this operation or whether the request is valid.

+
400

+
DBS.280040

+
Parameter is null.

+
Parameter missed.

+
Check whether there are parameters not input.

+
404

+
DBS.280045

+
This parameter group does not exist.

+
Parameter template not found.

+
Check whether the parameter template exists in the request.

+
403

+
DBS.280056

+
Token invalid.

+
Invalid token.

+
Check whether the instance belongs to the tenant and whether the token has been obtained again.

+
400

+
DBS.280063

+
You do not have following permission to perform this operation: {0}. Contact the administrator to obtain permission.

+
Current user does not have the permission to perform xxx operation. Contact the account administrator.

+
Check whether the user group to which the current user belongs has the corresponding operation permission.

+
500

+
DBS.280064

+
Check PDP permissions failed.

+
Fine-grained authentication failed.

+
Contact customer service.

+
400

+
DBS.280066

+
Invalid log type.

+
Invalid log type.

+
Check whether the log type meets the requirements.

+
400

+
DBS.280067

+
Invalid start time.

+
Invalid start time.

+
Check whether the start time meets the requirement.

+
400

+
DBS.280068

+
Invalid end time.

+
Invalid end time.

+
Check whether the end time meets the requirement.

+
400

+
DBS.280110

+
The DB instance does not exist.

+
Instance not found.

+
Check whether the instance belongs to the tenant, whether the instance name or ID is correct, and whether the instance exists.

+
400

+
DBS.280122

+
Invalid DB engine.

+
Invalid storage API.

+
Check whether the storage engine matches the instance engine.

+
400

+
DBS.280123

+
Invalid node number.

+
Invalid node quantity.

+
Check whether the number of nodes meets the requirements.

+
400

+
DBS.280124

+
Invalid backup.

+
Invalid backup ID.

+
Check whether the backup ID is correct and meets the requirements.

+
400

+
DBS.280125

+
Invalid backup policy.

+
Invalid automated backup policy.

+
Check whether the automated backup policy meets the requirements.

+
400

+
DBS.280127

+
Invalid backup description.

+
Invalid backup description.

+
Check whether the backup description is correct and meets the requirements.

+
400

+
DBS.280200

+
The password contains invalid characters.

+
Password contains invalid characters.

+
Check whether the password is correct and meets the requirements.

+
400

+
DBS.280214

+
Invalid retention period.

+
Invalid retention period.

+
Check whether the backup retention period is correct.

+
400

+
DBS.280215

+
Invalid backup cycle.

+
Invalid backup cycle.

+
Check whether the backup start time, end time, and backup cycle are correct and meet the requirements.

+
400

+
DBS.280216

+
Invalid backup start time.

+
Invalid backup start time.

+
Check whether the backup start time meets the requirements and whether the relationship between the backup start time and end time is rational.

+
400

+
DBS.280234

+
Invalid DB instance name.

+
Invalid instance name.

+
Check whether the instance name is correct and whether the instance exists.

+
400

+
DBS.280235

+
Invalid database type.

+
Invalid DB API.

+
Check whether the DB engine name is correct.

+
400

+
DBS.280236

+
Invalid database version.

+
Invalid database version.

+
Check whether the database version is supported.

+
400

+
DBS.280239

+
Invalid specifications.

+
Invalid specifications.

+
Check whether specification code is correct and whether the specifications are available in the AZ.

+
400

+
DBS.280240

+
The specification does not exist.

+
Specification code not found.

+
Check whether the specification code is correct and the specifications are available.

+
400

+
DBS.280241

+
Invalid storage type.

+
Invalid storage type.

+
Check whether the storage type is correct and meets the requirements.

+
400

+
DBS.280242

+
The storage space is out of range.

+
Storage space is out of range.

+
Check whether the storage space is correct.

+
400

+
DBS.280244

+
Invalid AZ.

+
Invalid AZ.

+
Check whether parameters of the AZ are correct, whether the AZ exists, and whether the AZ matches the specifications.

+
400

+
DBS.280247

+
Invalid VPC.

+
Invalid VPC.

+
Check whether the VPC ID is correct and whether the VPC exists.

+
400

+
DBS.280248

+
Invalid subnet.

+
Invalid subnet.

+
Check whether the subnet ID is correct and whether the subnet exists.

+
400

+
DBS.280249

+
Invalid security group.

+
Invalid security group.

+
Check whether the security group ID is correct and whether the security group exists.

+
400

+
DBS.280251

+
Invalid backup period.

+
Invalid backup cycle.

+
Check whether the backup cycle meets the requirements.

+
400

+
DBS.280266

+
Invalid storage space.

+
Invalid storage space.

+
Check whether the storage space is correct and meets the requirements.

+
400

+
DBS.280267

+
Specifications not match.

+
Specifications do not match.

+
Check whether the specification information is correct and whether the specifications match the instance.

+
400

+
DBS.280269

+
Invalid Datastore Info.

+
Invalid database information.

+
Check whether datastore information is correct and meets the requirements.

+
400

+
DBS.280277

+
Invalid backup name.

+
Invalid backup name.

+
Check whether the backup name is correct and meets the requirements.

+
400

+
DBS.280280

+
Invalid DB instance number.

+
Invalid instance quantity.

+
Check whether the number of instances is correct and meets the requirements.

+
400

+
DBS.280284

+
Invalid IP address.

+
Invalid IP address.

+
Check whether the IP address is correct and meets the requirements.

+
400

+
DBS.280292

+
Invalid database username.

+
Invalid username.

+
Check whether the username is correct and meets the requirements.

+
400

+
DBS.280311

+
Invalid storage space.

+
Invalid storage space.

+
Check whether the storage space is correct and meets the requirements.

+
400

+
DBS.280314

+
Invalid storage space.

+
Invalid storage type.

+
Check whether the storage type is correct and whether the instance supports the disk type.

+
400

+
DBS.280327

+
Invalid node type.

+
Invalid node type.

+
Check whether the node type is correct, whether the node type matches the instance, and whether the node type matches the group ID and node ID.

+
400

+
DBS.280341

+
Invalid DB instance type.

+
Invalid instance type.

+
Check whether the GeminiDB APIs support the instance.

+
400

+
DBS.280342

+
Invalid DB instance mode.

+
Invalid instance type.

+
Check whether the instance type is correct and matches the instance ID.

+
400

+
DBS.280347

+
Unsupported database type.

+
Unsupported instance type.

+
Check whether the instance type is correct and meets the requirements.

+
400

+
DBS.280391

+
Action check states.

+
Invalid action.

+
Check whether the input action meets the requirements.

+
400

+
DBS.280404

+
Invalid DB instance ID.

+
Invalid instance ID.

+
Check whether the instance ID is correct and meets the requirements.

+
403

+
DBS.280406

+
The DB instance cannot be deleted.

+
Instance cannot be deleted.

+
Check whether the instance can be deleted.

+
400

+
DBS.280407

+
Invalid node ID.

+
Invalid node ID.

+
Check whether the node ID is correct and meets the requirements.

+
400

+
DBS.280408

+
Invalid project id.

+
Invalid project ID.

+
Check whether the project ID is correct and meets requirements.

+
400

+
DBS.280414

+
Invalid group type.

+
Invalid group type.

+
Check whether the instance group type is correct and meets the requirements and whether it matches the instance and group ID.

+
400

+
DBS.280416

+
Invalid backup end time.

+
Invalid backup end time.

+
Check whether the backup end time is missing and whether the backup end time period and format meet the requirements.

+
400

+
DBS.280421

+
Invalid EIP.

+
Invalid EIP.

+
Check whether the EIP exists and meets the requirements.

+
403

+
DBS.280433

+
Invalid enterprise project ID.

+
Invalid enterprise project ID.

+
Check whether the enterprise project ID meets the requirements.

+
400

+
DBS.280434

+
The specifications are unavailable.

+
Invalid resource specification code.

+
Check whether the resource specification code exists and meets the requirements.

+
400

+
DBS.280437

+
Not support enterprise project.

+
Enterprise project not supported.

+
The current user has not enabled the enterprise project service. Enable it or do not transfer related parameters.

+
400

+
DBS.280438

+
Invalid encryption key.

+
Invalid storage encryption key ID.

+
Check whether there is a disk encryption key ID available in the request and whether the current DB API supports disk encryption.

+
400

+
DBS.280439

+
Invalid limit.

+
Invalid query limit.

+
Check whether the value of the limit parameter is valid.

+
400

+
DBS.280440

+
Invalid offset.

+
Invalid offset.

+
Check whether the value of the offset parameter is valid.

+
400

+
DBS.280441

+
Invalid key.

+
Invalid key.

+
Check whether the tag key is valid.

+
429

+
DBS.280443

+
The maximum number of connections has been reached.

+
Maximum connections reached.

+
Too frequent API requests. Try again later.

+
400

+
DBS.280444

+
Invalid value.

+
Invalid tag value.

+
Check whether the tag value is valid.

+
400

+
DBS.280445

+
The DB instance class is not available.

+
Unavailable instance specifications.

+
The current instance specifications are unavailable. Select another one.

+
400

+
DBS.280446

+
The database information does not exist.

+
Database information not found.

+
Check whether the datastore parameter exists.

+
400

+
DBS.280453

+
Invalid DSS storage pool ID.

+
Invalid DSS storage pool ID.

+
Check whether the storage pool ID is correct.

+
400

+
DBS.280465

+
Invalid password.

+
Invalid user password.

+
Check whether the user password meets the requirements.

+
400

+
DBS.280469

+
Invalid ECS group policy.

+
Invalid policy associated with the ECS group.

+
Check whether the policy associated with the ECS group is correct.

+
400

+
DBS.280480

+
The target specification is same as current.

+
Target specifications are the same as current specifications.

+
Check whether the target specifications are the same as the current specifications.

+
400

+
DBS.280456

+
This operation is not supported by the current billing mode.

+
Current billing mode does not support this operation.

+
Check whether the billing mode of the current instance meets the API requirements.

+
400

+
DBS.290000

+
Parameter error.

+
Parameter error.

+
Check whether transferred parameters or URLs are correct and meet the requirements.

+
400

+
DBS.301024

+
Invalid backup restore information.

+
Invalid backup and restoration information.

+
Check whether the backup and restoration information is valid.

+
400

+
DBS.301040

+
The target security group is same as current.

+
Target security group is the same as current security group.

+
Check whether the target security group is the same as the current security group.

+
400

+
DBS.301071

+
Invalid session id.

+
Invalid session ID.

+
Check whether the session ID is correct and meets the requirements.

+
400

+
DBS.301072

+
Invalid plan summary.

+
Invalid execution plan.

+
Check whether the execution plan is correct and meets the requirements.

+
400

+
DBS.301073

+
Invalid operation type.

+
Invalid operation type.

+
Check whether the operation type is correct and meets the requirements.

+
400

+
DBS.301074

+
Invalid namespace.

+
Invalid namespace.

+
Check whether the namespace is correct and meets the requirements.

+
400

+
DBS.301075

+
Invalid cost time.

+
Invalid execution time.

+
Check whether the execution time is correct and meets the requirements.

+
400

+
DBS.301076

+
Query session failed.

+
Querying session failed.

+
Contact customer service to check the instance status.

+
400

+
DBS.301077

+
Kill session failed.

+
Killing session failed.

+
Contact customer service to check the instance status.

+
400

+
DBS.03000001

+
The instance has not build biactive relationship.

+
Instance has no dual-active DR relationships.

+
Check whether the instance has a dual-active DR relationship.

+
400

+
DBS.03000002

+
Invalid threshold.

+
Incorrect input threshold.

+
Check whether the input threshold meets the requirements.

+
400

+
DBS.03000003

+
Invalid step.

+
Inputting autoscaling increment failed.

+
Check whether the input increase step meets the requirements.

+
400

+
DBS.03000004

+
Invalid switch option.

+
Invalid parameter settings.

+
Check whether the input switch option is on or off.

+

+

+

+

+

+

+
Parent topic: Appendixes

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_instance_specification.html b/docs/geminidb/api-ref/nosql_instance_specification.html
new file mode 100644
index 00000000..b8f1b548
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_instance_specification.html
@@ -0,0 +1,260 @@
+
+
+
Querying Instance Specifications

+
Function
This API is used to query all instance specifications under a specified condition.

+

+
Constraints
This API supports GeminiDB Cassandra instances.

+

+
URI
GET https://{Endpoint}/v3.1/{project_id}/flavors

+
+

+
+
+
+
+
+
+
+
+
+
+
+
Table 1 Path parameters
Parameter

+
Mandatory

+
Type

+
Description

+
project_id

+
Yes

+
String

+
Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 2 Query parameters
Parameter

+
Mandatory

+
Type

+
Description

+
engine_name

+
No

+
String

+
Database type. The value can be:

+
  • cassandra, indicating that the instances are of the GeminiDB Cassandra type.
  • If this parameter is not transferred, the default value is cassandra.

+
offset

+
No

+
Integer

+
Index offset.

+
  • If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data.
  • The offset value must be a number but cannot be a negative number.

+
limit

+
No

+
Integer

+
Maximum of specifications that can be queried

+
  • The value ranges from 1 to 100.
  • If this parameter is not transferred, the first 100 pieces of specification information is queried by default.

+

+

+

+
Request Parameters

+

+
+
+
+
+
+
+
+
+
+
+
+
Table 3 Request header parameters
Parameter

+
Mandatory

+
Type

+
Description

+
X-Auth-Token

+
Yes

+
String

+
User token

+

+

+

+
Response Parameters
Status code: 200

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 4 Response body parameters
Parameter

+
Type

+
Description

+
total_count

+
Integer

+
Total number of records

+
flavors

+
Array of Flavors objects

+
Instance specifications

+

+

+
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 5 Flavors
Parameter

+
Type

+
Description

+
engine_name

+
String

+
API name.

+
engine_version

+
String

+
API version.

+
vcpus

+
String

+
Number of vCPUs

+
ram

+
String

+
Memory size in megabytes (MB)

+
spec_code

+
String

+
Resource specification code.

+
Example: geminidb.cassandra.8xlarge.4

+
 NOTE: 
  • geminidb.cassandra indicates the instance is a GeminiDB Cassandra instance.
  • 8xlarge.4 indicates node specifications.

+

+
availability_zone

+
Array of strings

+
ID of the AZ that supports the specifications

+
 NOTE: 
This parameter has been discarded. Do not use it.

+

+
az_status

+
Object

+
The status of specifications in an AZ. The value can be:

+
  • normal, indicating that the specifications are on sale.
  • unsupported, indicating that the specifications are not supported.
  • sellout, indicating that the specifications are sold out.

+

+

+

+
Example Requests
URI example
GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?engine_name=cassandra&offset=0&limit=10

+

+

+
Example Responses
Status code: 200

+
Success

+
{
+  "total_count" : 4,
+  "flavors" : [ {
+    "engine_name" : "cassandra",
+    "engine_version" : "3.11",
+    "vcpus" : "4",
+    "ram" : "16",
+    "spec_code" : "geminidb.cassandra.xlarge.4",
+    "availability_zone" : [ "az1", "az2" ],
+    "az_status" : {
+      "az1" : "normal",
+      "az2" : "unsupported"
+    }
+  }, {
+    "engine_name" : "cassandra",
+    "engine_version" : "3.11",
+    "vcpus" : "8",
+    "ram" : "32",
+    "spec_code" : "geminidb.cassandra.2xlarge.4",
+    "availability_zone" : [ "az1", "az2" ],
+    "az_status" : {
+      "az1" : "unsupported",
+      "az2" : "normal"
+    }
+  }, {
+    "engine_name" : "cassandra",
+    "engine_version" : "3.11",
+    "vcpus" : "16",
+    "ram" : "64",
+    "spec_code" : "geminidb.cassandra.4xlarge.4",
+    "availability_zone" : [ "az1", "az2" ],
+    "az_status" : {
+      "az1" : "normal",
+      "az2" : "sellout"
+    }
+  }, {
+    "engine_name" : "cassandra",
+    "engine_version" : "3.11",
+    "vcpus" : "32",
+    "ram" : "128",
+    "spec_code" : "geminidb.cassandra.8xlarge.4",
+    "availability_zone" : [ "az1", "az2" ],
+    "az_status" : {
+      "az1" : "normal",
+      "az2" : "normal"
+    }
+  } ]
+}

+

+
Status Codes
For details, see Status Codes.

+

+
Error Codes
For details, see Error Codes.

+

+

+

+

+
Parent topic: Versions and Specifications

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_metrics.html b/docs/geminidb/api-ref/nosql_metrics.html
new file mode 100644
index 00000000..fe903812
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_metrics.html
@@ -0,0 +1,595 @@
+
+
+
Metrics

+
Function
This section describes GeminiDB metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query metrics of monitored objects and alarms generated for GeminiDB.

+

+
Namespace
SYS.NoSQL

+

+
GeminiDB Cassandra Metrics

+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Table 1 GeminiDB Cassandra metrics
Metric ID

+
Name

+
Description

+
Value Range

+
Monitored Object

+
Monitoring Period (Raw Data)

+
nosql005_disk_usage

+
Storage Space Usage

+
Storage space usage of the monitored object.

+
Unit: Percent

+
0–100

+
GeminiDB Cassandra instances

+
1 minute

+
nosql006_disk_total_size

+
Total Storage Space

+
Total storage space of the monitored object.

+
Unit: GB

+
≥ 0

+
GeminiDB Cassandra instances

+
1 minute

+
nosql007_disk_used_size

+
Used Storage Space

+
Used storage space of the monitored object.

+
Unit: GB

+
≥ 0

+
GeminiDB Cassandra instances

+
1 minute

+
nosql009_dfv_write_delay

+
Storage Write Latency

+
Average delay of writing data to the storage layer in a specified period

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
nosql010_dfv_read_delay

+
Storage Read Latency

+
Average latency of reading data from the storage layer in a specified period

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra001_cpu_usage

+
CPU Usage

+
CPU usage of an instance

+
Unit: Percent

+
0–100

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra002_mem_usage

+
Memory Usage

+
Memory usage of the instance

+
Unit: Percent

+
0–100

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra003_bytes_out

+
Network Output Throughput

+
Outgoing traffic in bytes per second

+
Unit: byte/s

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra004_bytes_in

+
Network Input Throughput

+
Incoming traffic in bytes per second

+
Unit: byte/s

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra014_connections

+
Active Node Connections

+
Total number of connections attempting to connect to Cassandra instance nodes

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra015_read_latency

+
Average Read Latency

+
Average amount of time consumed by read requests

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra016_write_latency

+
Average Write Latency

+
Average amount of time consumed by write requests

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra037_pending_write

+
Suspended Write Tasks

+
Number of write tasks in waiting status

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra038_pending_read

+
Suspended Read Tasks

+
Number of read tasks in waiting status

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra044_range_slice_latency

+
Scan Duration

+
Average amount of time consumed by scan operations

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra049_dropped_mutation

+
Dropped Writes

+
Average number of dropped writes

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra052_dropped_read

+
Dropped Reads

+
Average number of dropped reads

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra092_load_info

+
Data Volume on a Node

+
Data volume on a node

+
Unit: byte

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra093_write_count_latency

+
Accumulated Write Requests

+
Total number of write requests initiated by a node

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra094_write_1min_rate

+
Average Write Rate in the Last Minute

+
Average write rate in the last minute

+
Unit: count/s

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra095_write_p75_latency

+
p75 Write Latency

+
p75 write latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra096_write_p95_latency

+
p95 Write Latency

+
p95 write latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra097_write_p99_latency

+
p99 Write Latency

+
p99 write latency

+
Unit: ms

+
≥ 0 

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra098_read_count_latency

+
Accumulated Read Requests

+
Total number of read requests initiated by a node

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra099_read_1min_rate

+
Average Read Rate in the Last Minute

+
Average read rate in the last minute

+
Unit: count/s

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra100_read_p75_latency

+
p75 Read Latency

+
p75 read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra101_read_p95_latency

+
p95 Read Latency

+
p95 read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra102_read_p99_latency

+
p99 Read Latency

+
p99 read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra103_range_slice_count_latency

+
Accumulated Range Read Requests

+
Accumulated range read requests

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra104_range_slice_1min_rate

+
Average Range Read Rate in the Last Minute

+
Average range read rate in the last minute

+
Unit: count/s

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra105_range_slice_p75_latency

+
p75 Range Read Latency

+
p75 range read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra106_range_slice_p95_latency

+
p95 Range Read Latency

+
p95 range read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra107_range_slice_p99_latency

+
p99 Range Read Latency

+
p99 range read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra163_write_p999_latency

+
p999 Write Latency

+
p999 write latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra164_read_p999_latency

+
p999 Read Latency

+
p999 read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra165_large_partition_num

+
Big Keys

+
Number of big keys on the current node

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra166_write_max_latency

+
Maximum Write Latency

+
Maximum write latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra167_read_max_latency

+
Maximum Read Latency

+
Maximum read latency

+
Unit: ms

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+
cassandra168_imbalance_table_num

+
Tables with Uneven Data Distribution

+
Number of tables in which data is not evenly distributed.

+
Unit: count

+
≥ 0

+
GeminiDB Cassandra instance nodes

+
1 minute

+

+

+

+
Dimensions

+

+
+
+
+
+
+
+
+
Key

+
Value

+
cassandra_cluster_id,cassandra_node_id

+
Cluster ID or node ID of the GeminiDB Cassandra instance

+

+

+

+

+

+

+
Parent topic: Appendixes

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_projectid.html b/docs/geminidb/api-ref/nosql_projectid.html
new file mode 100644
index 00000000..25086eda
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_projectid.html
@@ -0,0 +1,45 @@
+
+
+
Obtaining a Project ID

+
Scenarios
When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first.

+
You can obtain the required project ID with either of the following methods:

+
+

+
Obtaining the Project ID by Calling an API
You can obtain the project ID by calling the IAM API used to query project information based on specified criteria.

+
The API used to obtain a project ID is GET https://{Endpoint}/v3/projects/. {Endpoint} is the IAM endpoint and can be obtained from Regions and Endpoints. For details about API authentication, see Authentication.

+
The following is an example response. The value of id is the project ID.

+
{
+    "projects": [
+        {
+            "domain_id": "65382450e8f64ac0870cd180d14e684b",
+            "is_domain": false,
+            "parent_id": "65382450e8f64ac0870cd180d14e684b",
+            "name": "project_name",
+            "description": "",
+            "links": {
+                "next": null,
+                "previous": null,
+                "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
+            },
+            "id": "a4a5d4098fb4474fa22cd05f897d6b99",
+            "enabled": true
+        }
+    ],
+    "links": {
+        "next": null,
+        "previous": null,
+        "self": "https://www.example.com/v3/projects"
+    }
+}

+

+
Obtaining a Project ID from the Console
  1. Sign up and log in to the management console.
  2. Move your pointer over the username and select My Credentials in the displayed drop-down list.
    On the Projects tab page, view project IDs.
    
+
    Figure 1 Viewing project IDs
    
+

+

+

+

+

+
Parent topic: Appendixes

+

+

+
diff --git a/docs/geminidb/api-ref/nosql_public_parameters.html b/docs/geminidb/api-ref/nosql_public_parameters.html
new file mode 100644
index 00000000..3c451c7b
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_public_parameters.html
@@ -0,0 +1,21 @@
+
+
+
Appendixes

+

+

+
+

+
diff --git a/docs/geminidb/api-ref/nosql_status_code.html b/docs/geminidb/api-ref/nosql_status_code.html
new file mode 100644
index 00000000..53619f6b
--- /dev/null
+++ b/docs/geminidb/api-ref/nosql_status_code.html
@@ -0,0 +1,147 @@
+
+
+
Status Codes

+

+
+

+

+

+
Parent topic: Appendixes

+

+

+
diff --git a/docs/geminidb/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/geminidb/api-ref/public_sys-resources/caution_3.0-en-us.png
new file mode 100644
index 00000000..60f60762
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/caution_3.0-en-us.png differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/geminidb/api-ref/public_sys-resources/danger_3.0-en-us.png
new file mode 100644
index 00000000..47a9c723
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/danger_3.0-en-us.png differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/delta.gif b/docs/geminidb/api-ref/public_sys-resources/delta.gif
new file mode 100644
index 00000000..0d1b1f67
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/delta.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/deltaend.gif b/docs/geminidb/api-ref/public_sys-resources/deltaend.gif
new file mode 100644
index 00000000..cc7da0fc
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/deltaend.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/geminidb/api-ref/public_sys-resources/icon-arrowdn.gif
new file mode 100644
index 00000000..37942803
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-arrowdn.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/geminidb/api-ref/public_sys-resources/icon-arrowrt.gif
new file mode 100644
index 00000000..6aaaa11c
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-arrowrt.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-caution.gif b/docs/geminidb/api-ref/public_sys-resources/icon-caution.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-caution.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-danger.gif b/docs/geminidb/api-ref/public_sys-resources/icon-danger.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-danger.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-huawei.gif b/docs/geminidb/api-ref/public_sys-resources/icon-huawei.gif
new file mode 100644
index 00000000..a31d60f8
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-huawei.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-note.gif b/docs/geminidb/api-ref/public_sys-resources/icon-note.gif
new file mode 100644
index 00000000..31be2b03
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-note.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-notice.gif b/docs/geminidb/api-ref/public_sys-resources/icon-notice.gif
new file mode 100644
index 00000000..40907065
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-notice.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-tip.gif b/docs/geminidb/api-ref/public_sys-resources/icon-tip.gif
new file mode 100644
index 00000000..c47bae05
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-tip.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/icon-warning.gif b/docs/geminidb/api-ref/public_sys-resources/icon-warning.gif
new file mode 100644
index 00000000..079c79b2
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/icon-warning.gif differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/geminidb/api-ref/public_sys-resources/note_3.0-en-us.png
new file mode 100644
index 00000000..57a0e1f5
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/note_3.0-en-us.png differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/geminidb/api-ref/public_sys-resources/notice_3.0-en-us.png
new file mode 100644
index 00000000..fa4b6499
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/notice_3.0-en-us.png differ
diff --git a/docs/geminidb/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/geminidb/api-ref/public_sys-resources/warning_3.0-en-us.png
new file mode 100644
index 00000000..def5c356
Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/warning_3.0-en-us.png differ
diff --git a/docs/geminidb/api-ref/topic_300000000.html b/docs/geminidb/api-ref/topic_300000000.html
new file mode 100644
index 00000000..f8f9c143
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000000.html
@@ -0,0 +1,18 @@
+
+
+
API Versions

+
    

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000001.html b/docs/geminidb/api-ref/topic_300000001.html
new file mode 100644
index 00000000..991167c9
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000001.html
@@ -0,0 +1,17 @@
+
+
+
Versions and Specifications

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000002.html b/docs/geminidb/api-ref/topic_300000002.html
new file mode 100644
index 00000000..04171fab
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000002.html
@@ -0,0 +1,33 @@
+
+
+
Instances

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000003.html b/docs/geminidb/api-ref/topic_300000003.html
new file mode 100644
index 00000000..70dac2a1
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000003.html
@@ -0,0 +1,17 @@
+
+
+
Backups and Restorations

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000004.html b/docs/geminidb/api-ref/topic_300000004.html
new file mode 100644
index 00000000..15c74230
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000004.html
@@ -0,0 +1,29 @@
+
+
+
Parameter Templates

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000005.html b/docs/geminidb/api-ref/topic_300000005.html
new file mode 100644
index 00000000..281401e8
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000005.html
@@ -0,0 +1,19 @@
+
+
+
Tags

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000006.html b/docs/geminidb/api-ref/topic_300000006.html
new file mode 100644
index 00000000..c533053c
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000006.html
@@ -0,0 +1,16 @@
+
+
+
Logs

+

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000007.html b/docs/geminidb/api-ref/topic_300000007.html
new file mode 100644
index 00000000..3672e81f
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000007.html
@@ -0,0 +1,15 @@
+
+
+
Quotas

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+
diff --git a/docs/geminidb/api-ref/topic_300000016.html b/docs/geminidb/api-ref/topic_300000016.html
new file mode 100644
index 00000000..987c285f
--- /dev/null
+++ b/docs/geminidb/api-ref/topic_300000016.html
@@ -0,0 +1,15 @@
+
+
+
Task Management

+

+

+
+
+

+
Parent topic: APIs v3

+

+

+