diff --git a/docs/geminidb/api-ref/ALL_META.TXT.json b/docs/geminidb/api-ref/ALL_META.TXT.json index 04fa5f807..db92ccc54 100644 --- a/docs/geminidb/api-ref/ALL_META.TXT.json +++ b/docs/geminidb/api-ref/ALL_META.TXT.json @@ -316,14 +316,14 @@ "code":"16", "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":"Versions and Specifications", + "kw":"API Versions and Specifications", "search_title":"", "metedata":[ { } ], - "title":"Versions and Specifications", + "title":"API Versions and Specifications", "githuburl":"" }, { @@ -331,9 +331,9 @@ "node_id":"nosql_instance_specification.xml", "product_code":"nosql", "code":"17", - "des":"This API is used to query all instance specifications under a specified condition.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{proje", + "des":"This API is used to query all instance specifications under a specified condition.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{E", "doc_type":"api", - "kw":"Querying Instance Specifications,Versions and Specifications,API Reference", + "kw":"Querying Instance Specifications,API Versions and Specifications,API Reference", "search_title":"", "metedata":[ { @@ -407,7 +407,7 @@ "node_id":"nosql_06_0002.xml", "product_code":"nosql", "code":"21", - "des":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API can be used for GeminiDB Cassandra instances.GET http", + "des":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API can be used for GeminiDB Cassandra and GeminiDB Influ", "doc_type":"api", "kw":"Obtaining Parameter Templates,Parameter Templates,API Reference", "search_title":"", @@ -428,7 +428,7 @@ "node_id":"nosql_06_0005.xml", "product_code":"nosql", "code":"22", - "des":"This API is used to apply a parameter template to one or more instances.This API can be used for GeminiDB Cassandra instances.This API is an asynchronous API. A successfu", + "des":"This API is used to apply a parameter template to one or more instances.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.This API is an asynchron", "doc_type":"api", "kw":"Applying a Parameter Template,Parameter Templates,API Reference", "search_title":"", @@ -449,7 +449,7 @@ "node_id":"nosql_06_0006.xml", "product_code":"nosql", "code":"23", - "des":"This API is used to modify parameters of a specified instance.This API can be used for GeminiDB Cassandra instances.For configuration item values, you can enter system-de", + "des":"This API is used to modify parameters of a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.For configuration item values, you", "doc_type":"api", "kw":"Modifying Parameters of a Specified Instance,Parameter Templates,API Reference", "search_title":"", @@ -575,7 +575,7 @@ "node_id":"nosql_database_version.xml", "product_code":"nosql", "code":"29", - "des":"This API is used to query version information of a specified type of instances.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id", + "des":"This API is used to query version information of a specified type of instances.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endp", "doc_type":"api", "kw":"Querying Version Information,Versions and Specifications,API Reference", "search_title":"", @@ -659,7 +659,7 @@ "node_id":"nosql_05_0016.xml", "product_code":"nosql", "code":"33", - "des":"This API is used to query instances and details based on specified conditions.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}", + "des":"This API is used to query instances and details based on specified conditions.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpo", "doc_type":"api", "kw":"Querying Instances and Details,Instances,API Reference", "search_title":"", @@ -680,7 +680,7 @@ "node_id":"nosql_05_0050.xml", "product_code":"nosql", "code":"34", - "des":"This API is used to scale up storage space of an instance.This API can be used for GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instanc", + "des":"This API is used to scale up storage space of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.POST https://{Endpoint}/v3/{project_id", "doc_type":"api", "kw":"Scaling Up Storage Space of an Instance,Instances,API Reference", "search_title":"", @@ -701,7 +701,7 @@ "node_id":"nosql_05_0051.xml", "product_code":"nosql", "code":"35", - "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", + "des":"This API is used to add nodes for a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.POST https://{Endpoint}/v3/{project_id}/i", "doc_type":"api", "kw":"Adding Nodes for an Instance,Instances,API Reference", "search_title":"", @@ -743,7 +743,7 @@ "node_id":"nosql_05_0156.xml", "product_code":"nosql", "code":"37", - "des":"This API is used to query instance specifications that can be changed.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instanc", + "des":"This API is used to query instance specifications that can be changed.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpoint}/v3/", "doc_type":"api", "kw":"Querying Changeable Specifications,Instances,API Reference", "search_title":"", @@ -785,7 +785,7 @@ "node_id":"nosql_05_0101.xml", "product_code":"nosql", "code":"39", - "des":"This API is used to reset the administrator password of an instance.This API can be used for GeminiDB Cassandra instances.Abnormal instances do not support this operation", + "des":"This API is used to reset the administrator password of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.Abnormal instances do not su", "doc_type":"api", "kw":"Resetting the Administrator Password of an Instance,Instances,API Reference", "search_title":"", @@ -806,7 +806,7 @@ "node_id":"nosql_05_0102.xml", "product_code":"nosql", "code":"40", - "des":"This API is used to edit the name of an instance.This API can be used for GeminiDB Cassandra instances.The name of the instance that is being created or fails to be creat", + "des":"This API is used to edit the name of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.The name of the instance that is being created ", "doc_type":"api", "kw":"Editing the Name of an Instance,Instances,API Reference", "search_title":"", @@ -827,7 +827,7 @@ "node_id":"nosql_05_0103.xml", "product_code":"nosql", "code":"41", - "des":"This API is used to change the security group associated with an instance.This API can be used for GeminiDB Cassandra instances.Abnormal instances do not support this ope", + "des":"This API is used to change the security group associated with an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.Abnormal instances do ", "doc_type":"api", "kw":"Changing the Security Group of an Instance,Instances,API Reference", "search_title":"", @@ -843,11 +843,74 @@ "title":"Changing the Security Group of an Instance", "githuburl":"" }, + { + "uri":"BatchUpgradeDbVersion.html", + "node_id":"batchupgradedbversion.xml", + "product_code":"nosql", + "code":"42", + "des":"This API is used to patch databases in batches.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxUpgrad", + "doc_type":"api", + "kw":"Patching Databases In Batches,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Patching Databases In Batches", + "githuburl":"" + }, + { + "uri":"nosql_05_0107.html", + "node_id":"nosql_05_0107.xml", + "product_code":"nosql", + "code":"43", + "des":"This API is used to enable or disable SSL.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxThe instanc", + "doc_type":"api", + "kw":"Enabling or Disabling SSL,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Enabling or Disabling SSL", + "githuburl":"" + }, + { + "uri":"nosql_05_0108.html", + "node_id":"nosql_05_0108.xml", + "product_code":"nosql", + "code":"44", + "des":"This API is used to restart an instance.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxIf the instan", + "doc_type":"api", + "kw":"Restarting an Instance,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Restarting an Instance", + "githuburl":"" + }, { "uri":"nosql_05_0109.html", "node_id":"nosql_05_0109.xml", "product_code":"nosql", - "code":"42", + "code":"45", "des":"This API is used to configure an autoscaling policy for storage space.This API supports GeminiDB Cassandra instances.This API supports both pay-per-use and yearly/monthly", "doc_type":"api", "kw":"Configuring an Autoscaling Policy for Storage Space,Instances,API Reference", @@ -864,11 +927,74 @@ "title":"Configuring an Autoscaling Policy for Storage Space", "githuburl":"" }, + { + "uri":"nosql_05_0110.html", + "node_id":"nosql_05_0110.xml", + "product_code":"nosql", + "code":"46", + "des":"This API is used to check whether the password is weak.POST https://{Endpoint}/v3/{project_id}/weak-password-verificationStatus code: 200URI examplePOST https://{Endpoint", + "doc_type":"api", + "kw":"Checking Password Strength,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Checking Password Strength", + "githuburl":"" + }, + { + "uri":"nosql_05_0113.html", + "node_id":"nosql_05_0113.xml", + "product_code":"nosql", + "code":"47", + "des":"This API is used to delete the node that fails to be added to an instance.This API supports the following types of instances:GeminiDB CassandraDELETE https://{Endpoint}/v", + "doc_type":"api", + "kw":"Deleting the Node that Fails to Be Added,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Deleting the Node that Fails to Be Added", + "githuburl":"" + }, + { + "uri":"nosql_05_0114.html", + "node_id":"nosql_05_0114.xml", + "product_code":"nosql", + "code":"48", + "des":"This API is used to query IP addresses required for creating an instance or adding nodes to an instance.This API supports the following instances:GeminiDB CassandraGemini", + "doc_type":"api", + "kw":"Querying IP Addresses Required for Creating an Instance or Adding Nodes,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying IP Addresses Required for Creating an Instance or Adding Nodes", + "githuburl":"" + }, { "uri":"nosql_05_0115.html", "node_id":"nosql_05_0115.xml", "product_code":"nosql", - "code":"43", + "code":"49", "des":"This API is used to query the autoscaling policy of storage space.This API supports the following types of instances:GeminiDB CassandraGET https://{Endpoint}/v3/{project_", "doc_type":"api", "kw":"Querying the Autoscaling Policy of Storage Space,Instances,API Reference", @@ -885,11 +1011,49 @@ "title":"Querying the Autoscaling Policy of Storage Space", "githuburl":"" }, + { + "uri":"nosql_05_0116.html", + "node_id":"nosql_05_0116.xml", + "product_code":"nosql", + "code":"50", + "des":"This API is used to scale storage space of an instance.This API supports the following instances:GeminiDB CassandraThis API supports both yearly/monthly and pay-per-use i", + "doc_type":"api", + "kw":"Scaling Storage Space of an Instance,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Scaling Storage Space of an Instance", + "githuburl":"" + }, + { + "uri":"nosql_05_0062.html", + "node_id":"nosql_05_0062.xml", + "product_code":"", + "code":"51", + "des":"This API is used to set the maintenance period of a specified instance.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraPUT https://{En", + "doc_type":"", + "kw":"Setting the Maintenance Period of an Instance,Instances,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Setting the Maintenance Period of an Instance", + "githuburl":"" + }, { "uri":"topic_300000003.html", "node_id":"topic_300000003.xml", "product_code":"nosql", - "code":"44", + "code":"52", "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", @@ -910,8 +1074,8 @@ "uri":"nosql_api_0031.html", "node_id":"nosql_api_0031.xml", "product_code":"nosql", - "code":"45", - "des":"This API is used to configuring an automated backup policy.This API can be used for GeminiDB Cassandra instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instanc", + "code":"53", + "des":"This API is used to configuring an automated backup policy.This API can be used on GeminiDB Cassandra and GeminiDB Influx instances.PUT https://{Endpoint}/v3/{project_id}", "doc_type":"api", "kw":"Configuring an Automated Backup Policy,Backups and Restorations,API Reference", "search_title":"", @@ -931,8 +1095,8 @@ "uri":"ListRestoreTime.html", "node_id":"listrestoretime.xml", "product_code":"nosql", - "code":"46", - "des":"This API is used to query the time window when a backup can be restored.This API supports the following types of instances:GeminiDB CassandraMake sure that full backup, i", + "code":"54", + "des":"This API is used to query the time window when a backup can be restored.This API supports the following instances:GeminiDB CassandraMake sure that full backup, incrementa", "doc_type":"api", "kw":"Querying the Time Window When a Backup Can Be Restored,Backups and Restorations,API Reference", "search_title":"", @@ -952,8 +1116,8 @@ "uri":"nosql_api_0032.html", "node_id":"nosql_api_0032.xml", "product_code":"nosql", - "code":"47", - "des":"This API is used to create a manual backup.This API supports the following instance type:GeminiDB CassandraPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}", + "code":"55", + "des":"This API is used to create a manual backup.This API supports the following instances:GeminiDB CassandraGeminiDB InfluxPOST https://{Endpoint}/v3/{project_id}/instances/{i", "doc_type":"api", "kw":"Creating a Manual Backup,Backups and Restorations,API Reference", "search_title":"", @@ -969,11 +1133,95 @@ "title":"Creating a Manual Backup", "githuburl":"" }, + { + "uri":"DeleteBackup.html", + "node_id":"deletebackup.xml", + "product_code":"nosql", + "code":"56", + "des":"This API is used to delete a manual backup.This API supports the following instances:GeminiDB CassandraGeminiDB InfluxDELETE https://{Endpoint}/v3/{project_id}/backups/{b", + "doc_type":"api", + "kw":"Deleting a Manual Backup,Backups and Restorations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Deleting a Manual Backup", + "githuburl":"" + }, + { + "uri":"nosql_api_0033.html", + "node_id":"nosql_api_0033.xml", + "product_code":"nosql", + "code":"57", + "des":"This API is used to query the recycling policy.GET https://{Endpoint}/v3/{project_id}/instances/recycle-policyStatus code: 200URI exampleGET https://{Endpoint}/v3/054e292", + "doc_type":"api", + "kw":"Querying the Recycling Policy,Backups and Restorations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying the Recycling Policy", + "githuburl":"" + }, + { + "uri":"nosql_api_0034.html", + "node_id":"nosql_api_0034.xml", + "product_code":"nosql", + "code":"58", + "des":"This API is used to change a retention period for deleted instances. The new retention period is available to only those instances deleted after the change, but not to th", + "doc_type":"api", + "kw":"Modifying the Recycling Policy,Backups and Restorations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Modifying the Recycling Policy", + "githuburl":"" + }, + { + "uri":"nosql_api_0035.html", + "node_id":"nosql_api_0035.xml", + "product_code":"nosql", + "code":"59", + "des":"This API is used to query all instances in the recycle bin.GET https://{Endpoint}/v3/{project_id}/recycle-instancesStatus code: 200URI exampleGET https://{Endpoint}/v3/61", + "doc_type":"api", + "kw":"Querying Instances in the Recycle Bin,Backups and Restorations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Instances in the Recycle Bin", + "githuburl":"" + }, { "uri":"topic_300000004.html", "node_id":"topic_300000004.xml", "product_code":"nosql", - "code":"48", + "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":"Parameter Templates", @@ -994,7 +1242,7 @@ "uri":"nosql_06_0003.html", "node_id":"nosql_06_0003.xml", "product_code":"nosql", - "code":"49", + "code":"61", "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 can be use", "doc_type":"api", "kw":"Creating a Parameter Template,Parameter Templates,API Reference", @@ -1015,8 +1263,8 @@ "uri":"nosql_06_0004.html", "node_id":"nosql_06_0004.xml", "product_code":"nosql", - "code":"50", - "des":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API can be used for GeminiDB Cassandra i", + "code":"62", + "des":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.The modified parameter template name must be ", "doc_type":"api", "kw":"Modifying Parameters in a Parameter Template,Parameter Templates,API Reference", "search_title":"", @@ -1036,8 +1284,8 @@ "uri":"nosql_06_0007.html", "node_id":"nosql_06_0007.xml", "product_code":"nosql", - "code":"51", - "des":"This API is used to query instance parameter settings.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}", + "code":"63", + "des":"This API is used to query instance parameter settings.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpoint}/v3/{project_id}/ins", "doc_type":"api", "kw":"Querying Instance Parameter Settings,Parameter Templates,API Reference", "search_title":"", @@ -1057,7 +1305,7 @@ "uri":"nosql_06_0008.html", "node_id":"nosql_06_0008.xml", "product_code":"nosql", - "code":"52", + "code":"64", "des":"This API is used to obtain information about parameters of a specified parameter template.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/", "doc_type":"api", "kw":"Obtaining Parameters of a Specified Parameter Template,Parameter Templates,API Reference", @@ -1078,7 +1326,7 @@ "uri":"nosql_06_0009.html", "node_id":"nosql_06_0009.xml", "product_code":"nosql", - "code":"53", + "code":"65", "des":"This API is used to delete a specified parameter template.This API can be used for GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{", "doc_type":"api", "kw":"Deleting a Parameter Template,Parameter Templates,API Reference", @@ -1095,11 +1343,137 @@ "title":"Deleting a Parameter Template", "githuburl":"" }, + { + "uri":"QueryApplicableInstances.html", + "node_id":"queryapplicableinstances.xml", + "product_code":"nosql", + "code":"66", + "des":"This API is used to query instances that a parameter template can be applied to.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxGET https:", + "doc_type":"api", + "kw":"Querying Instances that a Parameter Template Can Be Applied To,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Instances that a Parameter Template Can Be Applied To", + "githuburl":"" + }, + { + "uri":"QueryModifyHistory.html", + "node_id":"querymodifyhistory.xml", + "product_code":"nosql", + "code":"67", + "des":"This API is used to view change history of parameters of an instance.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxThis API can be used ", + "doc_type":"api", + "kw":"Viewing Parameter Change History of an Instance,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Viewing Parameter Change History of an Instance", + "githuburl":"" + }, + { + "uri":"QueryApplyHistory.html", + "node_id":"queryapplyhistory.xml", + "product_code":"nosql", + "code":"68", + "des":"This API is used to view application records of a parameter template.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxAfter an instance is ", + "doc_type":"api", + "kw":"Viewing Application Records of a Parameter Template,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Viewing Application Records of a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0110.html", + "node_id":"nosql_06_0110.xml", + "product_code":"nosql", + "code":"69", + "des":"This API is used to compare two parameter templates.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxThis API only compares parameter t", + "doc_type":"api", + "kw":"Comparing Parameter Templates,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Comparing Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_06_0111.html", + "node_id":"nosql_06_0111.xml", + "product_code":"nosql", + "code":"70", + "des":"This API is used to replicate a parameter template.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxThe parameter template generated af", + "doc_type":"api", + "kw":"Replicating a Parameter Template,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Replicating a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0112.html", + "node_id":"nosql_06_0112.xml", + "product_code":"nosql", + "code":"71", + "des":"This API is used to query database types that support parameter templates.GET https://{Endpoint}/v3/{project_id}/configurations/datastoresStatus code: 200URI exampleGET h", + "doc_type":"api", + "kw":"Querying Database Types That Support Parameter Templates,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Database Types That Support Parameter Templates", + "githuburl":"" + }, { "uri":"topic_300000005.html", "node_id":"topic_300000005.xml", "product_code":"nosql", - "code":"54", + "code":"72", "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", @@ -1120,8 +1494,8 @@ "uri":"ListInstancesByResourceTags.html", "node_id":"listinstancesbyresourcetags.xml", "product_code":"nosql", - "code":"55", - "des":"This API is used to query a specified instance by tag.This API can be used for GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag ke", + "code":"73", + "des":"This API is used to query a specified instance by tag.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum of 20 tags can be added to a DB ", "doc_type":"api", "kw":"Querying an Instance by Tag,Tags,API Reference", "search_title":"", @@ -1141,8 +1515,8 @@ "uri":"BatchTagAction.html", "node_id":"batchtagaction.xml", "product_code":"nosql", - "code":"56", - "des":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API can be used for GeminiDB Cassandra instances.A maximum of 20 tags can be a", + "code":"74", + "des":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum", "doc_type":"api", "kw":"Adding or Deleting Resource Tags in Batches,Tags,API Reference", "search_title":"", @@ -1162,8 +1536,8 @@ "uri":"ListInstanceTags.html", "node_id":"listinstancetags.xml", "product_code":"nosql", - "code":"57", - "des":"This API is used to query tags of a specified instance.This API can be used for GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag k", + "code":"75", + "des":"This API is used to query tags of a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum of 20 tags can be added to a DB", "doc_type":"api", "kw":"Querying Tags of an Instance,Tags,API Reference", "search_title":"", @@ -1179,11 +1553,32 @@ "title":"Querying Tags of an Instance", "githuburl":"" }, + { + "uri":"topic_300000015.html", + "node_id":"topic_300000015.xml", + "product_code":"nosql", + "code":"76", + "des":"This API is used to query tags of a specified project.GET https://{Endpoint}/v3/{project_id}/tagsStatus code: 200URI exampleGET https://{Endpoint}/v3/0549b4a43100d4f32f51", + "doc_type":"api", + "kw":"Querying Tags of a Specified Project,Tags,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Tags of a Specified Project", + "githuburl":"" + }, { "uri":"topic_300000006.html", "node_id":"topic_300000006.xml", "product_code":"nosql", - "code":"58", + "code":"77", "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", @@ -1204,8 +1599,8 @@ "uri":"ListSlowLogs.html", "node_id":"listslowlogs.xml", "product_code":"nosql", - "code":"59", - "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", + "code":"78", + "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 can be used for GeminiDB Cassandra and GeminiDB ", "doc_type":"api", "kw":"Querying Database Slow Logs,Logs,API Reference", "search_title":"", @@ -1221,11 +1616,32 @@ "title":"Querying Database Slow Logs", "githuburl":"" }, + { + "uri":"nosql_10_0003.html", + "node_id":"nosql_10_0003.xml", + "product_code":"nosql", + "code":"79", + "des":"This API is used to query slow query logs of GeminiDB Cassandra instances. Searching for slow query logs by keyword is supported.Operators &&, ||, AND, OR, NOT, *, ?, :, ", + "doc_type":"api", + "kw":"Querying Slow Query Logs of a GeminiDB Cassandra Instance,Logs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Slow Query Logs of a GeminiDB Cassandra Instance", + "githuburl":"" + }, { "uri":"topic_300000007.html", "node_id":"topic_300000007.xml", "product_code":"nosql", - "code":"60", + "code":"80", "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", @@ -1246,7 +1662,7 @@ "uri":"ShowQuotas.html", "node_id":"showquotas.xml", "product_code":"nosql", - "code":"61", + "code":"81", "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,API Reference", @@ -1267,7 +1683,7 @@ "uri":"topic_300000016.html", "node_id":"topic_300000016.xml", "product_code":"", - "code":"62", + "code":"82", "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", @@ -1284,7 +1700,7 @@ "uri":"nosql_10_0100.html", "node_id":"nosql_10_0100.xml", "product_code":"", - "code":"63", + "code":"83", "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,API Reference", @@ -1297,11 +1713,125 @@ "title":"Querying Tasks and Details", "githuburl":"" }, + { + "uri":"nosql_10_0101.html", + "node_id":"nosql_10_0101.xml", + "product_code":"", + "code":"84", + "des":"This function is used to query the maintenance period of an instance.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraGET https://{Endp", + "doc_type":"", + "kw":"Querying the Maintenance Period of an Instance,Task Management,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying the Maintenance Period of an Instance", + "githuburl":"" + }, + { + "uri":"nosql_10_0102.html", + "node_id":"nosql_10_0102.xml", + "product_code":"", + "code":"85", + "des":"This function is used to query scheduled tasks based on specified conditions.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraGET https", + "doc_type":"", + "kw":"Querying Scheduled Tasks,Task Management,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Querying Scheduled Tasks", + "githuburl":"" + }, + { + "uri":"nosql_10_0103.html", + "node_id":"nosql_10_0103.xml", + "product_code":"", + "code":"86", + "des":"This function is used to cancel a scheduled task based on the task ID.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraDELETE https://{", + "doc_type":"", + "kw":"Canceling a Scheduled Task,Task Management,API Reference", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Canceling a Scheduled Task", + "githuburl":"" + }, + { + "uri":"topic_300000017.html", + "node_id":"topic_300000017.xml", + "product_code":"nosql", + "code":"87", + "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":"Enterprise Projects", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Enterprise Projects", + "githuburl":"" + }, + { + "uri":"topic_300000018.html", + "node_id":"topic_300000018.xml", + "product_code":"nosql", + "code":"88", + "des":"This API is used to query enterprise project quotas.GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotasStatus code: 200URI exampleGET https://{Endpoint}/v3/", + "doc_type":"api", + "kw":"Querying Enterprise Project Quotas,Enterprise Projects,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Enterprise Project Quotas", + "githuburl":"" + }, + { + "uri":"topic_300000019.html", + "node_id":"topic_300000019.xml", + "product_code":"nosql", + "code":"89", + "des":"This API is used to modify enterprise project quotas.PUT https://{Endpoint}/v3/{project_id}/enterprise-projects/quotasStatus code: 204No response parametersURI examplePUT", + "doc_type":"api", + "kw":"Modifying Enterprise Project Quotas,Enterprise Projects,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Modifying Enterprise Project Quotas", + "githuburl":"" + }, { "uri":"nosql_05_0203.html", "node_id":"nosql_05_0203.xml", "product_code":"nosql", - "code":"64", + "code":"90", "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":"Historical APIs", @@ -1322,7 +1852,7 @@ "uri":"nosql_06_3001.html", "node_id":"nosql_06_3001.xml", "product_code":"", - "code":"65", + "code":"91", "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":"Backup and Restoration", @@ -1339,7 +1869,7 @@ "uri":"nosql_05_0211.html", "node_id":"nosql_05_0211.xml", "product_code":"nosql", - "code":"66", + "code":"92", "des":"This API is used to query backups based on specified conditions.You can view incremental and differential backups and their sizes on GeminiDB Cassandra instances.GET http", "doc_type":"api", "kw":"Querying Backups (Recommended),Backup and Restoration,API Reference", @@ -1360,7 +1890,7 @@ "uri":"nosql_06_3002.html", "node_id":"nosql_06_3002.xml", "product_code":"nosql", - "code":"67", + "code":"93", "des":"This API is used to query an automated backup policy.This API will be unavailable. You are advised to switch workloads to the new API described in Querying an Automated B", "doc_type":"api", "kw":"Querying an Automated Backup Policy,Backup and Restoration,API Reference", @@ -1381,7 +1911,7 @@ "uri":"nosql_05_0205.html", "node_id":"nosql_05_0205.xml", "product_code":"nosql", - "code":"68", + "code":"94", "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", @@ -1402,7 +1932,7 @@ "uri":"nosql_06_0218.html", "node_id":"nosql_06_0218.xml", "product_code":"nosql", - "code":"69", + "code":"95", "des":"This API is used to apply a parameter template to one or more instances.This API will be unavailable. You are advised to switch workloads to the new API described in Appl", "doc_type":"api", "kw":"Applying a Parameter Template,Parameter Templates,API Reference", @@ -1423,7 +1953,7 @@ "uri":"nosql_06_0219.html", "node_id":"nosql_06_0219.xml", "product_code":"nosql", - "code":"70", + "code":"96", "des":"This API is used to modify parameters of a specified instance.This API will be unavailable. You are advised to switch workloads to the new API described in Modifying Para", "doc_type":"api", "kw":"Modifying Parameters of a Specified Instance,Parameter Templates,API Reference", @@ -1444,7 +1974,7 @@ "uri":"nosql_public_parameters.html", "node_id":"nosql_public_parameters.xml", "product_code":"nosql", - "code":"71", + "code":"97", "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", @@ -1465,7 +1995,7 @@ "uri":"nosql_abnormal_result.html", "node_id":"nosql_abnormal_result.xml", "product_code":"nosql", - "code":"72", + "code":"98", "des":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", "doc_type":"api", "kw":"Abnormal Request Results,Appendixes,API Reference", @@ -1486,7 +2016,7 @@ "uri":"nosql_status_code.html", "node_id":"nosql_status_code.xml", "product_code":"nosql", - "code":"73", + "code":"99", "des":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", "doc_type":"api", "kw":"Status Codes,Appendixes,API Reference", @@ -1507,7 +2037,7 @@ "uri":"nosql_error_code.html", "node_id":"nosql_error_code.xml", "product_code":"nosql", - "code":"74", + "code":"100", "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,API Reference", @@ -1528,7 +2058,7 @@ "uri":"nosql_projectid.html", "node_id":"nosql_projectid.xml", "product_code":"nosql", - "code":"75", + "code":"101", "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,API Reference", @@ -1549,7 +2079,7 @@ "uri":"nosql_metrics.html", "node_id":"nosql_metrics.xml", "product_code":"nosql", - "code":"76", + "code":"102", "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,API Reference", @@ -1570,7 +2100,7 @@ "uri":"nosql_08_0001.html", "node_id":"nosql_08_0001.xml", "product_code":"nosql", - "code":"77", + "code":"103", "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,API Reference", @@ -1591,7 +2121,7 @@ "uri":"nosql_change_history02.html", "node_id":"nosql_change_history02.xml", "product_code":"nosql", - "code":"78", + "code":"104", "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,API Reference", diff --git a/docs/geminidb/api-ref/BatchTagAction.html b/docs/geminidb/api-ref/BatchTagAction.html index 81a9497ef..a5389b53e 100644 --- a/docs/geminidb/api-ref/BatchTagAction.html +++ b/docs/geminidb/api-ref/BatchTagAction.html @@ -3,11 +3,11 @@

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 can be used for GeminiDB Cassandra instances.

+

Constraints

This API can be used for GeminiDB Cassandra and GeminiDB Influx 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.

+

If the tag to be deleted does not exist, the operation is considered successful by default. The character set of the tag is not verified during the deletion.

URI

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

@@ -44,32 +44,32 @@

Request Parameters

-
Table 2 Request header parameter

Parameter

+
- - - - - - - - - - - @@ -149,7 +149,7 @@

Response Parameters

Status code: 200

None

-

Example Request

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

    Example Requests

    • URI example
      POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action
    • Adding two tags
      {
         "action" : "create",
         "tags" : [ {
      @@ -171,7 +171,7 @@
       }
    -

    Example Response

    Status code: 200

    +

    Example Responses

    Status code: 200

    Success

    { }
    diff --git a/docs/geminidb/api-ref/BatchUpgradeDbVersion.html b/docs/geminidb/api-ref/BatchUpgradeDbVersion.html new file mode 100644 index 000000000..0dbc5082f --- /dev/null +++ b/docs/geminidb/api-ref/BatchUpgradeDbVersion.html @@ -0,0 +1,237 @@ + + +

    Patching Databases In Batches

    +

    Function

    This API is used to patch databases in batches.

    +
    +

    Constraints

    • This API supports the following types of instances:
      • GeminiDB Cassandra
      • GeminiDB Influx
      +
    +
    • Upgrade is triggered immediately, so patch databases during off-peak hours.
    +
    +

    URI

    POST https://{Endpoint}/v3/{project_id}/instances/db-upgrade

    + +
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

MIME type of the request body. application/json is recommended.

+

MIME type of the request body. application/json is recommended.

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token

+ + + + + + + + + + + +
Table 1 URI 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

+

Content-Type

+

Yes

+

String

+

MIME type of the request body. application/json is recommended.

+

X-Auth-Token

+

Yes

+

String

+

User token

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

Parameter

+

Mandatory

+

Type

+

Description

+

instance_ids

+

Yes

+

Array of strings

+

IDs of instances where databases need to be patched. Up to 10 IDs of an instance of the same GeminiDB engine type can be specified at a time.

+
+
+
+

Response Parameters

Status code: 202

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

Parameter

+

Type

+

Description

+

upgrade_results

+

Array of objects

+

Batch upgrade result

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 UpgradeResult

Parameter

+

Type

+

Description

+

job_id

+

String

+

Task ID returned only when a patch installation task is successfully submitted

+

instance_id

+

String

+

Instance ID

+

error_code

+

String

+

Error code returned only when a patch installation task fails to be submitted

+

error_message

+

String

+

Failure cause returned only when a patch installation task fails to be submitted

+
+
+

Status code: 400

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code

+

error_msg

+

String

+

Error message

+
+
+

Status code: 500

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

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code

+

error_msg

+

String

+

Error message

+
+
+
+

Example Requests

URI example
POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/db-upgrade
+
+

Example Requests

+
Patching databases in batches
{ 
+   "instance_ids" : [ "046287aae57843b1a7bc61b7a8812f41in13", "3d1e04f49efa473a8c7eaf07ed7ff870in13" ] 
+ }
+
+
+

Example Responses

Status code: 202

+

Accepted

+
{ 
+  "upgrade_results" : [ { 
+    "instance_id" : "046287aae57843b1a7bc61b7a8812f41in13", 
+    "job_id" : "e4616470-733d-41de-a9b0-a260709293d3" 
+  }, { 
+    "instance_id" : "3d1e04f49efa473a8c7eaf07ed7ff870in13", 
+    "error_code" : "DBS.200011", 
+    "error_message" : "The status of DB instance does not allow the operation." 
+  } ] 
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+ +
+ +
+ diff --git a/docs/geminidb/api-ref/CLASS.TXT.json b/docs/geminidb/api-ref/CLASS.TXT.json index 02eee529c..b2ddcfa54 100644 --- a/docs/geminidb/api-ref/CLASS.TXT.json +++ b/docs/geminidb/api-ref/CLASS.TXT.json @@ -137,14 +137,14 @@ { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"", - "title":"Versions and Specifications", + "title":"API Versions and Specifications", "uri":"nosql_12_0006.html", "doc_type":"", "p_code":"15", "code":"16" }, { - "desc":"This API is used to query all instance specifications under a specified condition.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{proje", + "desc":"This API is used to query all instance specifications under a specified condition.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{E", "product_code":"nosql", "title":"Querying Instance Specifications", "uri":"nosql_instance_specification.html", @@ -180,7 +180,7 @@ "code":"20" }, { - "desc":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API can be used for GeminiDB Cassandra instances.GET http", + "desc":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API can be used for GeminiDB Cassandra and GeminiDB Influ", "product_code":"nosql", "title":"Obtaining Parameter Templates", "uri":"nosql_06_0002.html", @@ -189,7 +189,7 @@ "code":"21" }, { - "desc":"This API is used to apply a parameter template to one or more instances.This API can be used for GeminiDB Cassandra instances.This API is an asynchronous API. A successfu", + "desc":"This API is used to apply a parameter template to one or more instances.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.This API is an asynchron", "product_code":"nosql", "title":"Applying a Parameter Template", "uri":"nosql_06_0005.html", @@ -198,7 +198,7 @@ "code":"22" }, { - "desc":"This API is used to modify parameters of a specified instance.This API can be used for GeminiDB Cassandra instances.For configuration item values, you can enter system-de", + "desc":"This API is used to modify parameters of a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.For configuration item values, you", "product_code":"nosql", "title":"Modifying Parameters of a Specified Instance", "uri":"nosql_06_0006.html", @@ -252,7 +252,7 @@ "code":"28" }, { - "desc":"This API is used to query version information of a specified type of instances.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id", + "desc":"This API is used to query version information of a specified type of instances.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endp", "product_code":"nosql", "title":"Querying Version Information", "uri":"nosql_database_version.html", @@ -288,7 +288,7 @@ "code":"32" }, { - "desc":"This API is used to query instances and details based on specified conditions.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}", + "desc":"This API is used to query instances and details based on specified conditions.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpo", "product_code":"nosql", "title":"Querying Instances and Details", "uri":"nosql_05_0016.html", @@ -297,7 +297,7 @@ "code":"33" }, { - "desc":"This API is used to scale up storage space of an instance.This API can be used for GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instanc", + "desc":"This API is used to scale up storage space of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.POST https://{Endpoint}/v3/{project_id", "product_code":"nosql", "title":"Scaling Up Storage Space of an Instance", "uri":"nosql_05_0050.html", @@ -306,7 +306,7 @@ "code":"34" }, { - "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", + "desc":"This API is used to add nodes for a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.POST https://{Endpoint}/v3/{project_id}/i", "product_code":"nosql", "title":"Adding Nodes for an Instance", "uri":"nosql_05_0051.html", @@ -324,7 +324,7 @@ "code":"36" }, { - "desc":"This API is used to query instance specifications that can be changed.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instanc", + "desc":"This API is used to query instance specifications that can be changed.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpoint}/v3/", "product_code":"nosql", "title":"Querying Changeable Specifications", "uri":"nosql_05_0156.html", @@ -342,7 +342,7 @@ "code":"38" }, { - "desc":"This API is used to reset the administrator password of an instance.This API can be used for GeminiDB Cassandra instances.Abnormal instances do not support this operation", + "desc":"This API is used to reset the administrator password of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.Abnormal instances do not su", "product_code":"nosql", "title":"Resetting the Administrator Password of an Instance", "uri":"nosql_05_0101.html", @@ -351,7 +351,7 @@ "code":"39" }, { - "desc":"This API is used to edit the name of an instance.This API can be used for GeminiDB Cassandra instances.The name of the instance that is being created or fails to be creat", + "desc":"This API is used to edit the name of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.The name of the instance that is being created ", "product_code":"nosql", "title":"Editing the Name of an Instance", "uri":"nosql_05_0102.html", @@ -360,7 +360,7 @@ "code":"40" }, { - "desc":"This API is used to change the security group associated with an instance.This API can be used for GeminiDB Cassandra instances.Abnormal instances do not support this ope", + "desc":"This API is used to change the security group associated with an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.Abnormal instances do ", "product_code":"nosql", "title":"Changing the Security Group of an Instance", "uri":"nosql_05_0103.html", @@ -368,6 +368,33 @@ "p_code":"30", "code":"41" }, + { + "desc":"This API is used to patch databases in batches.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxUpgrad", + "product_code":"nosql", + "title":"Patching Databases In Batches", + "uri":"BatchUpgradeDbVersion.html", + "doc_type":"api", + "p_code":"30", + "code":"42" + }, + { + "desc":"This API is used to enable or disable SSL.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxThe instanc", + "product_code":"nosql", + "title":"Enabling or Disabling SSL", + "uri":"nosql_05_0107.html", + "doc_type":"api", + "p_code":"30", + "code":"43" + }, + { + "desc":"This API is used to restart an instance.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxIf the instan", + "product_code":"nosql", + "title":"Restarting an Instance", + "uri":"nosql_05_0108.html", + "doc_type":"api", + "p_code":"30", + "code":"44" + }, { "desc":"This API is used to configure an autoscaling policy for storage space.This API supports GeminiDB Cassandra instances.This API supports both pay-per-use and yearly/monthly", "product_code":"nosql", @@ -375,7 +402,34 @@ "uri":"nosql_05_0109.html", "doc_type":"api", "p_code":"30", - "code":"42" + "code":"45" + }, + { + "desc":"This API is used to check whether the password is weak.POST https://{Endpoint}/v3/{project_id}/weak-password-verificationStatus code: 200URI examplePOST https://{Endpoint", + "product_code":"nosql", + "title":"Checking Password Strength", + "uri":"nosql_05_0110.html", + "doc_type":"api", + "p_code":"30", + "code":"46" + }, + { + "desc":"This API is used to delete the node that fails to be added to an instance.This API supports the following types of instances:GeminiDB CassandraDELETE https://{Endpoint}/v", + "product_code":"nosql", + "title":"Deleting the Node that Fails to Be Added", + "uri":"nosql_05_0113.html", + "doc_type":"api", + "p_code":"30", + "code":"47" + }, + { + "desc":"This API is used to query IP addresses required for creating an instance or adding nodes to an instance.This API supports the following instances:GeminiDB CassandraGemini", + "product_code":"nosql", + "title":"Querying IP Addresses Required for Creating an Instance or Adding Nodes", + "uri":"nosql_05_0114.html", + "doc_type":"api", + "p_code":"30", + "code":"48" }, { "desc":"This API is used to query the autoscaling policy of storage space.This API supports the following types of instances:GeminiDB CassandraGET https://{Endpoint}/v3/{project_", @@ -384,7 +438,25 @@ "uri":"nosql_05_0115.html", "doc_type":"api", "p_code":"30", - "code":"43" + "code":"49" + }, + { + "desc":"This API is used to scale storage space of an instance.This API supports the following instances:GeminiDB CassandraThis API supports both yearly/monthly and pay-per-use i", + "product_code":"nosql", + "title":"Scaling Storage Space of an Instance", + "uri":"nosql_05_0116.html", + "doc_type":"api", + "p_code":"30", + "code":"50" + }, + { + "desc":"This API is used to set the maintenance period of a specified instance.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraPUT https://{En", + "product_code":"", + "title":"Setting the Maintenance Period of an Instance", + "uri":"nosql_05_0062.html", + "doc_type":"", + "p_code":"30", + "code":"51" }, { "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.", @@ -393,34 +465,70 @@ "uri":"topic_300000003.html", "doc_type":"api", "p_code":"24", - "code":"44" + "code":"52" }, { - "desc":"This API is used to configuring an automated backup policy.This API can be used for GeminiDB Cassandra instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instanc", + "desc":"This API is used to configuring an automated backup policy.This API can be used on GeminiDB Cassandra and GeminiDB Influx instances.PUT https://{Endpoint}/v3/{project_id}", "product_code":"nosql", "title":"Configuring an Automated Backup Policy", "uri":"nosql_api_0031.html", "doc_type":"api", - "p_code":"44", - "code":"45" + "p_code":"52", + "code":"53" }, { - "desc":"This API is used to query the time window when a backup can be restored.This API supports the following types of instances:GeminiDB CassandraMake sure that full backup, i", + "desc":"This API is used to query the time window when a backup can be restored.This API supports the following instances:GeminiDB CassandraMake sure that full backup, incrementa", "product_code":"nosql", "title":"Querying the Time Window When a Backup Can Be Restored", "uri":"ListRestoreTime.html", "doc_type":"api", - "p_code":"44", - "code":"46" + "p_code":"52", + "code":"54" }, { - "desc":"This API is used to create a manual backup.This API supports the following instance type:GeminiDB CassandraPOST https://{Endpoint}/v3/{project_id}/instances/{instance_id}", + "desc":"This API is used to create a manual backup.This API supports the following instances:GeminiDB CassandraGeminiDB InfluxPOST https://{Endpoint}/v3/{project_id}/instances/{i", "product_code":"nosql", "title":"Creating a Manual Backup", "uri":"nosql_api_0032.html", "doc_type":"api", - "p_code":"44", - "code":"47" + "p_code":"52", + "code":"55" + }, + { + "desc":"This API is used to delete a manual backup.This API supports the following instances:GeminiDB CassandraGeminiDB InfluxDELETE https://{Endpoint}/v3/{project_id}/backups/{b", + "product_code":"nosql", + "title":"Deleting a Manual Backup", + "uri":"DeleteBackup.html", + "doc_type":"api", + "p_code":"52", + "code":"56" + }, + { + "desc":"This API is used to query the recycling policy.GET https://{Endpoint}/v3/{project_id}/instances/recycle-policyStatus code: 200URI exampleGET https://{Endpoint}/v3/054e292", + "product_code":"nosql", + "title":"Querying the Recycling Policy", + "uri":"nosql_api_0033.html", + "doc_type":"api", + "p_code":"52", + "code":"57" + }, + { + "desc":"This API is used to change a retention period for deleted instances. The new retention period is available to only those instances deleted after the change, but not to th", + "product_code":"nosql", + "title":"Modifying the Recycling Policy", + "uri":"nosql_api_0034.html", + "doc_type":"api", + "p_code":"52", + "code":"58" + }, + { + "desc":"This API is used to query all instances in the recycle bin.GET https://{Endpoint}/v3/{project_id}/recycle-instancesStatus code: 200URI exampleGET https://{Endpoint}/v3/61", + "product_code":"nosql", + "title":"Querying Instances in the Recycle Bin", + "uri":"nosql_api_0035.html", + "doc_type":"api", + "p_code":"52", + "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.", @@ -429,7 +537,7 @@ "uri":"topic_300000004.html", "doc_type":"api", "p_code":"24", - "code":"48" + "code":"60" }, { "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 can be use", @@ -437,26 +545,26 @@ "title":"Creating a Parameter Template", "uri":"nosql_06_0003.html", "doc_type":"api", - "p_code":"48", - "code":"49" + "p_code":"60", + "code":"61" }, { - "desc":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API can be used for GeminiDB Cassandra i", + "desc":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.The modified parameter template name must be ", "product_code":"nosql", "title":"Modifying Parameters in a Parameter Template", "uri":"nosql_06_0004.html", "doc_type":"api", - "p_code":"48", - "code":"50" + "p_code":"60", + "code":"62" }, { - "desc":"This API is used to query instance parameter settings.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}", + "desc":"This API is used to query instance parameter settings.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpoint}/v3/{project_id}/ins", "product_code":"nosql", "title":"Querying Instance Parameter Settings", "uri":"nosql_06_0007.html", "doc_type":"api", - "p_code":"48", - "code":"51" + "p_code":"60", + "code":"63" }, { "desc":"This API is used to obtain information about parameters of a specified parameter template.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/", @@ -464,8 +572,8 @@ "title":"Obtaining Parameters of a Specified Parameter Template", "uri":"nosql_06_0008.html", "doc_type":"api", - "p_code":"48", - "code":"52" + "p_code":"60", + "code":"64" }, { "desc":"This API is used to delete a specified parameter template.This API can be used for GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{", @@ -473,8 +581,62 @@ "title":"Deleting a Parameter Template", "uri":"nosql_06_0009.html", "doc_type":"api", - "p_code":"48", - "code":"53" + "p_code":"60", + "code":"65" + }, + { + "desc":"This API is used to query instances that a parameter template can be applied to.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxGET https:", + "product_code":"nosql", + "title":"Querying Instances that a Parameter Template Can Be Applied To", + "uri":"QueryApplicableInstances.html", + "doc_type":"api", + "p_code":"60", + "code":"66" + }, + { + "desc":"This API is used to view change history of parameters of an instance.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxThis API can be used ", + "product_code":"nosql", + "title":"Viewing Parameter Change History of an Instance", + "uri":"QueryModifyHistory.html", + "doc_type":"api", + "p_code":"60", + "code":"67" + }, + { + "desc":"This API is used to view application records of a parameter template.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxAfter an instance is ", + "product_code":"nosql", + "title":"Viewing Application Records of a Parameter Template", + "uri":"QueryApplyHistory.html", + "doc_type":"api", + "p_code":"60", + "code":"68" + }, + { + "desc":"This API is used to compare two parameter templates.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxThis API only compares parameter t", + "product_code":"nosql", + "title":"Comparing Parameter Templates", + "uri":"nosql_06_0110.html", + "doc_type":"api", + "p_code":"60", + "code":"69" + }, + { + "desc":"This API is used to replicate a parameter template.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxThe parameter template generated af", + "product_code":"nosql", + "title":"Replicating a Parameter Template", + "uri":"nosql_06_0111.html", + "doc_type":"api", + "p_code":"60", + "code":"70" + }, + { + "desc":"This API is used to query database types that support parameter templates.GET https://{Endpoint}/v3/{project_id}/configurations/datastoresStatus code: 200URI exampleGET h", + "product_code":"nosql", + "title":"Querying Database Types That Support Parameter Templates", + "uri":"nosql_06_0112.html", + "doc_type":"api", + "p_code":"60", + "code":"71" }, { "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.", @@ -483,34 +645,43 @@ "uri":"topic_300000005.html", "doc_type":"api", "p_code":"24", - "code":"54" + "code":"72" }, { - "desc":"This API is used to query a specified instance by tag.This API can be used for GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag ke", + "desc":"This API is used to query a specified instance by tag.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum of 20 tags can be added to a DB ", "product_code":"nosql", "title":"Querying an Instance by Tag", "uri":"ListInstancesByResourceTags.html", "doc_type":"api", - "p_code":"54", - "code":"55" + "p_code":"72", + "code":"73" }, { - "desc":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API can be used for GeminiDB Cassandra instances.A maximum of 20 tags can be a", + "desc":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum", "product_code":"nosql", "title":"Adding or Deleting Resource Tags in Batches", "uri":"BatchTagAction.html", "doc_type":"api", - "p_code":"54", - "code":"56" + "p_code":"72", + "code":"74" }, { - "desc":"This API is used to query tags of a specified instance.This API can be used for GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag k", + "desc":"This API is used to query tags of a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum of 20 tags can be added to a DB", "product_code":"nosql", "title":"Querying Tags of an Instance", "uri":"ListInstanceTags.html", "doc_type":"api", - "p_code":"54", - "code":"57" + "p_code":"72", + "code":"75" + }, + { + "desc":"This API is used to query tags of a specified project.GET https://{Endpoint}/v3/{project_id}/tagsStatus code: 200URI exampleGET https://{Endpoint}/v3/0549b4a43100d4f32f51", + "product_code":"nosql", + "title":"Querying Tags of a Specified Project", + "uri":"topic_300000015.html", + "doc_type":"api", + "p_code":"72", + "code":"76" }, { "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.", @@ -519,16 +690,25 @@ "uri":"topic_300000006.html", "doc_type":"api", "p_code":"24", - "code":"58" + "code":"77" }, { - "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", + "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 can be used for GeminiDB Cassandra and GeminiDB ", "product_code":"nosql", "title":"Querying Database Slow Logs", "uri":"ListSlowLogs.html", "doc_type":"api", - "p_code":"58", - "code":"59" + "p_code":"77", + "code":"78" + }, + { + "desc":"This API is used to query slow query logs of GeminiDB Cassandra instances. Searching for slow query logs by keyword is supported.Operators &&, ||, AND, OR, NOT, *, ?, :, ", + "product_code":"nosql", + "title":"Querying Slow Query Logs of a GeminiDB Cassandra Instance", + "uri":"nosql_10_0003.html", + "doc_type":"api", + "p_code":"77", + "code":"79" }, { "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.", @@ -537,7 +717,7 @@ "uri":"topic_300000007.html", "doc_type":"api", "p_code":"24", - "code":"60" + "code":"80" }, { "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", @@ -545,8 +725,8 @@ "title":"Querying Quota", "uri":"ShowQuotas.html", "doc_type":"api", - "p_code":"60", - "code":"61" + "p_code":"80", + "code":"81" }, { "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.", @@ -555,7 +735,7 @@ "uri":"topic_300000016.html", "doc_type":"", "p_code":"24", - "code":"62" + "code":"82" }, { "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", @@ -563,8 +743,62 @@ "title":"Querying Tasks and Details", "uri":"nosql_10_0100.html", "doc_type":"", - "p_code":"62", - "code":"63" + "p_code":"82", + "code":"83" + }, + { + "desc":"This function is used to query the maintenance period of an instance.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraGET https://{Endp", + "product_code":"", + "title":"Querying the Maintenance Period of an Instance", + "uri":"nosql_10_0101.html", + "doc_type":"", + "p_code":"82", + "code":"84" + }, + { + "desc":"This function is used to query scheduled tasks based on specified conditions.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraGET https", + "product_code":"", + "title":"Querying Scheduled Tasks", + "uri":"nosql_10_0102.html", + "doc_type":"", + "p_code":"82", + "code":"85" + }, + { + "desc":"This function is used to cancel a scheduled task based on the task ID.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraDELETE https://{", + "product_code":"", + "title":"Canceling a Scheduled Task", + "uri":"nosql_10_0103.html", + "doc_type":"", + "p_code":"82", + "code":"86" + }, + { + "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":"Enterprise Projects", + "uri":"topic_300000017.html", + "doc_type":"api", + "p_code":"24", + "code":"87" + }, + { + "desc":"This API is used to query enterprise project quotas.GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotasStatus code: 200URI exampleGET https://{Endpoint}/v3/", + "product_code":"nosql", + "title":"Querying Enterprise Project Quotas", + "uri":"topic_300000018.html", + "doc_type":"api", + "p_code":"87", + "code":"88" + }, + { + "desc":"This API is used to modify enterprise project quotas.PUT https://{Endpoint}/v3/{project_id}/enterprise-projects/quotasStatus code: 204No response parametersURI examplePUT", + "product_code":"nosql", + "title":"Modifying Enterprise Project Quotas", + "uri":"topic_300000019.html", + "doc_type":"api", + "p_code":"87", + "code":"89" }, { "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.", @@ -573,7 +807,7 @@ "uri":"nosql_05_0203.html", "doc_type":"api", "p_code":"", - "code":"64" + "code":"90" }, { "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.", @@ -581,8 +815,8 @@ "title":"Backup and Restoration", "uri":"nosql_06_3001.html", "doc_type":"", - "p_code":"64", - "code":"65" + "p_code":"90", + "code":"91" }, { "desc":"This API is used to query backups based on specified conditions.You can view incremental and differential backups and their sizes on GeminiDB Cassandra instances.GET http", @@ -590,8 +824,8 @@ "title":"Querying Backups (Recommended)", "uri":"nosql_05_0211.html", "doc_type":"api", - "p_code":"65", - "code":"66" + "p_code":"91", + "code":"92" }, { "desc":"This API is used to query an automated backup policy.This API will be unavailable. You are advised to switch workloads to the new API described in Querying an Automated B", @@ -599,8 +833,8 @@ "title":"Querying an Automated Backup Policy", "uri":"nosql_06_3002.html", "doc_type":"api", - "p_code":"65", - "code":"67" + "p_code":"91", + "code":"93" }, { "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.", @@ -608,8 +842,8 @@ "title":"Parameter Templates", "uri":"nosql_05_0205.html", "doc_type":"api", - "p_code":"64", - "code":"68" + "p_code":"90", + "code":"94" }, { "desc":"This API is used to apply a parameter template to one or more instances.This API will be unavailable. You are advised to switch workloads to the new API described in Appl", @@ -617,8 +851,8 @@ "title":"Applying a Parameter Template", "uri":"nosql_06_0218.html", "doc_type":"api", - "p_code":"68", - "code":"69" + "p_code":"94", + "code":"95" }, { "desc":"This API is used to modify parameters of a specified instance.This API will be unavailable. You are advised to switch workloads to the new API described in Modifying Para", @@ -626,8 +860,8 @@ "title":"Modifying Parameters of a Specified Instance", "uri":"nosql_06_0219.html", "doc_type":"api", - "p_code":"68", - "code":"70" + "p_code":"94", + "code":"96" }, { "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.", @@ -636,7 +870,7 @@ "uri":"nosql_public_parameters.html", "doc_type":"api", "p_code":"", - "code":"71" + "code":"97" }, { "desc":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", @@ -644,8 +878,8 @@ "title":"Abnormal Request Results", "uri":"nosql_abnormal_result.html", "doc_type":"api", - "p_code":"71", - "code":"72" + "p_code":"97", + "code":"98" }, { "desc":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", @@ -653,8 +887,8 @@ "title":"Status Codes", "uri":"nosql_status_code.html", "doc_type":"api", - "p_code":"71", - "code":"73" + "p_code":"97", + "code":"99" }, { "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", @@ -662,8 +896,8 @@ "title":"Error Codes", "uri":"nosql_error_code.html", "doc_type":"api", - "p_code":"71", - "code":"74" + "p_code":"97", + "code":"100" }, { "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", @@ -671,8 +905,8 @@ "title":"Obtaining a Project ID", "uri":"nosql_projectid.html", "doc_type":"api", - "p_code":"71", - "code":"75" + "p_code":"97", + "code":"101" }, { "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", @@ -680,8 +914,8 @@ "title":"Metrics", "uri":"nosql_metrics.html", "doc_type":"api", - "p_code":"71", - "code":"76" + "p_code":"97", + "code":"102" }, { "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.", @@ -689,8 +923,8 @@ "title":"Events Supported by Event Monitoring", "uri":"nosql_08_0001.html", "doc_type":"api", - "p_code":"71", - "code":"77" + "p_code":"97", + "code":"103" }, { "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.", @@ -699,6 +933,6 @@ "uri":"nosql_change_history02.html", "doc_type":"api", "p_code":"", - "code":"78" + "code":"104" } ] \ No newline at end of file diff --git a/docs/geminidb/api-ref/DeleteBackup.html b/docs/geminidb/api-ref/DeleteBackup.html new file mode 100644 index 000000000..35a47f21c --- /dev/null +++ b/docs/geminidb/api-ref/DeleteBackup.html @@ -0,0 +1,107 @@ + + +

Deleting a Manual Backup

+

Function

This API is used to delete a manual backup.

+
+

Constraints

This API supports the following instances:

+
  • GeminiDB Cassandra
  • GeminiDB Influx
+
+

URI

DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 URI parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

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

+

backup_id

+

Yes

+

String

+

Backup file 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/054e292c9880d4992f02c0196d3ea468/backups/5b0ae36cb8a746b68685a8fb588d8a15br06
    +
+
+

Example Responses

Status code: 202

+

Accepted

+
{
+  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"
+}
+
+

Status Codes

See Status Codes.

+
+

Error Codes

See Error Codes.

+
+
+
+ +
+ diff --git a/docs/geminidb/api-ref/ListInstanceTags.html b/docs/geminidb/api-ref/ListInstanceTags.html index 9ba3f76a9..5726a6272 100644 --- a/docs/geminidb/api-ref/ListInstanceTags.html +++ b/docs/geminidb/api-ref/ListInstanceTags.html @@ -3,7 +3,7 @@

Querying Tags of an Instance

Function

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

-

Constraints

This API can be used for GeminiDB Cassandra instances.

+

Constraints

This API can be used for GeminiDB Cassandra and GeminiDB Influx 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

@@ -41,23 +41,23 @@

Request Parameters

-
Table 2 Request header parameter

Parameter

+
- - - - - - - @@ -66,7 +66,7 @@

Response Parameters

Status code: 200

-
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token

Table 3 Response body parameter

Parameter

+
diff --git a/docs/geminidb/api-ref/ListInstancesByResourceTags.html b/docs/geminidb/api-ref/ListInstancesByResourceTags.html index 2a2718156..c939c01d3 100644 --- a/docs/geminidb/api-ref/ListInstancesByResourceTags.html +++ b/docs/geminidb/api-ref/ListInstancesByResourceTags.html @@ -3,12 +3,12 @@

Querying an Instance by Tag

Function

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

-

Constraints

This API can be used for GeminiDB Cassandra instances.

+

Constraints

This API can be used for GeminiDB Cassandra and GeminiDB Influx 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 3 Response body parameters

Parameter

Type

Table 1 URI parameter

Parameter

+
@@ -32,32 +32,32 @@

Request Parameters

-
Table 1 URI parameters

Parameter

Mandatory

Table 2 Request header parameter

Parameter

+
- - - - - - - - - - - @@ -283,7 +283,7 @@
Table 2 Request header parameters

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

Content-Type

+

Content-Type

Yes

+

Yes

String

+

String

MIME type of the request body. application/json is recommended.

+

MIME type of the request body. application/json is recommended.

X-Auth-Token

+

X-Auth-Token

Yes

+

Yes

String

+

String

User token.

+

User token

-

Example Request

  • URI example
    POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource-instances/action
    +

    Example Requests

    • URI example
      POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/resource-instances/action
    • Example request body

      Querying an instance by name (Set offset to 100 and limit to 100.)

      {
         "offset" : 100,
      @@ -318,7 +318,7 @@
       }
    -

    Example Response

    Status code: 200

    +

    Example Responses

    Status code: 200

    Success

    {
       "total_count": 1,
    diff --git a/docs/geminidb/api-ref/ListRestoreTime.html b/docs/geminidb/api-ref/ListRestoreTime.html
    index 0c6ed5da3..e9cc951ff 100644
    --- a/docs/geminidb/api-ref/ListRestoreTime.html
    +++ b/docs/geminidb/api-ref/ListRestoreTime.html
    @@ -3,7 +3,7 @@
     

    Querying the Time Window When a Backup Can Be Restored

    Function

    This API is used to query the time window when a backup can be restored.

    -

    Constraints

    This API supports the following types of instances:

    +

    Constraints

    This API supports the following instances:

    • GeminiDB Cassandra

    Make sure that full backup, incremental backup, and automated backup have been enabled. To enable incremental backup, contact customer service. This function can be used only when the next automated backup is performed.

    This API can be used to query the time point that a backup can be restored to, so values of start_time and end_time are the same.

    @@ -94,7 +94,7 @@

    Request Parameters

    -
    Table 3 Request header parameter

    Parameter

    +
    @@ -171,10 +171,10 @@
    Table 3 Request header parameters

    Parameter

    Mandatory

    -

    Example Request

    • URI example
      GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=1000
      +

      Example Requests

      • URI example
        GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups/restorable-time-periods?start_time=2022-06-01T18:50:20+0800&end_time=2022-06-01T19:50:20+0800&offset=0&limit=1000
      -

      Example Response

      Status code: 200

      +

      Example Responses

      Status code: 200

      Success

      {
         "total_count" : 1,
      diff --git a/docs/geminidb/api-ref/ListSlowLogs.html b/docs/geminidb/api-ref/ListSlowLogs.html
      index f0fb37bfa..f090c32eb 100644
      --- a/docs/geminidb/api-ref/ListSlowLogs.html
      +++ b/docs/geminidb/api-ref/ListSlowLogs.html
      @@ -3,7 +3,7 @@
       

      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

      • This API supports GeminiDB Cassandra instances.
      • This API can be used to query only the latest 2000 slow query logs in a specified time range.
      +

      Constraints

      • This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.
      • This API can be used to query only the latest 2000 slow query logs in a specified time range.

      URI

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

      @@ -234,9 +234,9 @@ } ] }
      -

      Status Codes

      For details, see Status Codes.

      +

      Status Codes

      See Status Codes.

      -

      Error Codes

      For details, see Error Codes.

      +

      Error Codes

      See Error Codes.

      diff --git a/docs/geminidb/api-ref/QueryApplicableInstances.html b/docs/geminidb/api-ref/QueryApplicableInstances.html new file mode 100644 index 000000000..b1ee592ba --- /dev/null +++ b/docs/geminidb/api-ref/QueryApplicableInstances.html @@ -0,0 +1,179 @@ + + +

      Querying Instances that a Parameter Template Can Be Applied To

      +

      Function

      This API is used to query instances that a parameter template can be applied to.

      +
      +

      Constraints

      This API supports the following instance types:

      +
      • GeminiDB Cassandra
      • GeminiDB Influx
      +
      +

      URI

      GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances

      + +
      + + + + + + + + + + + + + + + + +
      Table 1 URI 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.

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      offset

      +

      No

      +

      Integer

      +

      Index offset.

      +

      If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.

      +

      The value must be a non-negative number.

      +

      limit

      +

      No

      +

      Integer

      +

      Maximum records to 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

      +

      instances

      +

      Array of ApplicableInstanceRsp objects

      +

      All instances.

      +

      count

      +

      Integer

      +

      Maximum number of instances that parameters can be applied to.

      +
      +
      + +
      + + + + + + + + + + + + + +
      Table 5 ApplicableInstanceRsp

      Parameter

      +

      Type

      +

      Description

      +

      id

      +

      String

      +

      Instance ID.

      +

      name

      +

      String

      +

      Instance name.

      +
      +
      +
      +

      Example Request

      • URI example
        GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/9e80bf6bbd7142f49761c07e9c32dd04pr06/applicable-instances?offset=0&limit=10
        +
      +
      +

      Example Response

      Status code: 200

      +

      Successful response

      +
      {
      +  "instances" : [ {
      +    "id" : "f38e203908bd4fae82714e88f12600f6in06",
      +    "name" : "test"
      +  } ],
      +  "count" : 1000
      +}
      +
      +

      Status Codes

      See Status Codes.

      +
      +

      Error Codes

      See Error Codes.

      +
      +
      +
      + +
      + diff --git a/docs/geminidb/api-ref/QueryApplyHistory.html b/docs/geminidb/api-ref/QueryApplyHistory.html new file mode 100644 index 000000000..f7bd5ba26 --- /dev/null +++ b/docs/geminidb/api-ref/QueryApplyHistory.html @@ -0,0 +1,207 @@ + + +

      Viewing Application Records of a Parameter Template

      +

      Function

      This API is used to view application records of a parameter template.

      +
      +

      Constraints

      This API supports the following instance types:

      +
      • GeminiDB Cassandra
      • GeminiDB Influx
      +

      After an instance is deleted, application records of the parameter template that the instance uses are also deleted.

      +
      +

      URI

      GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories

      + +
      + + + + + + + + + + + + + + + + +
      Table 1 URI 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.

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      offset

      +

      No

      +

      Integer

      +

      Index offset.

      +

      If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.

      +

      The value must be a non-negative number.

      +

      limit

      +

      No

      +

      Integer

      +

      Maximum records to 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

      +

      total_count

      +

      Integer

      +

      Total number of records

      +

      histories

      +

      Array of ApplyHistoryRsp objects

      +

      Application records of a parameter template.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 5 ApplyHistoryRsp

      Parameter

      +

      Type

      +

      Description

      +

      instance_id

      +

      String

      +

      Instance ID.

      +

      instance_name

      +

      String

      +

      Instance name.

      +

      applied_at

      +

      String

      +

      Effective 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.

      +

      apply_result

      +

      String

      +
      • SUCCESS: indicates that the parameter template is applied to the corresponding instance.
      • Applying: indicates that the parameter template is being applied to the corresponding instance.
      • FAILED: indicates that the parameter template fails to be applied to the corresponding instance.
      +

      failure_reason

      +

      String

      +

      Failure cause.

      +
      +
      +
      +

      Example Requests

      • URI example
        GET https://{Endpoint}/v3/056f86e8d480d3cb2f43c00183f75e1f/configurations/e02e76567ae04662a2753492b77f965bpr06/applied-histories?offset=0&limit=10
        +
      +
      +

      Example Responses

      Status code: 200

      +

      Success

      +
      {
      +    "total_count" : 1,
      +    "histories" : [
      +    {
      +      "instance_id" : "a2d0cf32db3e4f2aa3a684240e10b457in06",
      +      "instance_name" : "test",
      +      "applied_at" : "2022-09-20T11:17:04+0000",
      +      "apply_result" : "SUCCESS",
      +      "failure_reason": ""
      +    }
      +  ]
      +}
      +
      +

      Status Codes

      See Status Codes.

      +
      +

      Error Codes

      See Error Codes.

      +
      +
      +
      + +
      + diff --git a/docs/geminidb/api-ref/QueryModifyHistory.html b/docs/geminidb/api-ref/QueryModifyHistory.html new file mode 100644 index 000000000..554b12bc0 --- /dev/null +++ b/docs/geminidb/api-ref/QueryModifyHistory.html @@ -0,0 +1,224 @@ + + +

      Viewing Parameter Change History of an Instance

      +

      Function

      This API is used to view change history of parameters of an instance.

      +
      +

      Constraints

      This API supports the following instance types:

      +
      • GeminiDB Cassandra
      • GeminiDB Influx
      +

      This API can be used to query only the past seven days of parameter changes.

      +
      +

      URI

      GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configuration-histories

      + +
      + + + + + + + + + + + + + + + + +
      Table 1 URI 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

      +

      offset

      +

      No

      +

      Integer

      +

      Index offset.

      +

      If offset is set to N, the query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.

      +

      The value must be a non-negative number.

      +

      limit

      +

      No

      +

      Integer

      +

      Maximum records to 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

      +

      total_count

      +

      Integer

      +

      Total number of parameter change records

      +

      By default, the total number of parameter change records is returned. If a parameter name is searched, the total number of records that meet the search criteria is returned.

      +

      histories

      +

      Array of ConfigurationHistoryRsp objects

      +

      Change history of parameters of an instance.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Table 5 ConfigurationHistoryRsp

      Parameter

      +

      Type

      +

      Description

      +

      parameter_name

      +

      String

      +

      Parameter name.

      +

      old_value

      +

      String

      +

      Original parameter value.

      +

      new_value

      +

      String

      +

      New parameter value.

      +

      update_result

      +

      String

      +

      Update result. The value can be:

      +
      • SUCCESS: The operation succeeded.
      • FAILED: The operation failed.
      +

      applied

      +

      Boolean

      +
      • true: A change is applied.
      • false: A change is not applied.
      +

      updated_at

      +

      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.

      +

      applied_at

      +

      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

      • URI example
        GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/c4e095105bc64797bc3be633ae7201eein10/configuration-histories?offset=0&limit=10
        +
      +
      +

      Example Responses

      Status code: 200

      +

      Success

      +
      {
      +    "total_count" : 1,
      +    "histories" : [ {
      +    "parameter_name" : "mongos.connPoolMaxShardedConnsPerHost",
      +    "old_value" : "600",
      +    "new_value" : "500",
      +    "update_result" : "FAILED",
      +    "applied" : true,
      +    "updated_at" : "2022-09-20T11:17:04+0000",
      +    "applied_at" : "2022-09-20T11:17:04+0000"
      +  } ]
      +}
      +
      +

      Status Codes

      See Status Codes.

      +
      +

      Error Codes

      See Error Codes.

      +
      +
      +
      + +
      + diff --git a/docs/geminidb/api-ref/nosql_05_0014.html b/docs/geminidb/api-ref/nosql_05_0014.html index 471565ded..1536513f0 100644 --- a/docs/geminidb/api-ref/nosql_05_0014.html +++ b/docs/geminidb/api-ref/nosql_05_0014.html @@ -3,11 +3,11 @@

      Creating an Instance

      Function

      • This API can be used to create an instance.
      • This API is used to restore data from a specified backup to a new instance. The number of nodes of the new instance must be greater than or equal to that in the original instance, and the storage of the new instance must be greater than or equal to that of the original instance.
      • This API is used to restore data of a specified instance at a specified point in time to a new instance. The number of nodes of the new instance must be greater than or equal to that in the original instance, and the storage of the new instance must be greater than or equal to that of the original instance.
      -

      Constraints

      This API can be used for GeminiDB Cassandra instances.

      +

      Constraints

      This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

      URI

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

      -
      Table 1 URI parameter

      Parameter

      +
      @@ -31,32 +31,32 @@

      Request Parameters

      -
      Table 1 URI parameters

      Parameter

      Mandatory

      Table 2 Request header parameter

      Parameter

      +
      - - - - - - - - - - - @@ -160,7 +160,8 @@ @@ -243,7 +244,7 @@ @@ -284,17 +285,17 @@ - - - @@ -572,7 +573,7 @@
      Table 2 Request header parameters

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      Content-Type

      +

      Content-Type

      Yes

      +

      Yes

      String

      +

      String

      MIME type of the request body. application/json is recommended.

      +

      MIME type of the request body. application/json is recommended.

      X-Auth-Token

      +

      X-Auth-Token

      Yes

      +

      Yes

      String

      +

      String

      User token.

      +

      User token

      String

      Instance type. The value can be:

      -
      • Cluster, indicating that GeminiDB Cassandra supports the cluster type.
      +
      • Cluster, indicating that GeminiDB Cassandra supports the cluster type.
      • CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage

        +

      flavor

      @@ -219,7 +220,7 @@

      RestoreInfo object

      Backup information. You can restore data from a specific backup or instance to a specific point in time during the backup retention period.

      -

      You can restore data only of a GeminiDB Cassandra cluster instance to a specific point in time.

      +

      You can restore data only of GeminiDB Cassandra and GeminiDB Influx cluster instances to a specified point in time.

      String

      Database type.

      -
      • GeminiDB Cassandra instances are supported.
      • If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
      +
      • GeminiDB Cassandra and GeminiDB Influx instances are supported.
      • If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
      • If you set this parameter to influxdb, GeminiDB Influx instances will be created.

      version

      @@ -253,7 +254,7 @@

      String

      Database version.

      -
      • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
      +
      • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
      • 1.7, indicating that GeminiDB Influx 1.7 is supported.

      storage_engine

      @@ -263,7 +264,7 @@

      String

      Storage engine.

      -
      • rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
      +
      • rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
      • rocksDB, indicating that the GeminiDB Influx instance supports the RocksDB storage engine.

      Yes

      String

      +

      Integer

      Number of nodes.

      -
      • Each GeminiDB Cassandra instance can run on 3 to 200 nodes.
      +
      • Each GeminiDB Cassandra instance can run on 3 to 200 nodes.
      • Each GeminiDB Influx cluster instance can run on 2 to 9 nodes.

      size

      Yes

      String

      +

      Integer

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

      @@ -349,7 +350,7 @@

      No

      String

      +

      Integer

      Backup retention days.

      The value ranges from 0 to 35.

      @@ -536,7 +537,7 @@

      String

      Database type.

      -
      • GeminiDB Cassandra instances are supported.
      • If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
      +
      • GeminiDB Cassandra and GeminiDB Influx instances are supported.
      • If you set this parameter to cassandra, GeminiDB Cassandra instances will be created.
      • If you set this parameter to influxdb, GeminiDB Influx instances will be created.

      version

      @@ -544,7 +545,7 @@

      String

      Database version.

      -
      • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
      +
      • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
      • 1.7, indicating that GeminiDB Influx 1.7 is supported.

      storage_engine

      @@ -552,7 +553,7 @@

      String

      Storage engine.

      -
      • rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
      +
      • rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
      • rocksDB, indicating that the GeminiDB Influx instance supports the RocksDB storage engine.

      String

      Number of nodes.

      -
      • Each GeminiDB Cassandra instance can run on 3 to 200 nodes.
      +
      • Each GeminiDB Cassandra instance can run on 3 to 200 nodes.
      • Each GeminiDB Influx instance can run on 2 to 9 nodes.

      size

      @@ -633,7 +634,7 @@
      -

      Example Request

      • URI example
        POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances
        +

        Example Requests

        • URI example
          POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances
        • Creating a pay-per-use 3-node GeminiDB Cassandra instance with 16 vCPUs and 64 GB of memory

          Values of region and availability_zone in the request body are only examples. Set them based on service requirements.

          {
          @@ -727,7 +728,7 @@
            }
        -

        Example Response

        Status code: 202

        +

        Example Responses

        Status code: 202

        Accepted

        {
           "id" : "39b6a1a278844ac48119d86512e0000bin06",
        diff --git a/docs/geminidb/api-ref/nosql_05_0015.html b/docs/geminidb/api-ref/nosql_05_0015.html
        index 8f9de8937..bb57e2952 100644
        --- a/docs/geminidb/api-ref/nosql_05_0015.html
        +++ b/docs/geminidb/api-ref/nosql_05_0015.html
        @@ -3,7 +3,7 @@
         

        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 can be used for GeminiDB Cassandra instances.

        +

        Constraints

        This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

        URI

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

        @@ -40,7 +40,7 @@

        Request Parameters

        -
        Table 2 Request header parameter

        Parameter

        +
        diff --git a/docs/geminidb/api-ref/nosql_05_0016.html b/docs/geminidb/api-ref/nosql_05_0016.html index 0dd9ec821..1975a003e 100644 --- a/docs/geminidb/api-ref/nosql_05_0016.html +++ b/docs/geminidb/api-ref/nosql_05_0016.html @@ -3,11 +3,11 @@

        Querying Instances and Details

        Function

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

        -

        Constraints

        This API can be used for GeminiDB Cassandra instances.

        +

        Constraints

        This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

        URI

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

        -
        Table 2 Request header parameters

        Parameter

        Mandatory

        Table 1 URI parameter

        Parameter

        +
        @@ -68,6 +68,7 @@ @@ -78,7 +79,8 @@ @@ -127,7 +129,7 @@

        Request Parameters

        -
        Table 1 URI parameters

        Parameter

        Mandatory

        Database type. The value can be:

        cassandra, indicating that GeminiDB Cassandra instances are queried.

        +

        If you set this parameter to influxdb,GeminiDB Influx instances are queried.

        If this parameter is not transferred, all database instances are queried.

        String

        Instance type. The value can be:

        -

        Cluster: GeminiDB Cassandra cluster instances

        +
        • Cluster: GeminiDB Cassandra cluster instance
        • CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance

          +

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

        Table 3 Request header parameter

        Parameter

        +
        @@ -278,7 +280,7 @@
        Table 3 Request header parameters

        Parameter

        Mandatory

        String

        Subnet ID.

        -

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

        +

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

        security_group_id

        @@ -548,14 +550,14 @@
        -

        Example Request

        • URI example

          Querying all instances and details

          +

          Example Requests

          • URI example

            Querying all instances and details

            GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances
          • URI example

            Querying instances and details based on specified conditions

            GET https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances?offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&name=hy&mode={mode}&datastore_type={datastore_type}&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7
          -

          Example Response

          Status code: 200

          +

          Example Responses

          Status code: 200

          Success

          {
             "instances" : [ {
          diff --git a/docs/geminidb/api-ref/nosql_05_0050.html b/docs/geminidb/api-ref/nosql_05_0050.html
          index ceee983d4..39730d22d 100644
          --- a/docs/geminidb/api-ref/nosql_05_0050.html
          +++ b/docs/geminidb/api-ref/nosql_05_0050.html
          @@ -3,7 +3,7 @@
           

          Scaling Up Storage Space of an Instance

          Function

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

          -

          Constraints

          This API can be used for GeminiDB Cassandra instances.

          +

          Constraints

          This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

          URI

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

          @@ -40,32 +40,32 @@

          Request Parameters

          -
          Table 2 Request header parameter

          Parameter

          +
          - - - - - - - - - - - @@ -118,13 +118,13 @@
          Table 2 Request header parameters

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          Content-Type

          +

          Content-Type

          Yes

          +

          Yes

          String

          +

          String

          MIME type of the request body. application/json is recommended.

          +

          MIME type of the request body. application/json is recommended.

          X-Auth-Token

          +

          X-Auth-Token

          Yes

          +

          Yes

          String

          +

          String

          User token.

          +

          User token

          -

          Example Request

          • URI example
            POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume
            +

            Example Requests

            • URI example
              POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/extend-volume
            • Scaling up storage space of an instance to 550 GB
              {
                 "size" : 550
               }
            -

            Example Response

            Status code: 202

            +

            Example Responses

            Status code: 202

            Accepted

            {
               "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
            diff --git a/docs/geminidb/api-ref/nosql_05_0051.html b/docs/geminidb/api-ref/nosql_05_0051.html
            index cc5f70f17..318e83bd0 100644
            --- a/docs/geminidb/api-ref/nosql_05_0051.html
            +++ b/docs/geminidb/api-ref/nosql_05_0051.html
            @@ -3,7 +3,7 @@
             

            Adding Nodes for an Instance

            Function

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

            -

            Constraints

            This API supports GeminiDB Cassandra instances.

            +

            Constraints

            This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

            URI

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

            @@ -40,32 +40,32 @@

            Request Parameters

            -
            Table 2 Request header parameter

            Parameter

            +
            - - - - - - - - - - - @@ -126,13 +126,13 @@
            Table 2 Request header parameters

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            Content-Type

            +

            Content-Type

            Yes

            +

            Yes

            String

            +

            String

            MIME type of the request body. application/json is recommended.

            +

            MIME type of the request body. application/json is recommended.

            X-Auth-Token

            +

            X-Auth-Token

            Yes

            +

            Yes

            String

            +

            String

            User token.

            +

            User token

            -

            Example Request

            • URI example
              POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node
              +

              Example Requests

              • URI example
                POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/enlarge-node
              • Adding a node
                {
                   "num" : 1
                 }
              -

              Example Response

              Status code: 202

              +

              Example Responses

              Status code: 202

              Accepted

              {
                 "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
              diff --git a/docs/geminidb/api-ref/nosql_05_0052.html b/docs/geminidb/api-ref/nosql_05_0052.html
              index 0ca0196df..b79be0668 100644
              --- a/docs/geminidb/api-ref/nosql_05_0052.html
              +++ b/docs/geminidb/api-ref/nosql_05_0052.html
              @@ -40,32 +40,32 @@
               

              Request Parameters

              -
              Table 2 Request header parameter

              Parameter

              +
              - - - - - - - - - - - @@ -131,14 +131,14 @@
              Table 2 Request header parameters

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              Content-Type

              +

              Content-Type

              Yes

              +

              Yes

              String

              +

              String

              MIME type of the request body. application/json is recommended.

              +

              MIME type of the request body. application/json is recommended.

              X-Auth-Token

              +

              X-Auth-Token

              Yes

              +

              Yes

              String

              +

              String

              User token.

              +

              User token

              -

              Example Request

              • URI example
                POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node
                +

                Example Requests

                • URI example
                  POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node
                • Deleting a node
                  {
                      "num" : 1,
                      "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ]
                   }
                -

                Example Response

                Status code: 202

                +

                Example Responses

                Status code: 202

                Accepted

                {
                   "job_id" : "04efe8e2-9255-44ae-a98b-d87cae411890"
                diff --git a/docs/geminidb/api-ref/nosql_05_0062.html b/docs/geminidb/api-ref/nosql_05_0062.html
                new file mode 100644
                index 000000000..7be72a863
                --- /dev/null
                +++ b/docs/geminidb/api-ref/nosql_05_0062.html
                @@ -0,0 +1,123 @@
                +
                +
                +

                Setting the Maintenance Period of an Instance

                +

                Function

                This API is used to set the maintenance period of a specified instance.

                +
                +

                Constraints

                This API supports the following types of instances:

                +
                • GeminiDB Influx
                • GeminiDB Cassandra
                +
                +

                URI

                PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/maintenance-window

                + +
                + + + + + + + + + + + + + + + + +
                Table 1 URI 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

                +

                Content-Type

                +

                Yes

                +

                String

                +

                MIME type of the request body. application/json is recommended.

                +

                X-Auth-Token

                +

                Yes

                +

                String

                +

                User token

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

                Parameter

                +

                Mandatory

                +

                Type

                +

                Description

                +

                start_time

                +

                Yes

                +

                String

                +

                Start time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time and must be on the hour. By default, the interval between the end time and the start time is four hours.

                +
                +
                +
                +

                Response Parameters

                Status code: 204

                +

                None

                +
                +

                Example Requests

                Set the maintenance window of an instance to 02:00-06:00.

                +
                +
                PUT https://{Endpoint}/
                +/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/b0965c9010f44ffca9af4ee00746aa8din12/maintenance-window 
                + 
                +{ 
                +  "start_time" : "02:00" 
                +}
                +
                +

                Example Responses

                None

                +
                +

                Status Codes

                See Status Codes.

                +
                +

                Error Codes

                See Error Codes.

                +
                +
                +
                + +
                + diff --git a/docs/geminidb/api-ref/nosql_05_0100.html b/docs/geminidb/api-ref/nosql_05_0100.html index 55d834ac8..0dc16eb87 100644 --- a/docs/geminidb/api-ref/nosql_05_0100.html +++ b/docs/geminidb/api-ref/nosql_05_0100.html @@ -5,7 +5,7 @@

                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.

                +

                Constraints

                This API can be used for GeminiDB Cassandra and GeminiDB Influx 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.

                @@ -46,32 +46,32 @@

                Request Parameters

                -
                Table 2 Request header parameter

                Parameter

                +
                - - - - - - - - - - - @@ -146,7 +146,7 @@
                Table 2 Request header parameters

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                Content-Type

                +

                Content-Type

                Yes

                +

                Yes

                String

                +

                String

                MIME type of the request body. application/json is recommended.

                +

                MIME type of the request body. application/json is recommended.

                X-Auth-Token

                +

                X-Auth-Token

                Yes

                +

                Yes

                String

                +

                String

                User token.

                +

                User token

                -

                Example Request

                • URI example
                  PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize
                  +

                  Example Requests

                  • URI example
                    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize
                  • Changing instance specifications to 16 vCPUs and 64 GB
                    {
                       "resize" : {
                         "target_spec_code" : "geminidb.cassandra.4xlarge.4"
                    @@ -154,7 +154,7 @@
                     }
                  -

                  Example Response

                  Status code: 202

                  +

                  Example Responses

                  Status code: 202

                  Accepted

                  {
                     "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
                  diff --git a/docs/geminidb/api-ref/nosql_05_0101.html b/docs/geminidb/api-ref/nosql_05_0101.html
                  index 5b5a2babe..92777ad57 100644
                  --- a/docs/geminidb/api-ref/nosql_05_0101.html
                  +++ b/docs/geminidb/api-ref/nosql_05_0101.html
                  @@ -3,7 +3,7 @@
                   

                  Resetting the Administrator Password of an Instance

                  Function

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

                  -

                  Constraints

                  This API can be used for GeminiDB Cassandra instances.

                  +

                  Constraints

                  This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

                  Abnormal instances do not support this operation.

                  Only the password of user rwuser can be reset.

                  @@ -42,39 +42,39 @@

                  Request Parameters

                  -
                  Table 2 Request header parameter

                  Parameter

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  Content-Type

                  +

                  Content-Type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  MIME type of the request body. application/json is recommended.

                  +

                  MIME type of the request body. application/json is recommended.

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  User token.

                  +

                  User token

                  -
                  Table 3 Request body parameter

                  Parameter

                  +
                  @@ -102,13 +102,13 @@

                  Response Parameters

                  Status code: 204

                  None

                  -

                  Example Request

                  • URI example
                    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/password
                    +

                    Example Requests

                    • URI example
                      PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/password
                    • Resetting the administrator password of an instance to ******
                      {
                         "password" : "******"
                       }
                    -

                    Example Response

                    Status code: 204

                    +

                    Example Responses

                    Status code: 204

                    No Content

                    Status Codes

                    See Status Codes.

                    diff --git a/docs/geminidb/api-ref/nosql_05_0102.html b/docs/geminidb/api-ref/nosql_05_0102.html index 458632e7b..217f16afc 100644 --- a/docs/geminidb/api-ref/nosql_05_0102.html +++ b/docs/geminidb/api-ref/nosql_05_0102.html @@ -3,7 +3,7 @@

                    Editing the Name of an Instance

                    Function

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

                    -

                    Constraints

                    This API can be used for GeminiDB Cassandra instances.

                    +

                    Constraints

                    This API can be used for GeminiDB Cassandra and GeminiDB Influx 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

                    @@ -41,39 +41,39 @@

                    Request Parameters

                    -
                  Table 3 Request body parameters

                  Parameter

                  Mandatory

                  Table 2 Request header parameter

                  Parameter

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  Content-Type

                  +

                  Content-Type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  MIME type of the request body. application/json is recommended.

                  +

                  MIME type of the request body. application/json is recommended.

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  User token.

                  +

                  User token

                  -
                  Table 3 Request body parameter

                  Parameter

                  +
                  @@ -101,13 +101,13 @@

                  Response Parameters

                  Status code: 204

                  None

                  -

                  Example Request

                  • URI example
                    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name
                    +

                    Example Requests

                    • URI example
                      PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/name
                    • Changing the instance name to myNewName
                      {
                         "name" : "myNewName"
                       }
                    -

                    Example Response

                    None

                    +

                    Example Responses

                    None

                    Status Codes

                    See Status Codes.

                    diff --git a/docs/geminidb/api-ref/nosql_05_0103.html b/docs/geminidb/api-ref/nosql_05_0103.html index 24e7a8b7b..f87fb874e 100644 --- a/docs/geminidb/api-ref/nosql_05_0103.html +++ b/docs/geminidb/api-ref/nosql_05_0103.html @@ -3,7 +3,7 @@

                    Changing the Security Group of an Instance

                    Function

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

                    -

                    Constraints

                    This API can be used for GeminiDB Cassandra instances.

                    +

                    Constraints

                    This API can be used for GeminiDB Cassandra and GeminiDB Influx 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.

                    @@ -42,39 +42,39 @@

                    Request Parameters

                    -
                  Table 3 Request body parameters

                  Parameter

                  Mandatory

                  Table 2 Request header parameter

                  Parameter

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

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  Content-Type

                  +

                  Content-Type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  MIME type of the request body. application/json is recommended.

                  +

                  MIME type of the request body. application/json is recommended.

                  X-Auth-Token

                  +

                  X-Auth-Token

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  User token.

                  +

                  User token

                  -
                  Table 3 Request body parameter

                  Parameter

                  +
                  @@ -99,7 +99,7 @@

                  Response Parameters

                  Status code: 202

                  -
                  Table 3 Request body parameters

                  Parameter

                  Mandatory

                  Table 4 Response body parameter

                  Parameter

                  +
                  @@ -118,13 +118,13 @@
                  Table 4 Response body parameters

                  Parameter

                  Type

                  -

                  Example Request

                  • URI example
                    PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group
                    +

                    Example Requests

                    • URI example
                      PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/security-group
                    • Example request body
                      {
                         "security_group_id" : "73bed21a-708b-4985-b697-a96d0e0d2b39"
                       }
                    -

                    Example Response

                    Status code: 202

                    +

                    Example Responses

                    Status code: 202

                    No Content

                    {
                       "job_id" : "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
                    diff --git a/docs/geminidb/api-ref/nosql_05_0107.html b/docs/geminidb/api-ref/nosql_05_0107.html
                    new file mode 100644
                    index 000000000..68f43b315
                    --- /dev/null
                    +++ b/docs/geminidb/api-ref/nosql_05_0107.html
                    @@ -0,0 +1,149 @@
                    +
                    +
                    +

                    Enabling or Disabling SSL

                    +

                    Function

                    This API is used to enable or disable SSL.

                    +
                    +

                    Constraints

                    • This API supports the following types of instances:
                      • GeminiDB Cassandra
                      • GeminiDB Influx
                      +
                    • The instance will be restarted after SSL is enabled or disabled on it. Exercise caution when you enable or disable SSL.
                    +
                    +

                    URI

                    POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-option

                    + +
                    + + + + + + + + + + + + + + + + +
                    Table 1 URI parameters

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    project_id

                    +

                    Yes

                    +

                    String

                    +

                    Project ID of a user 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

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

                    MIME type of the request body. application/json is recommended.

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token

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

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    ssl_option

                    +

                    Yes

                    +

                    String

                    +

                    Whether SSL is enabled.

                    +
                    • on, indicating that SSL is enabled by default.
                    • off, indicating that SSL is not enabled by default.
                    +
                    +
                    +
                    +

                    Response Parameters

                    Status code: 202

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

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    job_id

                    +

                    String

                    +

                    Task ID.

                    +
                    +
                    +
                    +

                    Example Requests

                    • Enabling SSL
                      • URI example
                        POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 
                        +
                      • Enabling SSL
                        { 
                        +  "ssl_option" : "on" 
                        +}
                        +
                      +
                    • Disabling SSL
                      • URI example
                        POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option
                        +
                      • Disabling SSL
                        { 
                        +  "ssl_option" : "off" 
                        +}
                        +
                      +
                    +
                    +

                    Example Responses

                    Status code: 202

                    +

                    Accepted

                    +
                    { 
                    +  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
                    +}
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    +
                    +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_05_0108.html b/docs/geminidb/api-ref/nosql_05_0108.html new file mode 100644 index 000000000..fc980d031 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0108.html @@ -0,0 +1,117 @@ + + +

                    Restarting an Instance

                    +

                    Function

                    This API is used to restart an instance.

                    +
                    +

                    Constraints

                    • This API supports the following types of instances:
                      • GeminiDB Cassandra
                      • GeminiDB Influx
                      +
                    • If the instance status is not normal, the instance cannot be restarted.
                    +
                    +

                    URI

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

                    + +
                    + + + + + + + + + + + + + + + + +
                    Table 1 URI parameters

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    project_id

                    +

                    Yes

                    +

                    String

                    +

                    Project ID of a user 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

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

                    MIME type of the request body. application/json is recommended.

                    +

                    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
                      POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/restart 
                      +
                    • Example request body
                      { }
                      +
                    +
                    +

                    Example Responses

                    Status code: 202

                    +

                    Accepted

                    +
                    { 
                    +  "job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae" 
                    +}
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    +
                    +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_05_0109.html b/docs/geminidb/api-ref/nosql_05_0109.html index ed10b2e9e..c095ac437 100644 --- a/docs/geminidb/api-ref/nosql_05_0109.html +++ b/docs/geminidb/api-ref/nosql_05_0109.html @@ -31,32 +31,32 @@

                    Request Parameters

                    -
                    @@ -212,11 +214,11 @@
                    Table 2 Request header parameter

                    Parameter

                    +
                    - - - - - - - - - - - @@ -124,7 +124,6 @@ @@ -136,10 +135,8 @@ @@ -152,8 +149,6 @@ @@ -164,7 +159,7 @@

                    Response Parameters

                    Status code: 204

                    No response parameters

                    -

                    Example Request

                    • Enabling the autoscaling policy of storage space
                      • URI example
                        POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion 
                        +

                        Example Requests

                        • Enabling the autoscaling policy of storage space
                          • URI example
                            POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion 
                          • Enabling autoscaling for storage space (Set threshold to 90, step to 10, and size to 600.)
                            { 
                               "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], 
                               "policy" : { 
                            @@ -182,7 +177,7 @@
                             
                        -

                        Example Response

                        Status code: 204

                        +

                        Example Responses

                        Status code: 204

                        No Content

                        { }
                        diff --git a/docs/geminidb/api-ref/nosql_05_0110.html b/docs/geminidb/api-ref/nosql_05_0110.html new file mode 100644 index 000000000..ffa37daa3 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0110.html @@ -0,0 +1,131 @@ + + +

                        Checking Password Strength

                        +

                        Function

                        This API is used to check whether the password is weak.

                        +
                        +

                        URI

                        POST https://{Endpoint}/v3/{project_id}/weak-password-verification

                        + +
                    Table 2 Request header parameters

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    Content-Type

                    +

                    Content-Type

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    MIME type of the request body. application/json is recommended.

                    +

                    MIME type of the request body. application/json is recommended.

                    X-Auth-Token

                    +

                    X-Auth-Token

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    User token.

                    +

                    User token

                    Threshold for triggering autoscaling.

                    • GeminiDB Cassandra instance
                      • The value can be 80, 85, or 90.
                      • The default threshold is 90, indicating that autoscaling is enabled when the used storage space exceeds 90% of total storage space or the available storage space is less than 10 GB.
                      -
                    • GeminiDB Redis instance
                      • The value can be 60, 65, 70, 75, 80, 85, and 90.
                      • The default threshold is 80, indicating that autoscaling is enabled when the used storage space exceeds 80% of total storage space.

                    Autoscaling step (s%).

                    • GeminiDB Cassandra instance
                      • The value can be 10, 15, or 20, and the default value is 10.
                      • After autoscaling is enabled, storage space will increase by s% automatically.
                      -
                    • GeminiDB Redis instance
                      • The value can be 10, 15, or 20, and the default value is 20.
                      • When the storage usage is greater than 98%: If the total storage is less than 600 GB, the storage usage after autoscaling (used storage space/total storage space) will be less than 85%. If the total storage is greater than or equal to 600 GB, the system automatically scales up the storage space by over 90 GB.
                    NOTE:
                    • GeminiDB Cassandra instance
                      • If the autoscaling step is not a multiple of 10, round it up.
                      • The value after the decimal point is rounded. The minimum step is 100 GB by default.
                      -
                    • GeminiDB Redis instance
                      • The value after the decimal point is rounded. The minimum step is 1 GB by default.

                    Storage limit in GB that autoscaling can increase storage space to.

                    • GeminiDB Cassandra instance
                      • Storage upper limit ≥ Current storage + 100 GB
                      • The upper limit cannot exceed the maximum storage supported by the current specifications.
                      • The value cannot be specified during batch autoscaling. By default, the storage is scaled up to the maximum defined by your instance specifications.
                      -
                    • GeminiDB Redis instance
                      • Storage upper limit ≥ Current storage + 1 GB

                        The upper limit cannot exceed the maximum storage supported by the current specifications.

                        -
                      • The value cannot be specified during batch autoscaling. By default, the storage is scaled up to the maximum defined by your instance specifications.
                    + + + + + + + + + + + +
                    Table 1 URI parameter

                    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

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

                    MIME type of the request body. application/json is recommended.

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token

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

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    password

                    +

                    Yes

                    +

                    String

                    +

                    Database password.

                    +
                    +
                    +
                    +

                    Response Parameters

                    Status code: 200

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

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    weak

                    +

                    Boolean

                    +

                    Whether the password is a weak password.

                    +
                    • true: It is a weak password.
                    • false: It is not a weak password.
                    +
                    +
                    +
                    +

                    Example Requests

                    • URI example
                      POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/weak-password-verification
                      +
                    • Checking Password Strength
                      { 
                      +  "password" : "xxxx" 
                      +}
                      +
                    +
                    +

                    Example Responses

                    Status code: 200

                    +

                    Success

                    +
                    { 
                    +  "weak" : false 
                    +}
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    + +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_05_0113.html b/docs/geminidb/api-ref/nosql_05_0113.html new file mode 100644 index 000000000..6d7b40f8f --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0113.html @@ -0,0 +1,142 @@ + + +

                    Deleting the Node that Fails to Be Added

                    +

                    Function

                    This API is used to delete the node that fails to be added to an instance.

                    +
                    +

                    Constraints

                    This API supports the following types of instances:

                    +
                    • GeminiDB Cassandra
                    +
                    +

                    URI

                    DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-failed-nodes

                    + +
                    + + + + + + + + + + + + + + + + +
                    Table 1 URI 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, which can be obtained by calling the API described in Querying Instances and Details. If there are no instances available, call the API described in Creating an Instance to create one.

                    +
                    +
                    +
                    +

                    Request Parameters

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

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

                    MIME type of the request body. application/json is recommended.

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token

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

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    node_id

                    +

                    Yes

                    +

                    String

                    +

                    Node ID.

                    +
                    +
                    +
                    +

                    Response Parameters

                    Status code: 202

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

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    job_id

                    +

                    String

                    +

                    Task ID.

                    +
                    +
                    +
                    +

                    Example Requests

                    • URI example
                      DELETE https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/c865f921f3dd45198f209a607533a779in06/enlarge-failed-nodes
                      +
                    • Example request body
                      { 
                      +  "node_id" : "b60f00f19cd044fc8d7b52908978f629no06" 
                      +}
                      +
                    +
                    +

                    Example Responses

                    Status code: 202

                    +

                    Accepted

                    +
                    { 
                    +  "job_id" : "89638f5e-0780-497c-b3c0-4d0968383e19" 
                    +}
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    +
                    +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_05_0114.html b/docs/geminidb/api-ref/nosql_05_0114.html new file mode 100644 index 000000000..0ec5c6f5a --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0114.html @@ -0,0 +1,151 @@ + + +

                    Querying IP Addresses Required for Creating an Instance or Adding Nodes

                    +

                    Function

                    This API is used to query IP addresses required for creating an instance or adding nodes to an instance.

                    +
                    +

                    Constraints

                    This API supports the following instances:

                    +
                    • GeminiDB Cassandra
                    • GeminiDB Influx
                    +
                    +

                    URI

                    GET https://{Endpoint}/v3/{project_id}/ip-num-requirement

                    + +
                    + + + + + + + + + + + +
                    Table 1 URI 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

                    +

                    node_num

                    +

                    Yes

                    +

                    Integer

                    +

                    Nodes required for creating or scaling out an instance The maximum value is 200.

                    +

                    engine_name

                    +

                    No

                    +

                    String

                    +

                    DB engine type

                    +
                    • cassandra: GeminiDB Cassandra DB type
                    • influxdb: GeminiDB Influx DB type
                    +

                    instance_mode

                    +

                    No

                    +

                    String

                    +

                    Instance type. The value is case-sensitive. If no instance ID is transferred, this parameter is mandatory. The value can be:

                    +
                    • Cluster: GeminiDB Cassandra cluster instance
                    • CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage
                    +

                    instance_id

                    +

                    No

                    +

                    String

                    +

                    Instance ID, which can be obtained by calling the API described in Querying Instances and Details. If there are no instances available, call the API described in Creating an Instance to create one.

                    +
                    +
                    +
                    +

                    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

                    +

                    Number of IP addresses used.

                    +
                    +
                    +
                    +

                    Example Requests

                    • URI example
                      GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/ip-num-requirement?node_num=3&engine_name=cassandra&instance_mode=Cluster
                      +
                    • Example request body

                      None

                      +
                    +
                    +

                    Example Responses

                    Status code: 200

                    +

                    Success

                    +
                    { 
                    +  "count" : 3 
                    +}
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    +
                    +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_05_0116.html b/docs/geminidb/api-ref/nosql_05_0116.html new file mode 100644 index 000000000..7dada0a6e --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0116.html @@ -0,0 +1,143 @@ + + +

                    Scaling Storage Space of an Instance

                    +

                    Function

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

                    +
                    +

                    Constraints

                    This API supports the following instances:

                    +
                    • GeminiDB Cassandra
                    +

                    This API supports both yearly/monthly and pay-per-use instances.

                    +
                    +

                    URI

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

                    + +
                    + + + + + + + + + + + + + + + + +
                    Table 1 URI 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

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

                    MIME type of the request body. application/json is recommended.

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token

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

                    Parameter

                    +

                    Mandatory

                    +

                    Type

                    +

                    Description

                    +

                    size

                    +

                    Yes

                    +

                    Integer

                    +

                    Requested storage space, in GB. The value must be an integer. When you want to scale up storage space, the requested storage value must be greater than the current storage. To scale down storage, ensure the new storage space is at least 1.25 times more than the used space and rounded up. The maximum and minimum 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

                    • URI example
                      PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/volume
                      +
                    • Changing storage space of an instance to 550 GB
                      {
                      +  "size" : 550
                      +}
                      +
                    +
                    +

                    Example Responses

                    Status code: 202

                    +

                    Success

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

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    +
                    +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_05_0156.html b/docs/geminidb/api-ref/nosql_05_0156.html index bbc7121d8..b476a8264 100644 --- a/docs/geminidb/api-ref/nosql_05_0156.html +++ b/docs/geminidb/api-ref/nosql_05_0156.html @@ -3,7 +3,7 @@

                    Querying Changeable Specifications

                    Function

                    This API is used to query instance specifications that can be changed.

                    -

                    Constraints

                    This API can be used for GeminiDB Cassandra instances.

                    +

                    Constraints

                    This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

                    URI

                    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/available-flavors

                    @@ -180,6 +180,8 @@

                    String

                    Region status.

                    +
                    NOTE:

                    This parameter has been deprecated and does not take effect. Ignore and do not use it.

                    +
                    -

                    Example Request

                    • URI example
                      GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/094424666ef04f79a2dfbe9f5b8b31a5in06/available-flavors
                      +

                      Example Requests

                      • URI example
                        GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/094424666ef04f79a2dfbe9f5b8b31a5in06/available-flavors
                      • Example request body

                        None

                      -

                      Example Response

                      Status code: 200

                      +

                      Example Responses

                      Status code: 200

                      Success
                      { 
                         "instance_id" : "094424666ef04f79a2dfbe9f5b8b31a5in06", 
                         "instance_name" : "geminidb_instance_noreuse_0_ZKv2FSkxgoc3F8bGzsaxNg", 
                      diff --git a/docs/geminidb/api-ref/nosql_06_0002.html b/docs/geminidb/api-ref/nosql_06_0002.html
                      index 31e44d089..5e235ef7a 100644
                      --- a/docs/geminidb/api-ref/nosql_06_0002.html
                      +++ b/docs/geminidb/api-ref/nosql_06_0002.html
                      @@ -3,11 +3,11 @@
                       

                      Obtaining Parameter Templates

                      Function

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

                      -

                      Constraints

                      This API can be used for GeminiDB Cassandra instances.

                      +

                      Constraints

                      This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

                      URI

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

                      -
                      Table 1 URI parameter

                      Parameter

                      +
                      @@ -65,7 +65,7 @@

                      Request Parameters

                      -
                      Table 1 URI parameters

                      Parameter

                      Mandatory

                      Table 3 Request header parameter

                      Parameter

                      +
                      @@ -75,16 +75,7 @@ - - - - - - @@ -196,7 +187,7 @@
                      Table 3 Request header parameters

                      Parameter

                      Mandatory

                      Content-Type

                      -

                      Yes

                      -

                      String

                      -

                      MIME type of the request body. application/json is recommended.

                      -

                      X-Auth-Token

                      +

                      X-Auth-Token

                      Yes

                      String

                      Instance type. The value can be:

                      -

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

                      +
                      • Cluster: classic GeminiDB Cassandra or Influx cluster instance
                      • CloudNativeCluster: cloud native GeminiDB Cassandra, Influx, or Redis cluster instance
                      • EnhancedCluster: classic GeminiDB Influx cluster (performance-enhanced) instance
                      • All: Parameter templates of instance with all storage types are queried.

                      user_defined

                      @@ -211,11 +202,11 @@
                      -

                      Example Request

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

                      Example Requests

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

                      Example Response

                      Status code: 200

                      -

                      Successful request

                      +

                      Example Responses

                      Status code: 200

                      +

                      Success

                      {
                         "count" : 2,
                         "quota": 100,
                      diff --git a/docs/geminidb/api-ref/nosql_06_0003.html b/docs/geminidb/api-ref/nosql_06_0003.html
                      index 9764f3434..57a9108d1 100644
                      --- a/docs/geminidb/api-ref/nosql_06_0003.html
                      +++ b/docs/geminidb/api-ref/nosql_06_0003.html
                      @@ -3,13 +3,13 @@
                       

                      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 can be used for GeminiDB Cassandra instances.

                      +

                      Constraints

                      This API can be used for GeminiDB Cassandra and GeminiDB Influx 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 URI parameter

                      Parameter

                      +
                      @@ -33,32 +33,32 @@

                      Request Parameters

                      -
                      Table 1 URI parameters

                      Parameter

                      Mandatory

                      Table 2 Request header parameter

                      Parameter

                      +
                      - - - - - - - - - - - @@ -132,7 +132,7 @@ + + + + + @@ -151,7 +161,7 @@

                      Response Parameters

                      Status code: 200

                      -
                      Table 2 Request header parameters

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      Content-Type

                      +

                      Content-Type

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      MIME type of the request body. application/json is recommended.

                      +

                      MIME type of the request body. application/json is recommended.

                      X-Auth-Token

                      +

                      X-Auth-Token

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      User token.

                      +

                      User token

                      String

                      Database type. The value can be:

                      -

                      cassandra: GeminiDB Cassandra instance

                      +
                      • cassandra: GeminiDB Cassandra instance
                      • influxdb: GeminiDB Influx instance

                      version

                      @@ -142,7 +142,17 @@

                      String

                      Database version. The value can be:

                      -

                      3.11, indicating that GeminiDB Cassandra 3.11 is supported.

                      +
                      • 3.11: GeminiDB Cassandra instance 3.11
                      • 1.7: GeminiDB Influx instance 1.7
                      +

                      mode

                      +

                      No

                      +

                      String

                      +

                      Instance type.

                      +

                      This parameter is mandatory when you create a parameter template for a GeminiDB Influx instance. The value is CloudNativeCluster, indicating a GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage.

                      Table 5 Response body parameter

                      Parameter

                      +
                      @@ -213,6 +223,14 @@ + + + +
                      Table 5 Response body parameters

                      Parameter

                      Type

                      Parameter template description

                      mode

                      +

                      String

                      +

                      Instance type.

                      +

                      CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage

                      +

                      created

                      String

                      @@ -233,7 +251,7 @@
                      -

                      Example Request

                      • URI example
                        POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations
                        +

                        Example Requests

                        • URI example
                          POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations
                        • Creating a parameter template for GeminiDB Cassandra instances
                          {
                             "name" : "configuration_test",
                             "description" : "configuration_test",
                          @@ -247,20 +265,45 @@
                             }
                           }
                        -
                        -

                        Example Response

                        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"
                        +
                        • Creating a parameter template for GeminiDB Influx instances
                          {
                          +  "name" : "configuration_test2",
                          +  "description" : "configuration_test2",
                          +  "datastore" : {
                          +    "type" : "influxdb",
                          +    "mode":"CloudNativeCluster",
                          +    "version" : "1.8"
                             }
                           }
                          +
                        +
                        +

                        Example Responses

                        Status code: 200

                        +

                        Success

                        +
                        • Example response for a GeminiDB Cassandra instance:
                          {
                          +    "configuration": {
                          +        "id": "a2685db51a074b2893150f7d78731758pr06",
                          +        "name": "configuration_test23",
                          +        "description": "configuration_test",
                          +        "datastore_version_name": "3.11",
                          +        "datastore_name": "cassandra",
                          +        "mode": null,
                          +        "created": "2026-02-12T03:29:01+0000",
                          +        "updated": "2026-02-12T03:29:01+0000"
                          +    }
                          +}
                          +
                        +
                        • Example response for a GeminiDB Influx instance:
                          {
                          +    "configuration": {
                          +        "id": "e1b984b199d64c97a3c9a2e7d098da2apr13",
                          +        "name": "configuration_test",
                          +        "description": "configuration_test",
                          +        "datastore_version_name": "1.8",
                          +        "datastore_name": "influxdb",
                          +        "mode": "CloudNativeCluster",
                          +        "created": "2026-02-12T03:15:33+0000",
                          +        "updated": "2026-02-12T03:15:33+0000"
                          +    }
                          +}
                          +

                        Status Codes

                        See Status Codes.

                        diff --git a/docs/geminidb/api-ref/nosql_06_0004.html b/docs/geminidb/api-ref/nosql_06_0004.html index 8470c4ab6..a0ae77eba 100644 --- a/docs/geminidb/api-ref/nosql_06_0004.html +++ b/docs/geminidb/api-ref/nosql_06_0004.html @@ -3,8 +3,7 @@

                        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 can be used for GeminiDB Cassandra instances.

                        -

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

                        +

                        Constraints

                        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.

                        @@ -43,32 +42,32 @@

                        Request Parameters

                        -
                        Table 2 Request header parameter

                        Parameter

                        +
                        - - - - - - - - - - - @@ -119,7 +118,7 @@

                        Response Parameters

                        Status code: 200

                        None

                        -

                        Example Request

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

                          Example Requests

                          • URI example
                            PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06
                          • Modifying Parameters in a Parameter Template

                            At least one parameter in the request body must be specified. Otherwise, the request cannot be delivered.

                            {
                            @@ -131,7 +130,7 @@
                             }
                          -

                          Example Response

                          None

                          +

                          Example Responses

                          None

                          Status Codes

                          See Status Codes.

                          diff --git a/docs/geminidb/api-ref/nosql_06_0005.html b/docs/geminidb/api-ref/nosql_06_0005.html index bffc922b1..8c657d322 100644 --- a/docs/geminidb/api-ref/nosql_06_0005.html +++ b/docs/geminidb/api-ref/nosql_06_0005.html @@ -3,7 +3,7 @@

                          Applying a Parameter Template

                          Function

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

                          -

                          Constraints

                          This API can be used for GeminiDB Cassandra instances.

                          +

                          Constraints

                          This API can be used for GeminiDB Cassandra and GeminiDB Influx 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.1/{project_id}/configurations/{config_id}/apply

                          @@ -41,39 +41,39 @@

                          Request Parameters

                          -
                        Table 2 Request header parameters

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        Content-Type

                        +

                        Content-Type

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        MIME type of the request body. application/json is recommended.

                        +

                        MIME type of the request body. application/json is recommended.

                        X-Auth-Token

                        +

                        X-Auth-Token

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        User token.

                        +

                        User token

                        Table 2 Request header parameter

                        Parameter

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

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        Content-Type

                        +

                        Content-Type

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        MIME type of the request body. application/json is recommended.

                        +

                        MIME type of the request body. application/json is recommended.

                        X-Auth-Token

                        +

                        X-Auth-Token

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        User token.

                        +

                        User token

                        -
                        Table 3 Request body parameter

                        Parameter

                        +
                        @@ -125,13 +125,13 @@
                        Table 3 Request body parameters

                        Parameter

                        Mandatory

                        -

                        Example Request

                        • URI example
                          PUT https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply
                          +

                          Example Requests

                          • URI example
                            PUT https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply
                          • Applying a Parameter Template
                            {
                               "instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ]
                             }
                          -

                          Example Response

                          Status code: 202

                          +

                          Example Responses

                          Status code: 202

                          Success

                          {
                             "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
                          diff --git a/docs/geminidb/api-ref/nosql_06_0006.html b/docs/geminidb/api-ref/nosql_06_0006.html
                          index 2bd5b8cb6..75a11ad1d 100644
                          --- a/docs/geminidb/api-ref/nosql_06_0006.html
                          +++ b/docs/geminidb/api-ref/nosql_06_0006.html
                          @@ -3,7 +3,7 @@
                           

                          Modifying Parameters of a Specified Instance

                          Function

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

                          -

                          Constraints

                          This API can be used for GeminiDB Cassandra instances.

                          +

                          Constraints

                          This API can be used for GeminiDB Cassandra and GeminiDB Influx 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.

                          @@ -42,39 +42,39 @@

                          Request Parameters

                          -
                          Table 2 Request header parameter

                          Parameter

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

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          Content-Type

                          +

                          Content-Type

                          Yes

                          +

                          Yes

                          String

                          +

                          String

                          MIME type of the request body. application/json is recommended.

                          +

                          MIME type of the request body. application/json is recommended.

                          X-Auth-Token

                          +

                          X-Auth-Token

                          Yes

                          +

                          Yes

                          String

                          +

                          String

                          User token.

                          +

                          User token

                          -
                          Table 3 Request body parameter

                          Parameter

                          +
                          @@ -126,7 +126,7 @@
                          Table 3 Request body parameters

                          Parameter

                          Mandatory

                          -

                          Example Request

                          • URI example
                            PUT https://{Endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations
                            +

                            Example Requests

                            • URI example
                              PUT https://{Endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances/392850e624504e1490901d50b585a60din06/configurations
                            • Modifying Parameters of a Specified Instance
                              {
                                 "values" : {
                                   "request_timeout_in_ms" : "10000"
                              @@ -134,7 +134,7 @@
                               }
                            -

                            Example Response

                            Status code: 202

                            +

                            Example Responses

                            Status code: 202

                            Success

                            {
                               "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
                            diff --git a/docs/geminidb/api-ref/nosql_06_0007.html b/docs/geminidb/api-ref/nosql_06_0007.html
                            index 27d9a6e5a..914a8a52f 100644
                            --- a/docs/geminidb/api-ref/nosql_06_0007.html
                            +++ b/docs/geminidb/api-ref/nosql_06_0007.html
                            @@ -3,7 +3,7 @@
                             

                            Querying Instance Parameter Settings

                            Function

                            This API is used to query instance parameter settings.

                            -

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

                            URI

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

                            @@ -40,7 +40,7 @@

                            Request Parameters

                            -
                            Table 2 Request header parameter

                            Parameter

                            +
                            @@ -85,6 +85,7 @@
                            Table 2 Request header parameters

                            Parameter

                            Mandatory

                            String

                            Database name.

                            +
                            • cassandra: GeminiDB Cassandra instance
                            • influxdb: GeminiDB Influx instance

                            created

                            @@ -115,7 +116,8 @@

                            String

                            Instance type. The value can be:

                            -

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

                            +

                            Cluster: GeminiDB Cassandra cluster instance

                            +

                            CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage

                            configuration_parameters

                            @@ -192,10 +194,10 @@
                            -

                            Example Request

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

                            Example Requests

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

                            Example Response

                            Status code: 200

                            +

                            Example Responses

                            Status code: 200

                            Success

                            {
                               "datastore_version_name" : "3.11",
                            diff --git a/docs/geminidb/api-ref/nosql_06_0110.html b/docs/geminidb/api-ref/nosql_06_0110.html
                            new file mode 100644
                            index 000000000..d73169905
                            --- /dev/null
                            +++ b/docs/geminidb/api-ref/nosql_06_0110.html
                            @@ -0,0 +1,181 @@
                            +
                            +
                            +

                            Comparing Parameter Templates

                            +

                            Function

                            This API is used to compare two parameter templates.

                            +
                            +

                            Constraints

                            This API supports the following types of instances:

                            +
                            • GeminiDB Cassandra
                            • GeminiDB Influx
                            +

                            This API only compares parameter templates with one of the same node type and DB engine to learn about configurations of the current template.

                            +
                            +

                            URI

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

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

                            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

                            +

                            Content-Type

                            +

                            Yes

                            +

                            String

                            +

                            MIME type of the request body. application/json is recommended.

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            source_configuration_id

                            +

                            Yes

                            +

                            String

                            +

                            ID of the source parameter template to be compared.

                            +

                            target_configuration_id

                            +

                            Yes

                            +

                            String

                            +

                            ID of the destination parameter template for comparison.

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 202

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            differences

                            +

                            Array of Table 5 objects

                            +

                            Differences between parameters.

                            +
                            +
                            + +
                            + + + + + + + + + + + + + + + + + +
                            Table 5 DiffDetails

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            parameter_name

                            +

                            String

                            +

                            Parameter name.

                            +

                            source_value

                            +

                            String

                            +

                            Parameter value in the source parameter template.

                            +

                            target_value

                            +

                            String

                            +

                            Parameter value in the destination parameter template.

                            +
                            +
                            +
                            +

                            Example Requests

                            • URI example
                              POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/comparison
                              +
                            • Comparing a source parameter template with the target parameter template
                              { 
                              +  "source_configuration_id" : "0764fdcd949b411ba76c2b762b80c212pr06", 
                              +  "target_configuration_id" : "fa42c57bb62844e490052f2ff9d5a264pr06" 
                              +}
                              +
                            +
                            +

                            Example Responses

                            Status code: 202

                            +

                            Accepted

                            +
                            { 
                            +  "differences" : [ { 
                            +    "parameter_name" : "batch_size_fail_threshold_in_kb", 
                            +    "source_value" : "1000", 
                            +    "target_value" : "5000" 
                            +  } ] 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_06_0111.html b/docs/geminidb/api-ref/nosql_06_0111.html new file mode 100644 index 000000000..a08bcacbf --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0111.html @@ -0,0 +1,154 @@ + + +

                            Replicating a Parameter Template

                            +

                            Function

                            This API is used to replicate a parameter template.

                            +
                            +

                            Constraints

                            This API supports the following types of instances:

                            +
                            • GeminiDB Cassandra
                            • GeminiDB Influx
                            +

                            The parameter template generated after replication cannot have the same name as the default parameter template or an existing template.

                            +

                            Only custom parameter templates can be replicated.

                            +
                            +

                            URI

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

                            + +
                            + + + + + + + + + + + + + + + + +
                            Table 1 URI 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

                            +

                            Content-Type

                            +

                            Yes

                            +

                            String

                            +

                            MIME type of the request body. application/json is recommended.

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            name

                            +

                            Yes

                            +

                            String

                            +

                            Name of the parameter template generated after replication. The name 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. The description can contain a maximum of 256 characters except the following special characters: >!<"&'= The value is left blank by default.

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 202

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            config_id

                            +

                            String

                            +

                            ID of the replicated parameter template.

                            +
                            +
                            +
                            +

                            Example Requests

                            • URI example
                              POST https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/copy 
                              +
                            • Replicating a Parameter Template
                              {  
                              +  "name" : "paramsGroup-2434",  
                              +  "description" : "Replicating a parameter template"
                              +}
                              +
                            +
                            +

                            Example Responses

                            Status code: 202

                            +

                            Accepted

                            +
                            { 
                            +  "config_id" : "7b4e07852bd54016906e89461b3182cdpr06" 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_06_0112.html b/docs/geminidb/api-ref/nosql_06_0112.html new file mode 100644 index 000000000..d3412b9bd --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0112.html @@ -0,0 +1,138 @@ + + +

                            Querying Database Types That Support Parameter Templates

                            +

                            Function

                            This API is used to query database types that support parameter templates.

                            +
                            +

                            URI

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

                            + +
                            + + + + + + + + + + + +
                            Table 1 URI 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

                            +

                            datastores

                            +

                            Array of Table 4 objects

                            +

                            DB API information.

                            +
                            +
                            + +
                            + + + + + + + + + + + + + + + + + +
                            Table 4 DataStoreList

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            datastore_name

                            +

                            String

                            +

                            Database type

                            +

                            version

                            +

                            String

                            +

                            Database type version

                            +

                            mode

                            +

                            String

                            +

                            Instance type. The value can be:

                            +
                            • Cluster: GeminiDB Cassandra cluster instance
                            • CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance with cloud native storage
                            +
                            +
                            +
                            +

                            Example Requests

                            • URI example
                              GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/datastores
                              +
                            • Example request body

                              None

                              +
                            +
                            +

                            Example Responses

                            Status code: 200

                            +

                            Success

                            +
                            { 
                            +  "datastores" : [ { 
                            +    "datastore_name" : "influxdb", 
                            +    "mode": "CloudNativeCluster",
                            +    "version" : "1.7" 
                            +  }, { 
                            +    "datastore_name" : "cassandra", 
                            +    "mode": "Cluster",
                            +    "version" : "3.11" 
                            +  } ] 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_10_0003.html b/docs/geminidb/api-ref/nosql_10_0003.html new file mode 100644 index 000000000..d3eee0814 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_10_0003.html @@ -0,0 +1,329 @@ + + +

                            Querying Slow Query Logs of a GeminiDB Cassandra Instance

                            +

                            Function

                            This API is used to query slow query logs of GeminiDB Cassandra instances. Searching for slow query logs by keyword is supported.

                            +
                            +

                            Constraints

                            • Operators &&, ||, AND, OR, NOT, *, ?, :, >, <, =, >=, and <= cannot be used to search for logs.
                            • The query must be within the period specified by start_time and end_time.
                            • The value of line_num must be obtained from the log information returned for the last query. This parameter is optional for the first query.
                            • A maximum of 100 records can be queried on each page, and slow query logs can be stored for a maximum of 30 days.
                            +
                            +

                            URI

                            POST https://{Endpoint}/v3/{project_id}/cassandra/instances/{instance_id}/slow-logs

                            + +
                            + + + + + + + + + + + + + + + + +
                            Table 1 URI 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

                            +

                            Content-Type

                            +

                            Yes

                            +

                            String

                            +

                            MIME type of the request body. application/json is recommended.

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            start_time

                            +

                            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 cannot be 30 days earlier than the current time.

                            +

                            end_time

                            +

                            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. The end time cannot be later than the current time.

                            +

                            limit

                            +

                            Yes

                            +

                            Integer

                            +

                            Number of logs to be queried each time. The maximum value is 100.

                            +

                            line_num

                            +

                            No

                            +

                            String

                            +

                            Sequence number of a log event. This parameter is not required for the first query, but is required for the next query. The value can be obtained from the response of the last query. The current query starts from the next log of line_num, excluding the log of line_num.

                            +

                            operate_type

                            +

                            No

                            +

                            String

                            +

                            Statement type. If this parameter is left empty, all statement types are queried. The value can be select.

                            +

                            node_id

                            +

                            No

                            +

                            String

                            +

                            Node ID. If this parameter is left blank, all nodes in the instance can be queried. For details about the value, see field id in Table 10.

                            +

                            keywords

                            +

                            No

                            +

                            Array of strings

                            +

                            Full-text log search based on multiple keywords, indicating that all keywords are matched.

                            +
                            • A maximum of 10 keywords are supported.
                            • Each keyword can contain a maximum of 512 characters.
                            +

                            keyspace_keywords

                            +

                            No

                            +

                            Array of strings

                            +

                            Fuzzy search for logs based on multiple keyspace keywords, indicating that at least one keyword is matched.

                            +
                            • Only fuzzy search by keyword prefix is supported. A maximum of 10 keywords are supported.
                            • Each keyword can contain a maximum of 48 characters.
                            +

                            table_keywords

                            +

                            No

                            +

                            Array of strings

                            +

                            Fuzzy search for logs based on multiple database table name keywords, indicating that at least one keyword is matched.

                            +
                            • Only fuzzy search by keyword prefix is supported. A maximum of 10 keywords are supported.
                            • Each keyword can contain a maximum of 48 characters.
                            +

                            max_cost_time

                            +

                            No

                            +

                            Integer

                            +

                            Logs can be searched based on the maximum execution duration. Unit: ms

                            +

                            min_cost_time

                            +

                            No

                            +

                            Integer

                            +

                            Logs can be searched based on the minimum execution duration. Unit: ms

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 200

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            slow_logs

                            +

                            Array of objects

                            +

                            Slow log information. For details, see Table 5.

                            +
                            +
                            + +
                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                            Table 5 CassandraSlowLogDetail

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            node_name

                            +

                            String

                            +

                            Node name.

                            +

                            node_id

                            +

                            String

                            +

                            Node ID.

                            +

                            whole_message

                            +

                            String

                            +

                            Statement.

                            +

                            operate_type

                            +

                            String

                            +

                            Statement type.

                            +

                            cost_time

                            +

                            Integer

                            +

                            Execution time. Unit: ms

                            +

                            keyspace

                            +

                            String

                            +

                            Database keyspace.

                            +

                            table

                            +

                            String

                            +

                            Table name.

                            +

                            log_time

                            +

                            String

                            +

                            UTC time when a log is generated. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset.

                            +

                            line_num

                            +

                            String

                            +

                            Sequence number of a log event.

                            +
                            +
                            +
                            +

                            Example Requests

                            POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/cassandra/instances/853f97101a9a4f618202f281cda82e92in06/slow-logs 
                            + 
                            +{ 
                            +  "start_time" : "2023-01-06T10:41:14+0800", 
                            +  "end_time" : "2023-01-10T10:41:14+0800", 
                            +  "limit" : 100, 
                            +  "line_num" : "1595659490239433658", 
                            +  "operate_type" : "select", 
                            +  "node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no06", 
                            +  "keywords" : [ "log", "test" ], 
                            +  "keyspace_keywords" : [ "system", "system_auth" ], 
                            +  "table_keywords" : [ "test" ], 
                            +  "max_cost_time" : 100, 
                            +  "min_cost_time" : 50 
                            +}
                            +
                            +

                            Example Responses

                            Status code: 200

                            +

                            Success

                            +
                            { 
                            +  "slow_logs" : [ { 
                            +    "node_name" : "test_priam_node_1", 
                            +    "node_id" : "8b76c35e91eb4c9d82fe25417d750cb5no06", 
                            +    "keyspace" : "system", 
                            +    "table" : "test", 
                            +    "whole_message" : "GqKc6_S", 
                            +    "operate_type" : "select", 
                            +    "cost_time" : 60, 
                            +    "log_time" : "2023-01-09T05:42:32.000+0000", 
                            +    "line_num" : "1595659490239433659" 
                            +  } ] 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_10_0100.html b/docs/geminidb/api-ref/nosql_10_0100.html index 13ced0abd..71a124e81 100644 --- a/docs/geminidb/api-ref/nosql_10_0100.html +++ b/docs/geminidb/api-ref/nosql_10_0100.html @@ -110,23 +110,23 @@

                            Request Parameters

                            -
                            Table 3 Request header parameters

                            Parameter

                            +
                            - - - - - - - diff --git a/docs/geminidb/api-ref/nosql_10_0101.html b/docs/geminidb/api-ref/nosql_10_0101.html new file mode 100644 index 000000000..acdc5d90e --- /dev/null +++ b/docs/geminidb/api-ref/nosql_10_0101.html @@ -0,0 +1,108 @@ + + +

                            Querying the Maintenance Period of an Instance

                            +

                            Function

                            This function is used to query the maintenance period of an instance.

                            +
                            +

                            Constraints

                            This API supports the following types of instances:

                            +
                            • GeminiDB Influx
                            • GeminiDB Cassandra
                            +
                            +

                            URI

                            GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ops-window

                            + +
                            Table 3 Request header parameters

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            X-Auth-Token

                            +

                            X-Auth-Token

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            User token.

                            +

                            User token

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            project_id

                            +

                            Yes

                            +

                            String

                            +

                            Project ID of a user in a region

                            +

                            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 header parameter

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            maintenance_window

                            +

                            String

                            +

                            Maintenance time window of an instance

                            +
                            +
                            +
                            +

                            Example Requests

                            Query the maintenance period of an instance.

                            +
                            GET 
                            +https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein02/ops-window
                            +
                            +

                            Example Responses

                            Status code: 200

                            +

                            Success

                            +
                            { 
                            +  "maintenance_window" : "02:00-06:00" 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            + +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_10_0102.html b/docs/geminidb/api-ref/nosql_10_0102.html new file mode 100644 index 000000000..8553f96a8 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_10_0102.html @@ -0,0 +1,281 @@ + + +

                            Querying Scheduled Tasks

                            +

                            Function

                            This function is used to query scheduled tasks based on specified conditions.

                            +
                            +

                            Constraints

                            This API supports the following types of instances:

                            +
                            • GeminiDB Influx
                            • GeminiDB Cassandra
                            +
                            +

                            URI

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

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            project_id

                            +

                            Yes

                            +

                            String

                            +

                            Project ID of a user in a region

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            job_name

                            +

                            No

                            +

                            String

                            +

                            Task name. This parameter is left blank by default. The value can be:

                            +
                            • REBOOT: Restart the instance.
                            • RESIZE_FLAVOR: Change the CPU or memory of an instance.
                            • UPGRADE_DATABASE: patch upgrade
                            +

                            job_status

                            +

                            No

                            +

                            String

                            +

                            Task execution status. This parameter is left blank by default. The value can be:

                            +
                            • Pending: The task is not executed.
                            • Running: The task is being executed.
                            • Completed: The task has been successfully executed.
                            • Failed: The task fails to be executed.
                            • Canceled: The task is canceled.
                            +

                            instance_id

                            +

                            No

                            +

                            String

                            +

                            Instance ID. If this parameter is not specified, all instances that meet the search criteria are queried by default.

                            +

                            start_time

                            +

                            No

                            +

                            String

                            +

                            Task creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T indicates the start time, and Z indicates the time zone offset. For example, if the time zone offset is one hour, +0100 is displayed. If this parameter is not transferred, the time zone offset is seven days before the current time by default.

                            +

                            end_time

                            +

                            No

                            +

                            String

                            +

                            Task creation end time in the "yyyy-mm-ddThh:mm:ssZ" format. T indicates the start time, and Z indicates the time zone offset. For example, if the time zone offset is one hour, +0100 is displayed. If this parameter is not transferred, the current time is used by default.

                            +

                            offset

                            +

                            No

                            +

                            Integer

                            +

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

                            +

                            limit

                            +

                            No

                            +

                            Integer

                            +

                            Number of records to be queried. If this parameter is not transferred, the default value 10 is used. The value ranges from 1 to 100.

                            +
                            +
                            +
                            +

                            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.

                            +

                            schedules

                            +

                            Array of objects

                            +

                            Task details. For details, see Table 5.

                            +
                            +
                            + +
                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                            Table 5 ScheduleDetailInfo

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            job_id

                            +

                            String

                            +

                            Task ID

                            +

                            job_name

                            +

                            String

                            +

                            Task name. The value can be:

                            +
                            • REBOOT: Restart the instance.
                            • RESIZE_FLAVOR: Change the CPU or memory of an instance.
                            • UPGRADE_DATABASE: patch upgrade
                            +

                            job_status

                            +

                            String

                            +

                            Task execution status. The value can be: The value can be:

                            +
                            • Pending: The task is not executed.
                            • Running: The task is being executed.
                            • Completed: the task has been successfully executed.
                            • Failed: The task fails to be executed.
                            • Canceled: The task is canceled.
                            +

                            instance_id

                            +

                            String

                            +

                            Instance ID

                            +

                            instance_name

                            +

                            String

                            +

                            Instance name

                            +

                            instance_status

                            +

                            String

                            +

                            Instance status. The value can be:

                            +
                            • Createfail, indicating that the instance failed to be created.
                            • Creating, indicating that the instance is being created.
                            • Normal: The instance is normal.
                            • Abnormal: The instance is abnormal.
                            • Deleted: The instance has been deleted.
                            +

                            datastore_type

                            +

                            String

                            +

                            Database type

                            +

                            create_time

                            +

                            String

                            +

                            Task creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

                            +

                            start_time

                            +

                            String

                            +

                            Task start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

                            +

                            end_time

                            +

                            String

                            +

                            Task end time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

                            +
                            +
                            +
                            +

                            Example Requests

                            This function is used to query scheduled tasks based on specified conditions.

                            +
                            GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs?offset=2&limit=2&start_time=2019-05-27T03:38:51+0000&job_status=Pending
                            +
                            +

                            Example Responses

                            Status code: 200

                            +

                            Success

                            +
                            { 
                            +  "schedules" : [ { 
                            +    "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", 
                            +    "job_name" : "REBOOT", 
                            +    "job_status" : "Pending", 
                            +    "instance_id" : "8a6117ece8a0457a90060441fa372e8ein06", 
                            +    "instance_name" : "gauss-nosql", 
                            +    "instance_status" : "normal", 
                            +    "datastore_type" : "GeminiDB Cassandra", 
                            +    "create_time" : "2019-05-26T10:41:14+0000", 
                            +    "start_time" : "2019-05-26T12:41:14+0000", 
                            +    "end_time" : "2019-05-26T12:51:14+0000" 
                            +  } ], 
                            +  "total_count" : 1 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_10_0103.html b/docs/geminidb/api-ref/nosql_10_0103.html new file mode 100644 index 000000000..4153c35d7 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_10_0103.html @@ -0,0 +1,94 @@ + + +

                            Canceling a Scheduled Task

                            +

                            Function

                            This function is used to cancel a scheduled task based on the task ID.

                            +
                            +

                            Constraints

                            This API supports the following types of instances:

                            +
                            • GeminiDB Influx
                            • GeminiDB Cassandra
                            +
                            +

                            URI

                            DELETE https://{Endpoint}/v3/{project_id}/scheduled-jobs/{job_id}

                            + +
                            + + + + + + + + + + + + + + + + +
                            Table 1 URI parameters

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            project_id

                            +

                            Yes

                            +

                            String

                            +

                            Project ID of a user in a region

                            +

                            job_id

                            +

                            Yes

                            +

                            String

                            +

                            Task ID. The value is the same as the job_id field returned in the scheduled task list.

                            +
                            +
                            +
                            +

                            Request Parameters

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            Content-Type

                            +

                            Yes

                            +

                            String

                            +

                            MIME type of the request body. application/json is recommended.

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 204

                            +

                            None

                            +
                            +

                            Example Requests

                            Cancel a scheduled task.

                            +
                            DELETE https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs/56d3c1138dcf4f1da73b0170700c78d0
                            +
                            +

                            Example Responses

                            None

                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_12_0004.html b/docs/geminidb/api-ref/nosql_12_0004.html index 1679b7ef0..423c51966 100644 --- a/docs/geminidb/api-ref/nosql_12_0004.html +++ b/docs/geminidb/api-ref/nosql_12_0004.html @@ -22,6 +22,8 @@ + diff --git a/docs/geminidb/api-ref/nosql_12_0005.html b/docs/geminidb/api-ref/nosql_12_0005.html index b3ebf095d..f54d87c62 100644 --- a/docs/geminidb/api-ref/nosql_12_0005.html +++ b/docs/geminidb/api-ref/nosql_12_0005.html @@ -7,7 +7,7 @@

                            String

                            Database type. The value can be:

                            -
                            • cassandra
                            +
                            • cassandra
                            • influxdb

                            backup_id

                            @@ -334,12 +334,12 @@
                            -

                            Example Request

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

                              Example Requests

                              • URI example
                                GET https://{Endpoint}/v4/
                                 054b61972980d4552f0bc00ac8d3f5cd/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=2&limit=2&begin_time=2019-05-27T03:38:51+0000&end_time=2019-05-28T03:38:51+0000&type=DatabaseTable
                              • Example request body

                                None

                              -

                              Example Response

                              Status code: 200

                              +

                              Example Responses

                              Status code: 200

                              Success

                              { 
                                 "total_count" : 4, 
                              diff --git a/docs/geminidb/api-ref/nosql_api_0030.html b/docs/geminidb/api-ref/nosql_api_0030.html
                              index f64f217f6..34a454b91 100644
                              --- a/docs/geminidb/api-ref/nosql_api_0030.html
                              +++ b/docs/geminidb/api-ref/nosql_api_0030.html
                              @@ -64,7 +64,7 @@
                               

                              Request Parameters

                              -
                              Table 3 Request header parameter

                              Parameter

                              +
                              @@ -89,7 +89,7 @@

                              Response Parameters

                              Status code: 200

                              -
                              Table 3 Request header parameters

                              Parameter

                              Mandatory

                              Table 4 Response body parameter

                              Parameter

                              +
                              @@ -158,11 +158,11 @@
                              Table 4 Response body parameters

                              Parameter

                              Type

                              -

                              Example Request

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

                              Example Requests

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

                              Example Response

                              Status code: 200

                              -

                              Successful request

                              +

                              Example Responses

                              Status code: 200

                              +

                              Success

                              Response when an automated backup policy is enabled

                              {
                                 "backup_policy" : {
                              diff --git a/docs/geminidb/api-ref/nosql_api_0031.html b/docs/geminidb/api-ref/nosql_api_0031.html
                              index 132dcf38e..cf0b5b1a4 100644
                              --- a/docs/geminidb/api-ref/nosql_api_0031.html
                              +++ b/docs/geminidb/api-ref/nosql_api_0031.html
                              @@ -3,7 +3,7 @@
                               

                              Configuring an Automated Backup Policy

                              Function

                              This API is used to configuring an automated backup policy.

                              -

                              Constraints

                              This API can be used for GeminiDB Cassandra instances.

                              +

                              Constraints

                              This API can be used on GeminiDB Cassandra and GeminiDB Influx instances.

                              URI

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

                              @@ -40,39 +40,39 @@

                              Request Parameters

                              -
                              Table 2 Request header parameter

                              Parameter

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

                              Parameter

                              Mandatory

                              +

                              Mandatory

                              Type

                              +

                              Type

                              Description

                              +

                              Description

                              Content-Type

                              +

                              Content-Type

                              Yes

                              +

                              Yes

                              String

                              +

                              String

                              MIME type of the request body. application/json is recommended.

                              +

                              MIME type of the request body. application/json is recommended.

                              X-Auth-Token

                              +

                              X-Auth-Token

                              Yes

                              +

                              Yes

                              String

                              +

                              String

                              User token.

                              +

                              User token

                              -
                              Table 3 Request body parameter

                              Parameter

                              +
                              @@ -144,7 +144,7 @@

                              Response Parameters

                              Status code: 204

                              None

                              -

                              Example Request

                              • URI example
                                PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
                                +

                                Example Requests

                                • URI example
                                  PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy
                                • Example request body

                                  Enabling or modifying the automated backup policy (Set period to 1, 2, 3, 4, 5, and 6, start_time to 01:00-02:00, and keep_days to 7.)

                                  {
                                     "backup_policy" : {
                                  @@ -161,7 +161,7 @@
                                   }
                                -

                                Example Response

                                Status code: 204

                                +

                                Example Responses

                                Status code: 204

                                No Content

                                { }
                                diff --git a/docs/geminidb/api-ref/nosql_api_0032.html b/docs/geminidb/api-ref/nosql_api_0032.html index 546784ca3..ac00cee7e 100644 --- a/docs/geminidb/api-ref/nosql_api_0032.html +++ b/docs/geminidb/api-ref/nosql_api_0032.html @@ -3,8 +3,8 @@

                                Creating a Manual Backup

                                Function

                                This API is used to create a manual backup.

                                -

                                Constraints

                                This API supports the following instance type:

                                -
                                • GeminiDB Cassandra
                                +

                                Constraints

                                This API supports the following instances:

                                +
                                • GeminiDB Cassandra
                                • GeminiDB Influx

                                URI

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

                                @@ -41,32 +41,32 @@

                                Request Parameters

                                -
                              Table 3 Request body parameters

                              Parameter

                              Mandatory

                              @@ -41,7 +41,7 @@

                              Request Parameters

                              -
                              Table 2 Request header parameter

                              Parameter

                              +
                              - - - - - - - - - - - @@ -135,14 +135,14 @@
                              Table 2 Request header parameters

                              Parameter

                              Mandatory

                              +

                              Mandatory

                              Type

                              +

                              Type

                              Description

                              +

                              Description

                              Content-Type

                              +

                              Content-Type

                              Yes

                              +

                              Yes

                              String

                              +

                              String

                              MIME type of the request body. application/json is recommended.

                              +

                              MIME type of the request body. application/json is recommended.

                              X-Auth-Token

                              +

                              X-Auth-Token

                              Yes

                              +

                              Yes

                              String

                              +

                              String

                              User token.

                              +

                              User token

                              -

                              Example Request

                              • URI example
                                POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups 
                                +

                                Example Requests

                                • URI example
                                  POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups 
                                • Creating a manual backup
                                  { 
                                     "name" : "backup-4f57", 
                                     "description" : "manual backup" 
                                   }
                                -

                                Example Response

                                Status code: 202

                                +

                                Example Responses

                                Status code: 202

                                Success

                                { 
                                   "job_id" : "8061ceaf-b319-4315-9338-7f3de8e26f05", 
                                diff --git a/docs/geminidb/api-ref/nosql_api_0033.html b/docs/geminidb/api-ref/nosql_api_0033.html
                                new file mode 100644
                                index 000000000..c0a5d701b
                                --- /dev/null
                                +++ b/docs/geminidb/api-ref/nosql_api_0033.html
                                @@ -0,0 +1,117 @@
                                +
                                +
                                +

                                Querying the Recycling Policy

                                +

                                Function

                                This API is used to query the recycling policy.

                                +
                                +

                                URI

                                GET https://{Endpoint}/v3/{project_id}/instances/recycle-policy

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                project_id

                                +

                                Yes

                                +

                                String

                                +

                                Project ID of a user 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

                                +

                                recycle_policy

                                +

                                object

                                +

                                Recycling policy. For details, see Table 4.

                                +
                                +
                                + +
                                + + + + + + + + + +
                                Table 4 RecyclePolicy

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                retention_period_in_days

                                +

                                Integer

                                +

                                Policy retention duration (1 to 7 days). The value is a positive integer. The default value is 7.

                                +
                                +
                                +
                                +

                                Example Requests

                                • URI example
                                  GET https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/recycle-policy
                                  +
                                • Example request body

                                  None

                                  +
                                +
                                +

                                Example Responses

                                Status code: 200

                                +

                                Success

                                +
                                {
                                +  "recycle_policy": {
                                +    "retention_period_in_days": 7
                                +  }
                                +}
                                +
                                +

                                Status Codes

                                See Status Codes.

                                +
                                +

                                Error Codes

                                See Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/geminidb/api-ref/nosql_api_0034.html b/docs/geminidb/api-ref/nosql_api_0034.html new file mode 100644 index 000000000..75c026cb7 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_api_0034.html @@ -0,0 +1,135 @@ + + +

                                Modifying the Recycling Policy

                                +

                                Function

                                This API is used to change a retention period for deleted instances. The new retention period is available to only those instances deleted after the change, but not to the instances already moved to the recycle bin before the change.

                                +
                                +

                                Constraints

                                The retention period for deleted instances can be 1 to 7 days.

                                +
                                +

                                URI

                                PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy

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

                                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

                                +

                                Content-Type

                                +

                                Yes

                                +

                                String

                                +

                                MIME type of the request body. application/json is recommended.

                                +

                                X-Auth-Token

                                +

                                Yes

                                +

                                String

                                +

                                User token

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

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                recycle_policy

                                +

                                Yes

                                +

                                object

                                +

                                Recycling policy. For details, see Table 4.

                                +
                                +
                                + +
                                + + + + + + + + + + + +
                                Table 4 RecyclePolicy

                                Parameter

                                +

                                Mandatory

                                +

                                Type

                                +

                                Description

                                +

                                retention_period_in_days

                                +

                                No

                                +

                                Integer

                                +

                                Policy retention duration (1 to 7 days). The value is a positive integer. The default value is 7.

                                +
                                +
                                +
                                +

                                Response Parameters

                                Status code: 200

                                +

                                No response parameters

                                +
                                +

                                Example Requests

                                • URI example
                                  PUT https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy 
                                  +
                                • Setting the retention period of instances in the recycle bin to 3 days
                                  {
                                  +  "recycle_policy": {
                                  +    "retention_period_in_days": 3
                                  +  }
                                  +}
                                  +
                                +
                                +

                                Example Responses

                                None

                                +
                                +

                                Status Codes

                                See Status Codes.

                                +
                                +

                                Error Codes

                                See Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/geminidb/api-ref/nosql_api_0035.html b/docs/geminidb/api-ref/nosql_api_0035.html new file mode 100644 index 000000000..a7e17665e --- /dev/null +++ b/docs/geminidb/api-ref/nosql_api_0035.html @@ -0,0 +1,263 @@ + + +

                                Querying Instances in the Recycle Bin

                                +

                                Function

                                This API is used to query all instances in the recycle bin.

                                +
                                +

                                URI

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

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

                                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 query starts from the N+1 piece of data. The default value is 0, which indicates that the query starts from the first piece of data.
                                • The value must be a non-negative number.
                                +

                                limit

                                +

                                No

                                +

                                Integer

                                +

                                Maximum records to 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

                                +

                                total_count

                                +

                                Integer

                                +

                                Total number of records.

                                +

                                instances

                                +

                                Array of objects

                                +

                                Instance information. For details, see Table 5.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                                Table 5 RecycleInstance

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                id

                                +

                                String

                                +

                                Instance ID.

                                +

                                name

                                +

                                String

                                +

                                Instance name.

                                +

                                mode

                                +

                                String

                                +

                                Instance type. The value can be:

                                +
                                • Cluster: GeminiDB Cassandra cluster instance
                                • CloudNativeCluster: GeminiDB Influx cluster (performance-enhanced) instance
                                +

                                data_store

                                +

                                object

                                +

                                Database information For details, see Table 6.

                                +

                                charge_type

                                +

                                String

                                +

                                Billing mode.

                                +
                                • prePaid: indicates that the billing mode is yearly/monthly.
                                • postPaid: indicates that the billing mode is pay-per-use.
                                +

                                enterprise_project_id

                                +

                                String

                                +

                                Enterprise project ID. The value 0 indicates that the default enterprise project is used.

                                +

                                backup_id

                                +

                                String

                                +

                                Backup ID.

                                +

                                created_at

                                +

                                String

                                +

                                Instance creation time.

                                +

                                deleted_at

                                +

                                String

                                +

                                Instance deletion time.

                                +

                                retained_until

                                +

                                String

                                +

                                Retention end time.

                                +
                                +
                                + +
                                + + + + + + + + + + + + + +
                                Table 6 RecycleDatastore

                                Parameter

                                +

                                Type

                                +

                                Description

                                +

                                type

                                +

                                String

                                +

                                Database type.

                                +
                                • cassandra: GeminiDB Cassandra instance
                                • influxdb: GeminiDB Influx instance
                                +

                                version

                                +

                                String

                                +

                                Database version.

                                +
                                +
                                +
                                +

                                Example Requests

                                • URI example
                                  GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-instances?offset=0&limit=100
                                  +
                                • Example request body

                                  None

                                  +
                                +
                                +

                                Example Responses

                                Status code: 200

                                +

                                Successful request

                                +
                                { 
                                +  "total_count" : 1, 
                                +  "instances" : [ { 
                                +    "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", 
                                +    "name" : "test", 
                                +    "mode" : "Cluster", 
                                +    "data_store" : { 
                                +      "type" : "cassandra", 
                                +      "version" : "3.11" 
                                +    }, 
                                +    "charge_type" : "postPaid", 
                                +    "enterprise_project_id" : "0", 
                                +    "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", 
                                +    "created_at" : "2022-01-01T10:00:00", 
                                +    "deleted_at" : "2022-02-01T11:00:00", 
                                +    "retained_until" : "2022-02-02T11:00:00" 
                                +  } ] 
                                +}
                                +
                                +

                                Status Codes

                                See Status Codes.

                                +
                                +

                                Error Codes

                                See Error Codes.

                                +
                                +
                                +
                                + +
                                + diff --git a/docs/geminidb/api-ref/nosql_database_version.html b/docs/geminidb/api-ref/nosql_database_version.html index f6d49189c..000299d5b 100644 --- a/docs/geminidb/api-ref/nosql_database_version.html +++ b/docs/geminidb/api-ref/nosql_database_version.html @@ -3,7 +3,7 @@

                                Querying Version Information

                                Function

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

                                -

                                Constraints

                                This API can be used for GeminiDB Cassandra instances.

                                +

                                Constraints

                                This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

                                URI

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

                                @@ -33,7 +33,7 @@

                              String

                              Database type. The value can be:

                              -
                              • cassandra, indicating that the instances are of the GeminiDB Cassandra type.
                              +
                              • cassandra, indicating that the instances are of the GeminiDB Cassandra type.
                              • influxdb, indicating that the instances are of the GeminiDB Influx type.
                              Table 2 Request header parameter

                              Parameter

                              +
                              @@ -66,7 +66,7 @@

                              Response Parameters

                              Status code: 200

                              -
                              Table 2 Request header parameters

                              Parameter

                              Mandatory

                              Table 3 Response body parameter

                              Parameter

                              +
                              @@ -79,17 +79,17 @@
                              Table 3 Response body parameters

                              Parameter

                              Type

                              Array of strings

                              Database version. The supported versions are:

                              -
                              • GeminiDB Cassandra instance 3.11
                              +
                              • GeminiDB Cassandra instance 3.11
                              • GeminiDB Influx instance 1.7
                              -

                              Example Request

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

                              Example Requests

                              URI example
                              GET https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/datastores/cassandra/versions
                              -

                              Example Response

                              Status code: 200

                              +

                              Example Responses

                              Status code: 200

                              Success

                              {
                                 "versions" : [ "3.11" ]
                              diff --git a/docs/geminidb/api-ref/nosql_instance_specification.html b/docs/geminidb/api-ref/nosql_instance_specification.html
                              index a19a5cc86..81c4330c7 100644
                              --- a/docs/geminidb/api-ref/nosql_instance_specification.html
                              +++ b/docs/geminidb/api-ref/nosql_instance_specification.html
                              @@ -3,11 +3,11 @@
                               

                              Querying Instance Specifications

                              Function

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

                              -

                              Constraints

                              This API can be used for GeminiDB Cassandra instances.

                              +

                              Constraints

                              This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.

                              URI

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

                              -
                              Table 1 URI parameter

                              Parameter

                              +
                              @@ -47,7 +47,17 @@ + + + + +
                              Table 1 URI parameters

                              Parameter

                              Mandatory

                              String

                              Database type.

                              -
                              • cassandra: GeminiDB Cassandra instance specifications are queried.
                              • If this parameter is not transferred, the default value is cassandra.
                              +
                              • cassandra: GeminiDB Cassandra instance specifications are queried.
                              • influxdb: GeminiDB Influx instance specifications are queried.
                              • If this parameter is not transferred, the default value is cassandra.
                              +

                              mode

                              +

                              No

                              +

                              String

                              +

                              Instance type

                              +
                              • CloudNativeCluster: Specifications of instances with cloud native storage are queried.
                              • If this parameter is not transferred, the specifications of all instances with classic storage are queried.

                              offset

                              @@ -75,7 +85,7 @@

                              Request Parameters

                              -
                              Table 3 Request header parameter

                              Parameter

                              +
                              @@ -168,7 +178,7 @@ @@ -193,11 +203,11 @@
                              Table 3 Request header parameters

                              Parameter

                              Mandatory

                              Resource specification code.

                              Example: geminidb.cassandra.8xlarge.4

                              -
                              NOTE:
                              • geminidb.cassandra indicates the instance is a GeminiDB Cassandra instance.
                              • 8xlarge.4 indicates node specifications.
                              +
                              NOTE:
                              • geminidb.cassandra indicates the instance is a GeminiDB Cassandra instance.
                              -

                              Example Request

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

                              Example Requests

                              URI example
                              GET https://{Endpoint}/v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?engine_name=cassandra&offset=0&limit=10
                              -

                              Example Response

                              Status code: 200

                              -

                              Successful request

                              +

                              Example Responses

                              Status code: 200

                              +

                              Success

                              {
                                 "total_count" : 4,
                                 "flavors" : [ {
                              @@ -254,7 +264,7 @@
                               
                              diff --git a/docs/geminidb/api-ref/topic_300000002.html b/docs/geminidb/api-ref/topic_300000002.html index a6ba291f2..c8cf38637 100644 --- a/docs/geminidb/api-ref/topic_300000002.html +++ b/docs/geminidb/api-ref/topic_300000002.html @@ -26,10 +26,26 @@ + + + + + + + +