diff --git a/docs/geminidb/api-ref/ALL_META.TXT.json b/docs/geminidb/api-ref/ALL_META.TXT.json index b3cec7691..13d249cde 100644 --- a/docs/geminidb/api-ref/ALL_META.TXT.json +++ b/docs/geminidb/api-ref/ALL_META.TXT.json @@ -254,11 +254,243 @@ "title":"Quick Start", "githuburl":"" }, + { + "uri":"nosql_12_0012.html", + "node_id":"nosql_12_0012.xml", + "product_code":"", + "code":"13", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"", + "kw":"API v4", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"API v4", + "githuburl":"" + }, + { + "uri":"nosql_12_0013.html", + "node_id":"nosql_12_0013.xml", + "product_code":"nosql", + "code":"14", + "des":"This API is used to query backups based on specified conditions.GET https://{Endpoint}/v4/{project_id}/backupsStatus code: 200URI exampleGET https://{Endpoint}/v4/\n054b61", + "doc_type":"api", + "kw":"Querying Backups,API v4,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Backups", + "githuburl":"" + }, + { + "uri":"nosql_12_0005.html", + "node_id":"nosql_12_0005.xml", + "product_code":"", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"", + "kw":"APIs v3.1", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"APIs v3.1", + "githuburl":"" + }, + { + "uri":"nosql_12_0006.html", + "node_id":"nosql_12_0006.xml", + "product_code":"", + "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", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Versions and Specifications", + "githuburl":"" + }, + { + "uri":"nosql_instance_specification.html", + "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", + "doc_type":"api", + "kw":"Querying Instance Specifications,Versions and Specifications,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Instance Specifications", + "githuburl":"" + }, + { + "uri":"nosql_12_0007.html", + "node_id":"nosql_12_0007.xml", + "product_code":"", + "code":"18", + "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", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Backup and Restoration", + "githuburl":"" + }, + { + "uri":"nosql_05_0211.html", + "node_id":"nosql_05_0211.xml", + "product_code":"nosql", + "code":"19", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Backups (Recommended)", + "githuburl":"" + }, + { + "uri":"nosql_api_0030.html", + "node_id":"nosql_api_0030.xml", + "product_code":"nosql", + "code":"20", + "des":"This API is used to query an automated backup policy.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id", + "doc_type":"api", + "kw":"Querying an Automated Backup Policy,Backup and Restoration,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"nosql_12_0008.html", + "node_id":"nosql_12_0008.xml", + "product_code":"", + "code":"21", + "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":"Parameter Templates", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_06_0002.html", + "node_id":"nosql_06_0002.xml", + "product_code":"nosql", + "code":"22", + "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", + "doc_type":"api", + "kw":"Obtaining Parameter Templates,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Obtaining Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_06_0005.html", + "node_id":"nosql_06_0005.xml", + "product_code":"nosql", + "code":"23", + "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", + "doc_type":"api", + "kw":"Applying a Parameter Template,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Applying a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0006.html", + "node_id":"nosql_06_0006.xml", + "product_code":"nosql", + "code":"24", + "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", + "doc_type":"api", + "kw":"Modifying Parameters of a Specified Instance,Parameter Templates,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Modifying Parameters of a Specified Instance", + "githuburl":"" + }, { "uri":"nosql_12_0004.html", "node_id":"nosql_12_0004.xml", "product_code":"nosql", - "code":"13", + "code":"25", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"APIs v3", @@ -279,7 +511,7 @@ "uri":"topic_300000000.html", "node_id":"topic_300000000.xml", "product_code":"nosql", - "code":"14", + "code":"26", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"API Versions", @@ -300,7 +532,7 @@ "uri":"ListApiVersion.html", "node_id":"listapiversion.xml", "product_code":"nosql", - "code":"15", + "code":"27", "des":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ", "doc_type":"api", "kw":"Querying API Versions,API Versions,API Reference", @@ -321,7 +553,7 @@ "uri":"ShowApiVersion.html", "node_id":"showapiversion.xml", "product_code":"nosql", - "code":"16", + "code":"28", "des":"This API is used to query version information of a specified API.GET https://{Endpoint}/{versionId}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 20", "doc_type":"api", "kw":"Querying Version Information of an API,API Versions,API Reference", @@ -342,7 +574,7 @@ "uri":"topic_300000001.html", "node_id":"topic_300000001.xml", "product_code":"nosql", - "code":"17", + "code":"29", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Versions and Specifications", @@ -363,8 +595,8 @@ "uri":"nosql_database_version.html", "node_id":"nosql_database_version.xml", "product_code":"nosql", - "code":"18", - "des":"This API is used to query version information of a specified type of instances.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/datas", + "code":"30", + "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", "doc_type":"api", "kw":"Querying Version Information,Versions and Specifications,API Reference", "search_title":"", @@ -380,32 +612,11 @@ "title":"Querying Version Information", "githuburl":"" }, - { - "uri":"nosql_instance_specification.html", - "node_id":"nosql_instance_specification.xml", - "product_code":"nosql", - "code":"19", - "des":"This API is used to query all instance specifications under a specified condition.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{project_id}/", - "doc_type":"api", - "kw":"Querying Instance Specifications,Versions and Specifications,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "IsBot":"No;Yes", - "IsMulti":"No;Yes", - "prodname":"nosql", - "opensource":"true" - } - ], - "title":"Querying Instance Specifications", - "githuburl":"" - }, { "uri":"topic_300000002.html", "node_id":"topic_300000002.xml", "product_code":"nosql", - "code":"20", + "code":"31", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Instances", @@ -426,8 +637,8 @@ "uri":"nosql_05_0014.html", "node_id":"nosql_05_0014.xml", "product_code":"nosql", - "code":"21", - "des":"This API can be used to create an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instancesStatus code: 202URI examplePOST", + "code":"32", + "des":"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 gre", "doc_type":"api", "kw":"Creating an Instance,Instances,API Reference", "search_title":"", @@ -447,7 +658,7 @@ "uri":"nosql_05_0015.html", "node_id":"nosql_05_0015.xml", "product_code":"nosql", - "code":"22", + "code":"33", "des":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This", "doc_type":"api", "kw":"Deleting an Instance,Instances,API Reference", @@ -468,8 +679,8 @@ "uri":"nosql_05_0016.html", "node_id":"nosql_05_0016.xml", "product_code":"nosql", - "code":"23", - "des":"This API is used to query instances and details based on specified conditions.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instan", + "code":"34", + "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}", "doc_type":"api", "kw":"Querying Instances and Details,Instances,API Reference", "search_title":"", @@ -489,8 +700,8 @@ "uri":"nosql_05_0050.html", "node_id":"nosql_05_0050.xml", "product_code":"nosql", - "code":"24", - "des":"This API is used to scale up storage space of an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/e", + "code":"35", + "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", "doc_type":"api", "kw":"Scaling Up Storage Space of an Instance,Instances,API Reference", "search_title":"", @@ -510,7 +721,7 @@ "uri":"nosql_05_0051.html", "node_id":"nosql_05_0051.xml", "product_code":"nosql", - "code":"25", + "code":"36", "des":"This API is used to add nodes for a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enla", "doc_type":"api", "kw":"Adding Nodes for an Instance,Instances,API Reference", @@ -531,7 +742,7 @@ "uri":"nosql_05_0052.html", "node_id":"nosql_05_0052.xml", "product_code":"nosql", - "code":"26", + "code":"37", "des":"This API is used to delete nodes from a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/", "doc_type":"api", "kw":"Deleting Nodes from a Specified Instance,Instances,API Reference", @@ -548,11 +759,32 @@ "title":"Deleting Nodes from a Specified Instance", "githuburl":"" }, + { + "uri":"nosql_05_0156.html", + "node_id":"nosql_05_0156.xml", + "product_code":"nosql", + "code":"38", + "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", + "doc_type":"api", + "kw":"Querying Changeable Specifications,Instances,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying Changeable Specifications", + "githuburl":"" + }, { "uri":"nosql_05_0100.html", "node_id":"nosql_05_0100.xml", "product_code":"nosql", - "code":"27", + "code":"39", "des":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ", "doc_type":"api", "kw":"Changing Specifications of an Instance,Instances,API Reference", @@ -573,8 +805,8 @@ "uri":"nosql_05_0101.html", "node_id":"nosql_05_0101.xml", "product_code":"nosql", - "code":"28", - "des":"This API is used to reset the administrator password of an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.Only t", + "code":"40", + "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", "doc_type":"api", "kw":"Resetting the Administrator Password of an Instance,Instances,API Reference", "search_title":"", @@ -594,8 +826,8 @@ "uri":"nosql_05_0102.html", "node_id":"nosql_05_0102.xml", "product_code":"nosql", - "code":"29", - "des":"This API is used to edit the name of an instance.This API supports GeminiDB Cassandra instances.The name of the instance that is being created or fails to be created cann", + "code":"41", + "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", "doc_type":"api", "kw":"Editing the Name of an Instance,Instances,API Reference", "search_title":"", @@ -615,8 +847,8 @@ "uri":"nosql_05_0103.html", "node_id":"nosql_05_0103.xml", "product_code":"nosql", - "code":"30", - "des":"This API is used to change the security group associated with an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.", + "code":"42", + "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", "doc_type":"api", "kw":"Changing the Security Group of an Instance,Instances,API Reference", "search_title":"", @@ -636,7 +868,7 @@ "uri":"nosql_05_0109.html", "node_id":"nosql_05_0109.xml", "product_code":"nosql", - "code":"31", + "code":"43", "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", @@ -657,7 +889,7 @@ "uri":"nosql_05_0115.html", "node_id":"nosql_05_0115.xml", "product_code":"nosql", - "code":"32", + "code":"44", "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", @@ -678,7 +910,7 @@ "uri":"topic_300000003.html", "node_id":"topic_300000003.xml", "product_code":"nosql", - "code":"33", + "code":"45", "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", @@ -695,33 +927,12 @@ "title":"Backups and Restorations", "githuburl":"" }, - { - "uri":"nosql_api_0030.html", - "node_id":"nosql_api_0030.xml", - "product_code":"nosql", - "code":"34", - "des":"This API is used to query an automated backup policy.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups", - "doc_type":"api", - "kw":"Querying an Automated Backup Policy,Backups and Restorations,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "IsBot":"No;Yes", - "IsMulti":"No;Yes", - "prodname":"nosql", - "opensource":"true" - } - ], - "title":"Querying an Automated Backup Policy", - "githuburl":"" - }, { "uri":"nosql_api_0031.html", "node_id":"nosql_api_0031.xml", "product_code":"nosql", - "code":"35", - "des":"This API is used to configuring an automated backup policy.This API supports GeminiDB Cassandra instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/b", + "code":"46", + "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", "doc_type":"api", "kw":"Configuring an Automated Backup Policy,Backups and Restorations,API Reference", "search_title":"", @@ -737,11 +948,53 @@ "title":"Configuring an Automated Backup Policy", "githuburl":"" }, + { + "uri":"ListRestoreTime.html", + "node_id":"listrestoretime.xml", + "product_code":"nosql", + "code":"47", + "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", + "doc_type":"api", + "kw":"Querying the Time Window When a Backup Can Be Restored,Backups and Restorations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying the Time Window When a Backup Can Be Restored", + "githuburl":"" + }, + { + "uri":"nosql_api_0032.html", + "node_id":"nosql_api_0032.xml", + "product_code":"nosql", + "code":"48", + "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}", + "doc_type":"api", + "kw":"Creating a Manual Backup,Backups and Restorations,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Creating a Manual Backup", + "githuburl":"" + }, { "uri":"topic_300000004.html", "node_id":"topic_300000004.xml", "product_code":"nosql", - "code":"36", + "code":"49", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Parameter Templates", @@ -758,33 +1011,12 @@ "title":"Parameter Templates", "githuburl":"" }, - { - "uri":"nosql_06_0002.html", - "node_id":"nosql_06_0002.xml", - "product_code":"nosql", - "code":"37", - "des":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API supports GeminiDB Cassandra instances.GET https://{En", - "doc_type":"api", - "kw":"Obtaining Parameter Templates,Parameter Templates,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "IsBot":"No;Yes", - "IsMulti":"No;Yes", - "prodname":"nosql", - "opensource":"true" - } - ], - "title":"Obtaining Parameter Templates", - "githuburl":"" - }, { "uri":"nosql_06_0003.html", "node_id":"nosql_06_0003.xml", "product_code":"nosql", - "code":"38", - "des":"This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.This API supports G", + "code":"50", + "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", "search_title":"", @@ -804,8 +1036,8 @@ "uri":"nosql_06_0004.html", "node_id":"nosql_06_0004.xml", "product_code":"nosql", - "code":"39", - "des":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API supports GeminiDB Cassandra instance", + "code":"51", + "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", "doc_type":"api", "kw":"Modifying Parameters in a Parameter Template,Parameter Templates,API Reference", "search_title":"", @@ -821,54 +1053,12 @@ "title":"Modifying Parameters in a Parameter Template", "githuburl":"" }, - { - "uri":"nosql_06_0005.html", - "node_id":"nosql_06_0005.xml", - "product_code":"nosql", - "code":"40", - "des":"This API is used to apply a parameter template to one or more instances.This API supports GeminiDB Cassandra instances.This API is an asynchronous API. A successful respo", - "doc_type":"api", - "kw":"Applying a Parameter Template,Parameter Templates,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "IsBot":"No;Yes", - "IsMulti":"No;Yes", - "prodname":"nosql", - "opensource":"true" - } - ], - "title":"Applying a Parameter Template", - "githuburl":"" - }, - { - "uri":"nosql_06_0006.html", - "node_id":"nosql_06_0006.xml", - "product_code":"nosql", - "code":"41", - "des":"This API is used to modify parameters of a specified instance.This API supports GeminiDB Cassandra instances.For configuration item values, you can enter system-defined p", - "doc_type":"api", - "kw":"Modifying Parameters of a Specified Instance,Parameter Templates,API Reference", - "search_title":"", - "metedata":[ - { - "documenttype":"api", - "IsBot":"No;Yes", - "IsMulti":"No;Yes", - "prodname":"nosql", - "opensource":"true" - } - ], - "title":"Modifying Parameters of a Specified Instance", - "githuburl":"" - }, { "uri":"nosql_06_0007.html", "node_id":"nosql_06_0007.xml", "product_code":"nosql", - "code":"42", - "des":"This API is used to query instance parameter settings.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/config", + "code":"52", + "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}", "doc_type":"api", "kw":"Querying Instance Parameter Settings,Parameter Templates,API Reference", "search_title":"", @@ -888,8 +1078,8 @@ "uri":"nosql_06_0008.html", "node_id":"nosql_06_0008.xml", "product_code":"nosql", - "code":"43", - "des":"This API is used to obtain information about parameters of a specified parameter template.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{projec", + "code":"53", + "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", "search_title":"", @@ -909,8 +1099,8 @@ "uri":"nosql_06_0009.html", "node_id":"nosql_06_0009.xml", "product_code":"nosql", - "code":"44", - "des":"This API is used to delete a specified parameter template.This API supports GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_", + "code":"54", + "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", "search_title":"", @@ -930,7 +1120,7 @@ "uri":"topic_300000005.html", "node_id":"topic_300000005.xml", "product_code":"nosql", - "code":"45", + "code":"55", "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", @@ -951,8 +1141,8 @@ "uri":"ListInstancesByResourceTags.html", "node_id":"listinstancesbyresourcetags.xml", "product_code":"nosql", - "code":"46", - "des":"This API is used to query a specified instance by tag.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must ", + "code":"56", + "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", "doc_type":"api", "kw":"Querying an Instance by Tag,Tags,API Reference", "search_title":"", @@ -972,8 +1162,8 @@ "uri":"BatchTagAction.html", "node_id":"batchtagaction.xml", "product_code":"nosql", - "code":"47", - "des":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to", + "code":"57", + "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", "doc_type":"api", "kw":"Adding or Deleting Resource Tags in Batches,Tags,API Reference", "search_title":"", @@ -993,8 +1183,8 @@ "uri":"ListInstanceTags.html", "node_id":"listinstancetags.xml", "product_code":"nosql", - "code":"48", - "des":"This API is used to query tags of a specified instance.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must", + "code":"58", + "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", "doc_type":"api", "kw":"Querying Tags of an Instance,Tags,API Reference", "search_title":"", @@ -1014,7 +1204,7 @@ "uri":"topic_300000006.html", "node_id":"topic_300000006.xml", "product_code":"nosql", - "code":"49", + "code":"59", "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", @@ -1035,7 +1225,7 @@ "uri":"ListSlowLogs.html", "node_id":"listslowlogs.xml", "product_code":"nosql", - "code":"50", + "code":"60", "des":"This API is used to query the latest 2,000 slow query logs of an instance. Searching by keyword is not supported.This API supports GeminiDB Cassandra instances.This API c", "doc_type":"api", "kw":"Querying Database Slow Logs,Logs,API Reference", @@ -1056,7 +1246,7 @@ "uri":"topic_300000007.html", "node_id":"topic_300000007.xml", "product_code":"nosql", - "code":"51", + "code":"61", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Quotas", @@ -1077,7 +1267,7 @@ "uri":"ShowQuotas.html", "node_id":"showquotas.xml", "product_code":"nosql", - "code":"52", + "code":"62", "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", @@ -1098,7 +1288,7 @@ "uri":"topic_300000016.html", "node_id":"topic_300000016.xml", "product_code":"", - "code":"53", + "code":"63", "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", @@ -1115,7 +1305,7 @@ "uri":"nosql_10_0100.html", "node_id":"nosql_10_0100.xml", "product_code":"", - "code":"54", + "code":"64", "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", @@ -1128,11 +1318,133 @@ "title":"Querying Tasks and Details", "githuburl":"" }, + { + "uri":"nosql_05_0203.html", + "node_id":"nosql_05_0203.xml", + "product_code":"nosql", + "code":"65", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Historical APIs", + "githuburl":"" + }, + { + "uri":"nosql_06_3001.html", + "node_id":"nosql_06_3001.xml", + "product_code":"", + "code":"66", + "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", + "search_title":"", + "metedata":[ + { + + } + ], + "title":"Backup and Restoration", + "githuburl":"" + }, + { + "uri":"nosql_06_3002.html", + "node_id":"nosql_06_3002.xml", + "product_code":"nosql", + "code":"67", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying an Automated Backup Policy", + "githuburl":"" + }, + { + "uri":"nosql_05_0205.html", + "node_id":"nosql_05_0205.xml", + "product_code":"nosql", + "code":"68", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Parameter Templates", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Parameter Templates", + "githuburl":"" + }, + { + "uri":"nosql_06_0218.html", + "node_id":"nosql_06_0218.xml", + "product_code":"nosql", + "code":"69", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Applying a Parameter Template", + "githuburl":"" + }, + { + "uri":"nosql_06_0219.html", + "node_id":"nosql_06_0219.xml", + "product_code":"nosql", + "code":"70", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Modifying Parameters of a Specified Instance", + "githuburl":"" + }, { "uri":"nosql_public_parameters.html", "node_id":"nosql_public_parameters.xml", "product_code":"nosql", - "code":"55", + "code":"71", "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", @@ -1153,7 +1465,7 @@ "uri":"nosql_abnormal_result.html", "node_id":"nosql_abnormal_result.xml", "product_code":"nosql", - "code":"56", + "code":"72", "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", @@ -1174,7 +1486,7 @@ "uri":"nosql_status_code.html", "node_id":"nosql_status_code.xml", "product_code":"nosql", - "code":"57", + "code":"73", "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", @@ -1195,7 +1507,7 @@ "uri":"nosql_error_code.html", "node_id":"nosql_error_code.xml", "product_code":"nosql", - "code":"58", + "code":"74", "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", @@ -1216,7 +1528,7 @@ "uri":"nosql_projectid.html", "node_id":"nosql_projectid.xml", "product_code":"nosql", - "code":"59", + "code":"75", "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", @@ -1237,7 +1549,7 @@ "uri":"nosql_metrics.html", "node_id":"nosql_metrics.xml", "product_code":"nosql", - "code":"60", + "code":"76", "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", @@ -1258,7 +1570,7 @@ "uri":"nosql_08_0001.html", "node_id":"nosql_08_0001.xml", "product_code":"nosql", - "code":"61", + "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":"Events Supported by Event Monitoring,Appendixes,API Reference", @@ -1279,7 +1591,7 @@ "uri":"nosql_change_history02.html", "node_id":"nosql_change_history02.xml", "product_code":"nosql", - "code":"62", + "code":"78", "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 0bcf6cf65..81a9497ef 100644 --- a/docs/geminidb/api-ref/BatchTagAction.html +++ b/docs/geminidb/api-ref/BatchTagAction.html @@ -3,7 +3,7 @@

Adding or Deleting Resource Tags in Batches

Function

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

-

Constraints

This API supports GeminiDB Cassandra instances.

+

Constraints

This API can be used for GeminiDB Cassandra instances.

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

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

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

@@ -11,7 +11,7 @@

URI

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

-
Table 1 Path parameters

Parameter

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

Request Parameters

-
Table 1 URI parameters

Parameter

Mandatory

Table 2 Request header parameters

Parameter

+
- - - - - - - + + + + + @@ -138,9 +147,9 @@

Response Parameters

Status code: 200

-

No response parameters

+

None

-

Example Requests

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

    Example Request

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

    Example Responses

    Status code: 200

    +

    Example Response

    Status code: 200

    Success

    { }
    -

    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/CLASS.TXT.json b/docs/geminidb/api-ref/CLASS.TXT.json index 718a2f3a2..d5311e8bb 100644 --- a/docs/geminidb/api-ref/CLASS.TXT.json +++ b/docs/geminidb/api-ref/CLASS.TXT.json @@ -107,6 +107,114 @@ "p_code":"", "code":"12" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"", + "title":"API v4", + "uri":"nosql_12_0012.html", + "doc_type":"", + "p_code":"", + "code":"13" + }, + { + "desc":"This API is used to query backups based on specified conditions.GET https://{Endpoint}/v4/{project_id}/backupsStatus code: 200URI exampleGET https://{Endpoint}/v4/\n054b61", + "product_code":"nosql", + "title":"Querying Backups", + "uri":"nosql_12_0013.html", + "doc_type":"api", + "p_code":"13", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"", + "title":"APIs v3.1", + "uri":"nosql_12_0005.html", + "doc_type":"", + "p_code":"", + "code":"15" + }, + { + "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", + "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", + "product_code":"nosql", + "title":"Querying Instance Specifications", + "uri":"nosql_instance_specification.html", + "doc_type":"api", + "p_code":"16", + "code":"17" + }, + { + "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":"Backup and Restoration", + "uri":"nosql_12_0007.html", + "doc_type":"", + "p_code":"15", + "code":"18" + }, + { + "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", + "product_code":"nosql", + "title":"Querying Backups (Recommended)", + "uri":"nosql_05_0211.html", + "doc_type":"api", + "p_code":"18", + "code":"19" + }, + { + "desc":"This API is used to query an automated backup policy.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id", + "product_code":"nosql", + "title":"Querying an Automated Backup Policy", + "uri":"nosql_api_0030.html", + "doc_type":"api", + "p_code":"18", + "code":"20" + }, + { + "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":"Parameter Templates", + "uri":"nosql_12_0008.html", + "doc_type":"", + "p_code":"15", + "code":"21" + }, + { + "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", + "product_code":"nosql", + "title":"Obtaining Parameter Templates", + "uri":"nosql_06_0002.html", + "doc_type":"api", + "p_code":"21", + "code":"22" + }, + { + "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", + "product_code":"nosql", + "title":"Applying a Parameter Template", + "uri":"nosql_06_0005.html", + "doc_type":"api", + "p_code":"21", + "code":"23" + }, + { + "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", + "product_code":"nosql", + "title":"Modifying Parameters of a Specified Instance", + "uri":"nosql_06_0006.html", + "doc_type":"api", + "p_code":"21", + "code":"24" + }, { "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", @@ -114,7 +222,7 @@ "uri":"nosql_12_0004.html", "doc_type":"api", "p_code":"", - "code":"13" + "code":"25" }, { "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.", @@ -122,8 +230,8 @@ "title":"API Versions", "uri":"topic_300000000.html", "doc_type":"api", - "p_code":"13", - "code":"14" + "p_code":"25", + "code":"26" }, { "desc":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ", @@ -131,8 +239,8 @@ "title":"Querying API Versions", "uri":"ListApiVersion.html", "doc_type":"api", - "p_code":"14", - "code":"15" + "p_code":"26", + "code":"27" }, { "desc":"This API is used to query version information of a specified API.GET https://{Endpoint}/{versionId}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 20", @@ -140,8 +248,8 @@ "title":"Querying Version Information of an API", "uri":"ShowApiVersion.html", "doc_type":"api", - "p_code":"14", - "code":"16" + "p_code":"26", + "code":"28" }, { "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.", @@ -149,26 +257,17 @@ "title":"Versions and Specifications", "uri":"topic_300000001.html", "doc_type":"api", - "p_code":"13", - "code":"17" + "p_code":"25", + "code":"29" }, { - "desc":"This API is used to query version information of a specified type of instances.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/datas", + "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", "product_code":"nosql", "title":"Querying Version Information", "uri":"nosql_database_version.html", "doc_type":"api", - "p_code":"17", - "code":"18" - }, - { - "desc":"This API is used to query all instance specifications under a specified condition.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3.1/{project_id}/", - "product_code":"nosql", - "title":"Querying Instance Specifications", - "uri":"nosql_instance_specification.html", - "doc_type":"api", - "p_code":"17", - "code":"19" + "p_code":"29", + "code":"30" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -176,17 +275,17 @@ "title":"Instances", "uri":"topic_300000002.html", "doc_type":"api", - "p_code":"13", - "code":"20" + "p_code":"25", + "code":"31" }, { - "desc":"This API can be used to create an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instancesStatus code: 202URI examplePOST", + "desc":"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 gre", "product_code":"nosql", "title":"Creating an Instance", "uri":"nosql_05_0014.html", "doc_type":"api", - "p_code":"20", - "code":"21" + "p_code":"31", + "code":"32" }, { "desc":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This", @@ -194,26 +293,26 @@ "title":"Deleting an Instance", "uri":"nosql_05_0015.html", "doc_type":"api", - "p_code":"20", - "code":"22" + "p_code":"31", + "code":"33" }, { - "desc":"This API is used to query instances and details based on specified conditions.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instan", + "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}", "product_code":"nosql", "title":"Querying Instances and Details", "uri":"nosql_05_0016.html", "doc_type":"api", - "p_code":"20", - "code":"23" + "p_code":"31", + "code":"34" }, { - "desc":"This API is used to scale up storage space of an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/e", + "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", "product_code":"nosql", "title":"Scaling Up Storage Space of an Instance", "uri":"nosql_05_0050.html", "doc_type":"api", - "p_code":"20", - "code":"24" + "p_code":"31", + "code":"35" }, { "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", @@ -221,8 +320,8 @@ "title":"Adding Nodes for an Instance", "uri":"nosql_05_0051.html", "doc_type":"api", - "p_code":"20", - "code":"25" + "p_code":"31", + "code":"36" }, { "desc":"This API is used to delete nodes from a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/", @@ -230,8 +329,17 @@ "title":"Deleting Nodes from a Specified Instance", "uri":"nosql_05_0052.html", "doc_type":"api", - "p_code":"20", - "code":"26" + "p_code":"31", + "code":"37" + }, + { + "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", + "product_code":"nosql", + "title":"Querying Changeable Specifications", + "uri":"nosql_05_0156.html", + "doc_type":"api", + "p_code":"31", + "code":"38" }, { "desc":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ", @@ -239,35 +347,35 @@ "title":"Changing Specifications of an Instance", "uri":"nosql_05_0100.html", "doc_type":"api", - "p_code":"20", - "code":"27" + "p_code":"31", + "code":"39" }, { - "desc":"This API is used to reset the administrator password of an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.Only t", + "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", "product_code":"nosql", "title":"Resetting the Administrator Password of an Instance", "uri":"nosql_05_0101.html", "doc_type":"api", - "p_code":"20", - "code":"28" + "p_code":"31", + "code":"40" }, { - "desc":"This API is used to edit the name of an instance.This API supports GeminiDB Cassandra instances.The name of the instance that is being created or fails to be created cann", + "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", "product_code":"nosql", "title":"Editing the Name of an Instance", "uri":"nosql_05_0102.html", "doc_type":"api", - "p_code":"20", - "code":"29" + "p_code":"31", + "code":"41" }, { - "desc":"This API is used to change the security group associated with an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.", + "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", "product_code":"nosql", "title":"Changing the Security Group of an Instance", "uri":"nosql_05_0103.html", "doc_type":"api", - "p_code":"20", - "code":"30" + "p_code":"31", + "code":"42" }, { "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", @@ -275,8 +383,8 @@ "title":"Configuring an Autoscaling Policy for Storage Space", "uri":"nosql_05_0109.html", "doc_type":"api", - "p_code":"20", - "code":"31" + "p_code":"31", + "code":"43" }, { "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_", @@ -284,8 +392,8 @@ "title":"Querying the Autoscaling Policy of Storage Space", "uri":"nosql_05_0115.html", "doc_type":"api", - "p_code":"20", - "code":"32" + "p_code":"31", + "code":"44" }, { "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.", @@ -293,152 +401,134 @@ "title":"Backups and Restorations", "uri":"topic_300000003.html", "doc_type":"api", - "p_code":"13", - "code":"33" - }, - { - "desc":"This API is used to query an automated backup policy.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups", - "product_code":"nosql", - "title":"Querying an Automated Backup Policy", - "uri":"nosql_api_0030.html", - "doc_type":"api", - "p_code":"33", - "code":"34" - }, - { - "desc":"This API is used to configuring an automated backup policy.This API supports GeminiDB Cassandra instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/b", - "product_code":"nosql", - "title":"Configuring an Automated Backup Policy", - "uri":"nosql_api_0031.html", - "doc_type":"api", - "p_code":"33", - "code":"35" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"nosql", - "title":"Parameter Templates", - "uri":"topic_300000004.html", - "doc_type":"api", - "p_code":"13", - "code":"36" - }, - { - "desc":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API supports GeminiDB Cassandra instances.GET https://{En", - "product_code":"nosql", - "title":"Obtaining Parameter Templates", - "uri":"nosql_06_0002.html", - "doc_type":"api", - "p_code":"36", - "code":"37" - }, - { - "desc":"This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.This API supports G", - "product_code":"nosql", - "title":"Creating a Parameter Template", - "uri":"nosql_06_0003.html", - "doc_type":"api", - "p_code":"36", - "code":"38" - }, - { - "desc":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API supports GeminiDB Cassandra instance", - "product_code":"nosql", - "title":"Modifying Parameters in a Parameter Template", - "uri":"nosql_06_0004.html", - "doc_type":"api", - "p_code":"36", - "code":"39" - }, - { - "desc":"This API is used to apply a parameter template to one or more instances.This API supports GeminiDB Cassandra instances.This API is an asynchronous API. A successful respo", - "product_code":"nosql", - "title":"Applying a Parameter Template", - "uri":"nosql_06_0005.html", - "doc_type":"api", - "p_code":"36", - "code":"40" - }, - { - "desc":"This API is used to modify parameters of a specified instance.This API supports GeminiDB Cassandra instances.For configuration item values, you can enter system-defined p", - "product_code":"nosql", - "title":"Modifying Parameters of a Specified Instance", - "uri":"nosql_06_0006.html", - "doc_type":"api", - "p_code":"36", - "code":"41" - }, - { - "desc":"This API is used to query instance parameter settings.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/config", - "product_code":"nosql", - "title":"Querying Instance Parameter Settings", - "uri":"nosql_06_0007.html", - "doc_type":"api", - "p_code":"36", - "code":"42" - }, - { - "desc":"This API is used to obtain information about parameters of a specified parameter template.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{projec", - "product_code":"nosql", - "title":"Obtaining Parameters of a Specified Parameter Template", - "uri":"nosql_06_0008.html", - "doc_type":"api", - "p_code":"36", - "code":"43" - }, - { - "desc":"This API is used to delete a specified parameter template.This API supports GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_", - "product_code":"nosql", - "title":"Deleting a Parameter Template", - "uri":"nosql_06_0009.html", - "doc_type":"api", - "p_code":"36", - "code":"44" - }, - { - "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", - "product_code":"nosql", - "title":"Tags", - "uri":"topic_300000005.html", - "doc_type":"api", - "p_code":"13", + "p_code":"25", "code":"45" }, { - "desc":"This API is used to query a specified instance by tag.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must ", + "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", "product_code":"nosql", - "title":"Querying an Instance by Tag", - "uri":"ListInstancesByResourceTags.html", + "title":"Configuring an Automated Backup Policy", + "uri":"nosql_api_0031.html", "doc_type":"api", "p_code":"45", "code":"46" }, { - "desc":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to", + "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", "product_code":"nosql", - "title":"Adding or Deleting Resource Tags in Batches", - "uri":"BatchTagAction.html", + "title":"Querying the Time Window When a Backup Can Be Restored", + "uri":"ListRestoreTime.html", "doc_type":"api", "p_code":"45", "code":"47" }, { - "desc":"This API is used to query tags of a specified instance.This API supports GeminiDB Cassandra instances.A maximum of 20 tags can be added to a DB instance. The tag key must", + "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}", "product_code":"nosql", - "title":"Querying Tags of an Instance", - "uri":"ListInstanceTags.html", + "title":"Creating a Manual Backup", + "uri":"nosql_api_0032.html", "doc_type":"api", "p_code":"45", "code":"48" }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nosql", + "title":"Parameter Templates", + "uri":"topic_300000004.html", + "doc_type":"api", + "p_code":"25", + "code":"49" + }, + { + "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", + "product_code":"nosql", + "title":"Creating a Parameter Template", + "uri":"nosql_06_0003.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "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", + "product_code":"nosql", + "title":"Modifying Parameters in a Parameter Template", + "uri":"nosql_06_0004.html", + "doc_type":"api", + "p_code":"49", + "code":"51" + }, + { + "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}", + "product_code":"nosql", + "title":"Querying Instance Parameter Settings", + "uri":"nosql_06_0007.html", + "doc_type":"api", + "p_code":"49", + "code":"52" + }, + { + "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/", + "product_code":"nosql", + "title":"Obtaining Parameters of a Specified Parameter Template", + "uri":"nosql_06_0008.html", + "doc_type":"api", + "p_code":"49", + "code":"53" + }, + { + "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/{", + "product_code":"nosql", + "title":"Deleting a Parameter Template", + "uri":"nosql_06_0009.html", + "doc_type":"api", + "p_code":"49", + "code":"54" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nosql", + "title":"Tags", + "uri":"topic_300000005.html", + "doc_type":"api", + "p_code":"25", + "code":"55" + }, + { + "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", + "product_code":"nosql", + "title":"Querying an Instance by Tag", + "uri":"ListInstancesByResourceTags.html", + "doc_type":"api", + "p_code":"55", + "code":"56" + }, + { + "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", + "product_code":"nosql", + "title":"Adding or Deleting Resource Tags in Batches", + "uri":"BatchTagAction.html", + "doc_type":"api", + "p_code":"55", + "code":"57" + }, + { + "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", + "product_code":"nosql", + "title":"Querying Tags of an Instance", + "uri":"ListInstanceTags.html", + "doc_type":"api", + "p_code":"55", + "code":"58" + }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"nosql", "title":"Logs", "uri":"topic_300000006.html", "doc_type":"api", - "p_code":"13", - "code":"49" + "p_code":"25", + "code":"59" }, { "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", @@ -446,8 +536,8 @@ "title":"Querying Database Slow Logs", "uri":"ListSlowLogs.html", "doc_type":"api", - "p_code":"49", - "code":"50" + "p_code":"59", + "code":"60" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -455,8 +545,8 @@ "title":"Quotas", "uri":"topic_300000007.html", "doc_type":"api", - "p_code":"13", - "code":"51" + "p_code":"25", + "code":"61" }, { "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", @@ -464,8 +554,8 @@ "title":"Querying Quota", "uri":"ShowQuotas.html", "doc_type":"api", - "p_code":"51", - "code":"52" + "p_code":"61", + "code":"62" }, { "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.", @@ -473,8 +563,8 @@ "title":"Task Management", "uri":"topic_300000016.html", "doc_type":"", - "p_code":"13", - "code":"53" + "p_code":"25", + "code":"63" }, { "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", @@ -482,8 +572,62 @@ "title":"Querying Tasks and Details", "uri":"nosql_10_0100.html", "doc_type":"", - "p_code":"53", - "code":"54" + "p_code":"63", + "code":"64" + }, + { + "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":"Historical APIs", + "uri":"nosql_05_0203.html", + "doc_type":"api", + "p_code":"", + "code":"65" + }, + { + "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":"Backup and Restoration", + "uri":"nosql_06_3001.html", + "doc_type":"", + "p_code":"65", + "code":"66" + }, + { + "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", + "product_code":"nosql", + "title":"Querying an Automated Backup Policy", + "uri":"nosql_06_3002.html", + "doc_type":"api", + "p_code":"66", + "code":"67" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"nosql", + "title":"Parameter Templates", + "uri":"nosql_05_0205.html", + "doc_type":"api", + "p_code":"65", + "code":"68" + }, + { + "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", + "product_code":"nosql", + "title":"Applying a Parameter Template", + "uri":"nosql_06_0218.html", + "doc_type":"api", + "p_code":"68", + "code":"69" + }, + { + "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", + "product_code":"nosql", + "title":"Modifying Parameters of a Specified Instance", + "uri":"nosql_06_0219.html", + "doc_type":"api", + "p_code":"68", + "code":"70" }, { "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.", @@ -492,7 +636,7 @@ "uri":"nosql_public_parameters.html", "doc_type":"api", "p_code":"", - "code":"55" + "code":"71" }, { "desc":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", @@ -500,8 +644,8 @@ "title":"Abnormal Request Results", "uri":"nosql_abnormal_result.html", "doc_type":"api", - "p_code":"55", - "code":"56" + "p_code":"71", + "code":"72" }, { "desc":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", @@ -509,8 +653,8 @@ "title":"Status Codes", "uri":"nosql_status_code.html", "doc_type":"api", - "p_code":"55", - "code":"57" + "p_code":"71", + "code":"73" }, { "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", @@ -518,8 +662,8 @@ "title":"Error Codes", "uri":"nosql_error_code.html", "doc_type":"api", - "p_code":"55", - "code":"58" + "p_code":"71", + "code":"74" }, { "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", @@ -527,8 +671,8 @@ "title":"Obtaining a Project ID", "uri":"nosql_projectid.html", "doc_type":"api", - "p_code":"55", - "code":"59" + "p_code":"71", + "code":"75" }, { "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", @@ -536,8 +680,8 @@ "title":"Metrics", "uri":"nosql_metrics.html", "doc_type":"api", - "p_code":"55", - "code":"60" + "p_code":"71", + "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.", @@ -545,8 +689,8 @@ "title":"Events Supported by Event Monitoring", "uri":"nosql_08_0001.html", "doc_type":"api", - "p_code":"55", - "code":"61" + "p_code":"71", + "code":"77" }, { "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,6 +699,6 @@ "uri":"nosql_change_history02.html", "doc_type":"api", "p_code":"", - "code":"62" + "code":"78" } ] \ No newline at end of file diff --git a/docs/geminidb/api-ref/ListInstanceTags.html b/docs/geminidb/api-ref/ListInstanceTags.html index d830dd193..9ba3f76a9 100644 --- a/docs/geminidb/api-ref/ListInstanceTags.html +++ b/docs/geminidb/api-ref/ListInstanceTags.html @@ -3,12 +3,12 @@

    Querying Tags of an Instance

    Function

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

    -

    Constraints

    This API supports GeminiDB Cassandra instances.

    +

    Constraints

    This API can be used for GeminiDB Cassandra instances.

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

    URI

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

    -
Table 2 Request header parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

Content-Type

Yes

+

Yes

String

+

String

User token.

+

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

+

X-Auth-Token

+

Yes

+

String

+

User token.

Table 1 Path parameters

Parameter

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

Request Parameters

-
Table 1 URI parameters

Parameter

Mandatory

Table 2 Request header parameters

Parameter

+
@@ -64,9 +64,9 @@
Table 2 Request header parameter

Parameter

Mandatory

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

-
Table 3 Response body parameters

Parameter

+
@@ -113,10 +113,10 @@
Table 3 Response body parameter

Parameter

Type

-

Example Requests

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

Example Request

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

Example Responses

Status code: 200

+

Example Response

Status code: 200

Success

{
   "tags" : [ {
@@ -128,9 +128,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/ListInstancesByResourceTags.html b/docs/geminidb/api-ref/ListInstancesByResourceTags.html index bd246c137..2a2718156 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 supports GeminiDB Cassandra instances.

+

Constraints

This API can be used for GeminiDB Cassandra instances.

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

URI

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

-
Table 1 Path parameters

Parameter

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

Request Parameters

-
Table 1 URI parameter

Parameter

Mandatory

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

Parameter

+
- - - - - - - + + + + + @@ -178,14 +187,14 @@
Table 2 Request header parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

Content-Type

Yes

+

Yes

String

+

String

User token.

+

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

+

X-Auth-Token

+

Yes

+

String

+

User token.

Array of strings

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

-

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

+

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

-

Response Parameters

Status code: 200

+

Response Parameters

Status code: 200

@@ -274,7 +283,7 @@
Table 6 Response body parameters

Parameter

-

Example Requests

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

    Example Request

    • 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,
      @@ -309,7 +318,7 @@
       }
    -

    Example Responses

    Status code: 200

    +

    Example Response

    Status code: 200

    Success

    {
       "total_count": 1,
    @@ -326,9 +335,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/ListRestoreTime.html b/docs/geminidb/api-ref/ListRestoreTime.html new file mode 100644 index 000000000..0c6ed5da3 --- /dev/null +++ b/docs/geminidb/api-ref/ListRestoreTime.html @@ -0,0 +1,197 @@ + + +

    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:

    +
    • 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.

    +

    +
    +

    URI

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/restorable-time-periods

    + +
    + + + + + + + + + + + + + + + + +
    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, 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.

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

    Parameter

    +

    Mandatory

    +

    Type

    +

    Description

    +

    start_time

    +

    No

    +

    String

    +

    Start time point that the backup can be restored to. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

    +

    end_time

    +

    No

    +

    String

    +

    End time point that the backup can be restored to. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

    +

    offset

    +

    No

    +

    Integer

    +

    Offset. The records after this offset will be queried. The default value is 0.

    +

    limit

    +

    No

    +

    Integer

    +

    Maximum number of records displayed on each page. The value ranges from 0 to 1000. The default value is 1000.

    +
    +
    +
    +

    Request Parameters

    +
    + + + + + + + + + + + +
    Table 3 Request header parameter

    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 time windows when a backup can be restored.

    +

    restorable_time_periods

    +

    Array of restorableTime objects

    +

    Time windows when a backup can be restored.

    +
    +
    + +
    + + + + + + + + + + + + + +
    Table 5 restorableTime

    Parameter

    +

    Type

    +

    Description

    +

    start_time

    +

    Long

    +

    Start time of the restoration time range in the UNIX timestamp format. The start time is the UTC time in milliseconds.

    +

    end_time

    +

    Long

    +

    End time point of the restoration time range in the UNIX timestamp format. The end time is the UTC time in milliseconds.

    +
    +
    +
    +

    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 Response

    Status code: 200

    +

    Success

    +
    {
    +  "total_count" : 1,
    +  "restorable_time_periods" : [ {
    +    "start_time" : 1607731200000,
    +    "end_time" : 1607731200000
    +  } ]
    +}
    +
    +

    Status Codes

    See Status Codes.

    +
    +

    Error Codes

    See Error Codes.

    +
    +
    +
    + +
    + diff --git a/docs/geminidb/api-ref/ListSlowLogs.html b/docs/geminidb/api-ref/ListSlowLogs.html index b2fcaffa1..f0fb37bfa 100644 --- a/docs/geminidb/api-ref/ListSlowLogs.html +++ b/docs/geminidb/api-ref/ListSlowLogs.html @@ -234,9 +234,9 @@ } ] }
    -

    Status Codes

    For details, see Status Codes.

    +

    Status Codes

    For details, see Status Codes.

    -

    Error Codes

    For details, see Error Codes.

    +

    Error Codes

    For details, see Error Codes.

    diff --git a/docs/geminidb/api-ref/ShowApiVersion.html b/docs/geminidb/api-ref/ShowApiVersion.html index 38f2ca920..718151838 100644 --- a/docs/geminidb/api-ref/ShowApiVersion.html +++ b/docs/geminidb/api-ref/ShowApiVersion.html @@ -151,9 +151,9 @@ } }
    -

    Status Codes

    For details, see Status Codes.

    +

    Status Codes

    For details, see Status Codes.

    -

    Error Codes

    For details, see Error Codes.

    +

    Error Codes

    For details, see Error Codes.

    diff --git a/docs/geminidb/api-ref/ShowQuotas.html b/docs/geminidb/api-ref/ShowQuotas.html index 44f160ff7..12529dfa1 100644 --- a/docs/geminidb/api-ref/ShowQuotas.html +++ b/docs/geminidb/api-ref/ShowQuotas.html @@ -141,9 +141,9 @@ } }
    -

    Status Codes

    For details, see Status Codes.

    +

    Status Codes

    For details, see Status Codes.

    -

    Error Codes

    For details, see Error Codes.

    +

    Error Codes

    For details, see Error Codes.

    diff --git a/docs/geminidb/api-ref/en-us_image_0000001355018024.png b/docs/geminidb/api-ref/en-us_image_0000002192228076.png similarity index 100% rename from docs/geminidb/api-ref/en-us_image_0000001355018024.png rename to docs/geminidb/api-ref/en-us_image_0000002192228076.png diff --git a/docs/geminidb/api-ref/en-us_image_0000001354858484.jpg b/docs/geminidb/api-ref/en-us_image_0000002192387692.jpg similarity index 100% rename from docs/geminidb/api-ref/en-us_image_0000001354858484.jpg rename to docs/geminidb/api-ref/en-us_image_0000002192387692.jpg diff --git a/docs/geminidb/api-ref/en-us_image_0000001354698252.png b/docs/geminidb/api-ref/en-us_image_0000002227713545.png similarity index 100% rename from docs/geminidb/api-ref/en-us_image_0000001354698252.png rename to docs/geminidb/api-ref/en-us_image_0000002227713545.png diff --git a/docs/geminidb/api-ref/nosql_05_0005.html b/docs/geminidb/api-ref/nosql_05_0005.html index 4d084e827..ed5a5cdb4 100644 --- a/docs/geminidb/api-ref/nosql_05_0005.html +++ b/docs/geminidb/api-ref/nosql_05_0005.html @@ -7,7 +7,7 @@
  • Region

    A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.

  • AZ

    An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are connected using high-speed optical fibers to support cross-AZ high-availability systems.

  • Project

    A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in specific subprojects.

    -
    Figure 1 Project isolating model
    +
    Figure 1 Project isolating model
  • Enterprise Project

    Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from the enterprise project.

@@ -17,3 +17,10 @@
+ + \ No newline at end of file diff --git a/docs/geminidb/api-ref/nosql_05_0008.html b/docs/geminidb/api-ref/nosql_05_0008.html index e9a94c9ec..85f659fbe 100644 --- a/docs/geminidb/api-ref/nosql_05_0008.html +++ b/docs/geminidb/api-ref/nosql_05_0008.html @@ -1,7 +1,7 @@

Making an API Request

-

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

+

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

Request URI

A request URI consists of the following:

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

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

@@ -19,7 +19,7 @@

Endpoint

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

+

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

resource-path

@@ -86,7 +86,7 @@

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

Yes

+

This field is optional for GET requests and mandatory for other requests.

application/json

-

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

+

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

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

(Optional) Request Body

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

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

-

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

+

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

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

@@ -148,7 +148,7 @@ Content-Type: application/json
                     "name": "username",
                     "password": "********",
                     "domain": {
-                        "name": "domianname"
+                        "name": "domainname"
                     }
                 }
             }
diff --git a/docs/geminidb/api-ref/nosql_05_0009.html b/docs/geminidb/api-ref/nosql_05_0009.html
index f84c93b68..5783c13af 100644
--- a/docs/geminidb/api-ref/nosql_05_0009.html
+++ b/docs/geminidb/api-ref/nosql_05_0009.html
@@ -30,11 +30,10 @@
         }
     }
 }
-

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

-
 
-POST https://{{Endpoint}}/v3/auth/projects
+

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

+
GET https://{{Endpoint}}/v3/auth/projects
 Content-Type: application/json 
-X-Auth-Token: ABCDEFJ....
+X-Auth-Token: ABCDEFG....

Response Header

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

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

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

(Optional) Response Body

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

@@ -37,3 +37,10 @@
+ + \ No newline at end of file diff --git a/docs/geminidb/api-ref/nosql_05_0014.html b/docs/geminidb/api-ref/nosql_05_0014.html index f7709306c..471565ded 100644 --- a/docs/geminidb/api-ref/nosql_05_0014.html +++ b/docs/geminidb/api-ref/nosql_05_0014.html @@ -1,13 +1,13 @@

Creating an Instance

-

Function

This API can be used to create 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 supports GeminiDB Cassandra instances.

+

Constraints

This API can be used for GeminiDB Cassandra instances.

URI

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

-
Table 1 Path parameters

Parameter

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

Request Parameters

-
Table 1 URI parameter

Parameter

Mandatory

- @@ -268,7 +287,7 @@
Table 2 Request header parameters

Parameter

+
- - - - - - - + + + + + @@ -71,7 +80,7 @@ + + + + +
Table 2 Request header parameter

Parameter

Mandatory

+

Mandatory

Type

+

Type

Description

+

Description

X-Auth-Token

+

Content-Type

Yes

+

Yes

String

+

String

User token.

+

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

+

X-Auth-Token

+

Yes

+

String

+

User token.

String

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

-

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

+

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

datastore

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

String

Region ID.

-

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

+

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

availability_zone

@@ -130,7 +139,7 @@

String

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

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

password

@@ -203,6 +212,16 @@
  • 0, indicating that SSL is disabled by default.
  • 1, indicating that SSL is enabled by default.
  • If this parameter is not transferred, SSL is disabled by default.

restore_info

+

No

+

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.

+
@@ -224,7 +243,7 @@

String

Database type.

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

version

@@ -233,7 +252,7 @@

String

Database version. The value can be:

+

Database version.

  • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.

String

Number of nodes.

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

size

@@ -340,10 +359,54 @@
- -

Response Parameters

Status code: 202

-
Table 7 Response body parameters

Parameter

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 7 RestoreInfo

Parameter

+

Mandatory

+

Type

+

Description

+

backup_id

+

No

+

String

+

Full backup file ID.

+

This parameter cannot be left blank when you create an instance to restore data using a specific backup.

+

source_instance_id

+

No

+

String

+

ID of the specified instance that backup data is restored to.

+

This parameter cannot be left blank when you restore data at a specific time point from a specific instance to a new instance.

+

restore_time

+

No

+

Long

+

Time point that backup data is restored to.

+

This parameter cannot be left blank when you restore data at a specific point in time from a specific instance to a new instance. The value is a 13-digit number in milliseconds (UTC). You can query the value by following Querying the Time Window When a Backup Can Be Restored.

+
+
+ +

Response Parameters

Status code: 202

+ +
@@ -460,7 +523,7 @@
Table 8 Response body parameters

Parameter

Type

-
Table 8 Datastore

Parameter

+
@@ -473,14 +536,14 @@ - @@ -496,7 +559,7 @@
Table 9 Datastore

Parameter

Type

String

Database type.

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

version

String

Database version. The value can be:

+

Database version.

  • 3.11, indicating that GeminiDB Cassandra 3.11 is supported.
-
Table 9 Flavor

Parameter

+
@@ -509,7 +572,7 @@
Table 10 Flavor

Parameter

Type

String

Number of nodes.

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

size

@@ -540,7 +603,7 @@
-
Table 10 BackupStrategy

Parameter

+
@@ -570,7 +633,7 @@
Table 11 BackupStrategy

Parameter

Type

-

Example Requests

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

    Example Request

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

      {
      @@ -599,9 +662,72 @@
         },
         "ssl_option" : 1
       }
      +
    • Creating a pay-per-use 3-node GeminiDB Cassandra instance with 16 vCPUs and 64 GB of memory based on data restored using a specific backup

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

      +
      +
      { 
      +   "name" : "test-cassandra-01", 
      +   "datastore" : { 
      +     "type" : "cassandra", 
      +     "version" : "3.11", 
      +     "storage_engine" : "rocksDB" 
      +   }, 
      +   "region" : "aaa", 
      +   "availability_zone" : "bbb", 
      +   "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961", 
      +   "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007", 
      +   "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58", 
      +   "password" : "******", 
      +   "mode" : "Cluster", 
      +   "flavor" : [ { 
      +     "num" : 3, 
      +     "storage" : "ULTRAHIGH", 
      +     "size" : 500, 
      +     "spec_code" : "geminidb.cassandra.4xlarge.4" 
      +   } ], 
      +   "backup_strategy" : { 
      +     "start_time" : "08:15-09:15", 
      +     "keep_days" : 8 
      +   }, 
      +   "ssl_option" : 1, 
      +   "restore_info" : { 
      +     "backup_id" : "2f4ddb93b9014b0893d81d2e472f30fe"
      +   } 
      + }
      +
    • Creating a yearly/monthly 3-node GeminiDB Cassandra instance with 16 vCPUs and 64 GB of memory based on the data of a specified instance at a specified point in time

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

      +
      +
      { 
      +   "name" : "test-cassandra-01", 
      +   "datastore" : { 
      +     "type" : "cassandra", 
      +     "version" : "3.11", 
      +     "storage_engine" : "rocksDB" 
      +   }, 
      +   "region" : "aaa", 
      +   "availability_zone" : "bbb", 
      +   "vpc_id" : "674e9b42-cd8d-4d25-a2e6-5abcc565b961", 
      +   "subnet_id" : "f1df08c5-71d1-406a-aff0-de435a51007", 
      +   "security_group_id" : "7aa51dbf-5b63-40db-9724-dad3c4828b58", 
      +   "password" : "******", 
      +   "mode" : "Cluster", 
      +   "flavor" : [ { 
      +     "num" : 3, 
      +     "storage" : "ULTRAHIGH", 
      +     "size" : 500, 
      +     "spec_code" : "geminidb.cassandra.4xlarge.4" 
      +   } ], 
      +   "backup_strategy" : { 
      +     "start_time" : "08:15-09:15", 
      +     "keep_days" : 8 
      +   }, 
      +   "ssl_option" : 1, 
      +   "restore_info" : { 
      +     "restore_time" : 1607731200000, 
      +     "source_instance_id" : "054e292c9880d4992f02c0196d3ein12" 
      +   } 
      + }
    -

    Example Responses

    Status code: 202

    +

    Example Response

    Status code: 202

    Accepted

    {
       "id" : "39b6a1a278844ac48119d86512e0000bin06",
    @@ -633,9 +759,9 @@
       "job_id" : "c010abd0-48cf-4fa8-8cbc-090f093eaa2f"
     }
    -

    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/nosql_05_0015.html b/docs/geminidb/api-ref/nosql_05_0015.html index 3bb279c1b..8f9de8937 100644 --- a/docs/geminidb/api-ref/nosql_05_0015.html +++ b/docs/geminidb/api-ref/nosql_05_0015.html @@ -3,11 +3,11 @@

    Deleting an Instance

    Function

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

    -

    Constraints

    This API supports GeminiDB Cassandra instances.

    +

    Constraints

    This API can be used for GeminiDB Cassandra instances.

    URI

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

    -
    Table 1 Path parameters

    Parameter

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

    Request Parameters

    -
    Table 1 URI parameters

    Parameter

    Mandatory

    Table 2 Request header parameters

    Parameter

    +
    @@ -84,18 +84,18 @@
    Table 2 Request header parameter

    Parameter

    Mandatory

    -

    Example Requests

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

    Example Request

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

    Example Responses

    Status code: 202

    +

    Example Response

    Status code: 202

    Accepted

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

    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/nosql_05_0016.html b/docs/geminidb/api-ref/nosql_05_0016.html index 8d1af08d6..0dd9ec821 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 supports GeminiDB Cassandra instances.

    +

    Constraints

    This API can be used for GeminiDB Cassandra instances.

    URI

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

    -
    Table 1 Path parameters

    Parameter

    +
    @@ -68,7 +68,7 @@ @@ -127,7 +127,7 @@

    Request Parameters

    -
    Table 1 URI parameter

    Parameter

    Mandatory

    Database type. The value can be:

    cassandra, indicating that GeminiDB Cassandra instances are queried.

    -

    +

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

    mode

    @@ -78,7 +78,7 @@

    String

    Instance type. The value can be:

    -

    Cluster, indicating that GeminiDB Cassandra cluster instances are queried.

    +

    Cluster: GeminiDB Cassandra cluster instances

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

    Table 3 Request header parameters

    Parameter

    +
    @@ -150,7 +150,7 @@
    Table 3 Request header parameter

    Parameter

    Mandatory

    -

    Response Parameters

    Status code: 200

    +

    Response Parameters

    Status code: 200

    @@ -548,14 +548,14 @@
    Table 4 Response body parameters

    Parameter

    -

    Example Requests

    • URI example

      Querying all instances and details

      +

      Example Request

      • 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 Responses

      Status code: 200

      +

      Example Response

      Status code: 200

      Success

      {
         "instances" : [ {
      @@ -685,9 +685,9 @@
         "total_count" : 2
       }
      -

      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/nosql_05_0050.html b/docs/geminidb/api-ref/nosql_05_0050.html index 6d1c65c03..ceee983d4 100644 --- a/docs/geminidb/api-ref/nosql_05_0050.html +++ b/docs/geminidb/api-ref/nosql_05_0050.html @@ -3,11 +3,11 @@

      Scaling Up Storage Space of an Instance

      Function

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

      -

      Constraints

      This API supports GeminiDB Cassandra instances.

      +

      Constraints

      This API can be used for GeminiDB Cassandra instances.

      URI

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

      -
      Table 1 Path parameters

      Parameter

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

      Request Parameters

      -
      Table 1 URI parameters

      Parameter

      Mandatory

      Table 2 Request header parameters

      Parameter

      +
      - - - - - - - + + + + + @@ -109,21 +118,21 @@
      Table 2 Request header parameter

      Parameter

      Mandatory

      +

      Mandatory

      Type

      +

      Type

      Description

      +

      Description

      X-Auth-Token

      +

      Content-Type

      Yes

      +

      Yes

      String

      +

      String

      User token.

      +

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

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token.

      -

      Example Requests

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

        Example Request

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

        Example Responses

        Status code: 202

        +

        Example Response

        Status code: 202

        Accepted

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

        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/nosql_05_0051.html b/docs/geminidb/api-ref/nosql_05_0051.html index 08531c0de..cc5f70f17 100644 --- a/docs/geminidb/api-ref/nosql_05_0051.html +++ b/docs/geminidb/api-ref/nosql_05_0051.html @@ -7,7 +7,7 @@

        URI

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

        -
        Table 1 Path parameters

        Parameter

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

        Request Parameters

        -
        Table 1 URI parameters

        Parameter

        Mandatory

        Table 2 Request header parameters

        Parameter

        +
        - - - - - - - + + + + + @@ -89,7 +98,7 @@ @@ -117,21 +126,21 @@
        Table 2 Request header parameter

        Parameter

        Mandatory

        +

        Mandatory

        Type

        +

        Type

        Description

        +

        Description

        X-Auth-Token

        +

        Content-Type

        Yes

        +

        Yes

        String

        +

        String

        User token.

        +

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

        +

        X-Auth-Token

        +

        Yes

        +

        String

        +

        User token.

        String

        ID of the subnet where the new node is deployed.

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

        Example Requests

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

          Example Request

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

          Example Responses

          Status code: 202

          +

          Example Response

          Status code: 202

          Accepted

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

          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/nosql_05_0052.html b/docs/geminidb/api-ref/nosql_05_0052.html index e11827d12..0ca0196df 100644 --- a/docs/geminidb/api-ref/nosql_05_0052.html +++ b/docs/geminidb/api-ref/nosql_05_0052.html @@ -7,7 +7,7 @@

          URI

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

          -
          Table 1 Path parameters

          Parameter

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

          Request Parameters

          -
          Table 1 URI parameters

          Parameter

          Mandatory

          Table 2 Request header parameters

          Parameter

          +
          - - - - - - - + + + + + @@ -81,7 +90,7 @@ @@ -93,7 +102,7 @@ @@ -122,22 +131,22 @@
          Table 2 Request header parameter

          Parameter

          Mandatory

          +

          Mandatory

          Type

          +

          Type

          Description

          +

          Description

          X-Auth-Token

          +

          Content-Type

          Yes

          +

          Yes

          String

          +

          String

          User token.

          +

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

          +

          X-Auth-Token

          +

          Yes

          +

          String

          +

          User token.

          Number of nodes to be deleted randomly.

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

          -
          NOTE:

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

          +
          NOTE:

          If the client is directly connected to a node, random scale-in is not recommended.

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

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

          Example Requests

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

            Example Request

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

            Example Responses

            Status code: 202

            +

            Example Response

            Status code: 202

            Accepted

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

            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/nosql_05_0100.html b/docs/geminidb/api-ref/nosql_05_0100.html index 0d1e826f9..55d834ac8 100644 --- a/docs/geminidb/api-ref/nosql_05_0100.html +++ b/docs/geminidb/api-ref/nosql_05_0100.html @@ -13,7 +13,7 @@

            URI

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

            -
            Table 1 Path parameters

            Parameter

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

            Request Parameters

            -
            Table 1 URI parameters

            Parameter

            Mandatory

            Table 2 Request header parameters

            Parameter

            +
            - - - - - - - + + + + + @@ -137,23 +146,23 @@
            Table 2 Request header parameter

            Parameter

            Mandatory

            +

            Mandatory

            Type

            +

            Type

            Description

            +

            Description

            X-Auth-Token

            +

            Content-Type

            Yes

            +

            Yes

            String

            +

            String

            User token.

            +

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

            +

            X-Auth-Token

            +

            Yes

            +

            String

            +

            User token.

            -

            Example Requests

            • URI example
              PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize
              -
            • Changing instance specifications to 16 vCPUs | 64 GB
              {
              +

              Example Request

              • 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"
                   }
                 }
              -

              Example Responses

              Status code: 202

              +

              Example Response

              Status code: 202

              Accepted

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

              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/nosql_05_0101.html b/docs/geminidb/api-ref/nosql_05_0101.html index 414204cce..5b5a2babe 100644 --- a/docs/geminidb/api-ref/nosql_05_0101.html +++ b/docs/geminidb/api-ref/nosql_05_0101.html @@ -3,13 +3,13 @@

              Resetting the Administrator Password of an Instance

              Function

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

              -

              Constraints

              This API supports GeminiDB Cassandra instances.

              +

              Constraints

              This API can be used for GeminiDB Cassandra instances.

              Abnormal instances do not support this operation.

              Only the password of user rwuser can be reset.

              URI

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

              -
              Table 1 Path parameters

              Parameter

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

              Request Parameters

              -
              Table 1 URI parameters

              Parameter

              Mandatory

              Table 2 Request header parameters

              Parameter

              +
              - - - - - - - + + + + +
              Table 2 Request header parameter

              Parameter

              Mandatory

              +

              Mandatory

              Type

              +

              Type

              Description

              +

              Description

              X-Auth-Token

              +

              Content-Type

              Yes

              +

              Yes

              String

              +

              String

              User token.

              +

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

              +

              X-Auth-Token

              +

              Yes

              +

              String

              +

              User token.

              -
              Table 3 Request body parameters

              Parameter

              +
              @@ -90,21 +99,21 @@
              Table 3 Request body parameter

              Parameter

              Mandatory

              -

              Response Parameters

              Status code: 204

              -

              No response parameters

              +

              Response Parameters

              Status code: 204

              +

              None

              -

              Example Requests

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

                Example Request

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

                Example Responses

                Status code: 204

                +

                Example Response

                Status code: 204

                No Content

                -

                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/nosql_05_0102.html b/docs/geminidb/api-ref/nosql_05_0102.html index 30d7dad8d..458632e7b 100644 --- a/docs/geminidb/api-ref/nosql_05_0102.html +++ b/docs/geminidb/api-ref/nosql_05_0102.html @@ -3,12 +3,12 @@

                Editing the Name of an Instance

                Function

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

                -

                Constraints

                This API supports GeminiDB Cassandra instances.

                +

                Constraints

                This API can be used for GeminiDB Cassandra instances.

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

                URI

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

                -
                Table 1 Path parameters

                Parameter

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

                Request Parameters

                -
                Table 1 URI parameters

                Parameter

                Mandatory

                Table 2 Request header parameters

                Parameter

                +
                - - - - - - - + + + + +
                Table 2 Request header parameter

                Parameter

                Mandatory

                +

                Mandatory

                Type

                +

                Type

                Description

                +

                Description

                X-Auth-Token

                +

                Content-Type

                Yes

                +

                Yes

                String

                +

                String

                User token.

                +

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

                +

                X-Auth-Token

                +

                Yes

                +

                String

                +

                User token.

                -
                Table 3 Request body parameters

                Parameter

                +
                @@ -89,20 +98,20 @@
                Table 3 Request body parameter

                Parameter

                Mandatory

                -

                Response Parameters

                Status code: 204

                -

                No response parameters

                +

                Response Parameters

                Status code: 204

                +

                None

                -

                Example Requests

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

                  Example Request

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

                  Example Responses

                  None

                  +

                  Example Response

                  None

                  -

                  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/nosql_05_0103.html b/docs/geminidb/api-ref/nosql_05_0103.html index a893ed6b0..24e7a8b7b 100644 --- a/docs/geminidb/api-ref/nosql_05_0103.html +++ b/docs/geminidb/api-ref/nosql_05_0103.html @@ -3,13 +3,13 @@

                  Changing the Security Group of an Instance

                  Function

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

                  -

                  Constraints

                  This API supports GeminiDB Cassandra instances.

                  +

                  Constraints

                  This API can be used for GeminiDB Cassandra instances.

                  Abnormal instances do not support this operation.

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

                  URI

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

                  -
                  Table 1 Path parameters

                  Parameter

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

                  Request Parameters

                  -
                  Table 1 URI parameters

                  Parameter

                  Mandatory

                  Table 2 Request header parameters

                  Parameter

                  +
                  - - - - - - - + + + + +
                  Table 2 Request header parameter

                  Parameter

                  Mandatory

                  +

                  Mandatory

                  Type

                  +

                  Type

                  Description

                  +

                  Description

                  X-Auth-Token

                  +

                  Content-Type

                  Yes

                  +

                  Yes

                  String

                  +

                  String

                  User token.

                  +

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

                  +

                  X-Auth-Token

                  +

                  Yes

                  +

                  String

                  +

                  User token.

                  -
                  Table 3 Request body parameters

                  Parameter

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

                  Response Parameters

                  Status code: 202

                  -
                  Table 3 Request body parameter

                  Parameter

                  Mandatory

                  Table 4 Response body parameters

                  Parameter

                  +
                  @@ -109,21 +118,21 @@
                  Table 4 Response body parameter

                  Parameter

                  Type

                  -

                  Example Requests

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

                    Example Request

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

                    Example Responses

                    Status code: 202

                    +

                    Example Response

                    Status code: 202

                    No Content

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

                    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/nosql_05_0109.html b/docs/geminidb/api-ref/nosql_05_0109.html index 09ef2659e..ed10b2e9e 100644 --- a/docs/geminidb/api-ref/nosql_05_0109.html +++ b/docs/geminidb/api-ref/nosql_05_0109.html @@ -7,7 +7,7 @@

                    URI

                    PUT https://{Endpoint}/v3/{project_id}/instances/disk-auto-expansion

                    -
                    Table 1 Path parameters

                    Parameter

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

                    Request Parameters

                    -
                    Table 1 URI parameter

                    Parameter

                    Mandatory

                    Table 2 Request header parameters

                    Parameter

                    +
                    - - - - - - - + + + + + @@ -86,7 +95,7 @@ - @@ -114,8 +123,8 @@ @@ -126,11 +135,11 @@ @@ -142,8 +151,9 @@ @@ -154,7 +164,7 @@

                    Response Parameters

                    Status code: 204

                    No response parameters

                    -

                    Example Requests

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

                        Example Request

                        • 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" : { 
                            @@ -172,13 +182,13 @@
                             
                        -

                        Example Responses

                        Status code: 204

                        +

                        Example Response

                        Status code: 204

                        No Content

                        { }
                        -

                        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/nosql_05_0115.html b/docs/geminidb/api-ref/nosql_05_0115.html index bf200c176..1b5e90872 100644 --- a/docs/geminidb/api-ref/nosql_05_0115.html +++ b/docs/geminidb/api-ref/nosql_05_0115.html @@ -134,9 +134,9 @@ } }
                        -

                        Status Codes

                        For details, see Status Codes.

                        +

                        Status Codes

                        For details, see Status Codes.

                        -

                        Error Codes

                        For details, see Error Codes.

                        +

                        Error Codes

                        For details, see Error Codes.

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

                        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.

                        +
                        +

                        URI

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

                        + +
                    Table 2 Request header parameter

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    X-Auth-Token

                    +

                    Content-Type

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    User token.

                    +

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

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token.

                    policy

                    No

                    +

                    No

                    Array of diskAutoExpansionPolicy

                    Integer

                    Threshold for triggering autoscaling.

                    -
                    • GeminiDB Cassandra instances
                      • 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 instances
                      • 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.
                      +
                      • 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.

                    Integer

                    Autoscaling step (s%).

                    -
                    • GeminiDB Cassandra instances
                      • 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 instances
                      • 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.
                      +
                      • 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 instances
                        • 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 instances
                        • The value after the decimal point is rounded. The minimum step is 1 GB by default.
                        +
                        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.

                    Integer

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

                    -
                    • GeminiDB Cassandra instances
                      • Maximum amount that the system can automatically scale up an instance's storage space to must be greater than or equal to 100 GB of the current DB instance storage space. The value must be no less than the total storage of the instance and cannot exceed its maximum storage.
                      • Batch autoscaling does not allow you to specify an upper storage limit. The upper limit is the maximum storage defined by your instance specifications by default.
                      -
                    • GeminiDB Redis instances
                      • Autoscaling does not allow you to specify an upper storage limit. The upper limit is the maximum storage defined by your instance specifications by default.
                      +
                      • 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 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.

                    +
                    • The query starts from the next piece of data indexed by this parameter. The value is 0 by default.
                    • The value must be a positive integer.
                    +

                    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

                    +

                    instance_id

                    +

                    String

                    +

                    Instance ID.

                    +

                    instance_name

                    +

                    String

                    +

                    Instance name.

                    +

                    current_flavor

                    +

                    ComputeFlavor object

                    +

                    Instance specifications.

                    +

                    optional_flavors

                    +

                    OptionalFlavorsInfo object

                    +

                    Available specification options that the instance specifications can be changed to.

                    +
                    +
                    + +
                    + + + + + + + + + + + + + + + + + + + + + + + + + +
                    Table 5 ComputeFlavor

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    vcpus

                    +

                    String

                    +

                    Number of vCPUs.

                    +

                    ram

                    +

                    String

                    +

                    Memory size in GB.

                    +

                    spec_code

                    +

                    String

                    +

                    Specification code.

                    +

                    az_status

                    +

                    Map<String,String>

                    +

                    AZ status.

                    +

                    region_status

                    +

                    String

                    +

                    Region status.

                    +
                    +
                    + +
                    + + + + + + + + + + + + + +
                    Table 6 OptionalFlavorsInfo

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    list

                    +

                    Array of ComputeFlavor object

                    +

                    Available specification options that the instance specifications can be changed to.

                    +

                    total_count

                    +

                    Integer

                    +

                    Total number of records.

                    +
                    +
                    +
                    +

                    Example Request

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

                      None

                      +
                    +
                    +

                    Example Response

                    Status code: 200

                    +
                    Success
                    { 
                    +  "instance_id" : "094424666ef04f79a2dfbe9f5b8b31a5in06", 
                    +  "instance_name" : "geminidb_instance_noreuse_0_ZKv2FSkxgoc3F8bGzsaxNg", 
                    +  "current_flavor" : { 
                    +    "vcpus" : "4", 
                    +    "ram" : "16", 
                    +    "spec_code" : "geminidb.cassandra.xlarge.4", 
                    +    "az_status" : { 
                    +      "az2***" : "unknown", 
                    +      "az1***" : "normal", 
                    +      "az3***" : "unknown" 
                    +    }, 
                    +    "region_status" : null 
                    +  }, 
                    +  "optional_flavors" : {
                    +    "list" : [ { 
                    +      "vcpus" : "2", 
                    +      "ram" : "8", 
                    +      "spec_code" : "geminidb.cassandra.large.4", 
                    +      "az_status" : { 
                    +        "az2***" : "unknown", 
                    +        "az1***" : "normal", 
                    +        "az4***" : "normal", 
                    +        "az3***" : "unknown" 
                    +      }, 
                    +      "region_status" : "normal" 
                    +    }, { 
                    +      "vcpus" : "8", 
                    +      "ram" : "32", 
                    +      "spec_code" : "geminidb.cassandra.2xlarge.4", 
                    +      "az_status" : { 
                    +        "az2***" : "unknown", 
                    +        "az1***" : "normal", 
                    +        "az3***" : "unknown" 
                    +      }, 
                    +      "region_status" : "normal" 
                    +    }, { 
                    +      "vcpus" : "16", 
                    +      "ram" : "64", 
                    +      "spec_code" : "geminidb.cassandra.4xlarge.4", 
                    +      "az_status" : { 
                    +        "az2***" : "unknown", 
                    +        "az1***" : "normal", 
                    +        "az3***" : "unknown" 
                    +      }, 
                    +      "region_status" : "normal" 
                    +    }, { 
                    +      "vcpus" : "32", 
                    +      "ram" : "128", 
                    +      "spec_code" : "geminidb.cassandra.8xlarge.4", 
                    +      "az_status" : { 
                    +        "az2***" : "unknown", 
                    +        "az1***" : "normal", 
                    +        "az3***" : "unknown" 
                    +      }, 
                    +      "region_status" : "normal" 
                    +    } ], 
                    +    "total_count": 4
                    +  }
                    +}
                    +
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

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

                    Historical APIs

                    +
                    + + diff --git a/docs/geminidb/api-ref/nosql_05_0205.html b/docs/geminidb/api-ref/nosql_05_0205.html new file mode 100644 index 000000000..9ec4cdce4 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0205.html @@ -0,0 +1,18 @@ + + +

                    Parameter Templates

                    +

                    +
                    + + diff --git a/docs/geminidb/api-ref/nosql_05_0211.html b/docs/geminidb/api-ref/nosql_05_0211.html new file mode 100644 index 000000000..3564af653 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0211.html @@ -0,0 +1,413 @@ + + +

                    Querying Backups (Recommended)

                    +

                    Function

                    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.

                    +
                    +

                    URI

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

                    + +
                    + + + + + + + + + + + +
                    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

                    +

                    instance_id

                    +

                    No

                    +

                    String

                    +

                    Instance ID, which can be obtained by calling the API for querying instances. If there are no instances available, create one by calling the API used for creating an instance.

                    +

                    datastore_type

                    +

                    No

                    +

                    String

                    +

                    Database type.

                    +
                    • cassandra
                    +

                    backup_id

                    +

                    No

                    +

                    String

                    +

                    Backup ID.

                    +

                    backup_type

                    +

                    No

                    +

                    String

                    +

                    Backup type, which is case sensitive. The value can be:

                    +
                    • Auto: automated full backup
                    • Manual: manual full backup
                    • If this parameter is not transferred, automated and manual full backups, including table-level backups, are both queried by default.
                    +

                    type

                    +

                    No

                    +

                    String

                    +

                    Backup policy type. The value can be:

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

                    limit

                    +

                    No

                    +

                    Integer

                    +

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

                    +

                    Minimum value: 1

                    +

                    Maximum value: 100

                    +

                    offset

                    +

                    No

                    +

                    Integer

                    +

                    Index offset. The query starts from the next backup creation time indexed by this parameter in a specified project. If offset is set to N, the query starts from the N+1 piece of data. The value must be no less than 0. If this parameter is not transferred, offset is set to 0 by default, which indicates that the query starts from the latest created backup.

                    +

                    Minimum value: 0

                    +

                    begin_time

                    +

                    No

                    +

                    String

                    +

                    Start time of the backup query. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset and the default value is left blank by default.

                    +
                    • When end_time is not empty, begin_time is mandatory.
                    +

                    end_time

                    +

                    No

                    +

                    String

                    +

                    End time of the backup query. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset and the default value is left blank by default.

                    +
                    • When begin_time is not empty, end_time is mandatory.
                    +
                    +
                    +
                    +

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

                    +

                    backups

                    +

                    Array of objects

                    +

                    Backup details. For details, see Table 5.

                    +
                    +
                    + +
                    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                    Table 5 Backup

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    id

                    +

                    String

                    +

                    Backup ID.

                    +

                    description

                    +

                    String

                    +

                    Backup description.

                    +

                    instance_id

                    +

                    String

                    +

                    ID of the instance that the backup is created for.

                    +

                    instance_name

                    +

                    String

                    +

                    Name of the instance that the backup is created for.

                    +

                    datastore

                    +

                    object

                    +

                    DB version information. For details, see Table 6.

                    +

                    name

                    +

                    String

                    +

                    Backup name.

                    +

                    type

                    +

                    String

                    +
                    • Auto: automated full backup
                    • Manual: manual full backup
                    +

                    size

                    +

                    Double

                    +

                    Backup size, in KB.

                    +

                    status

                    +

                    String

                    +

                    Backup status. The value can be:

                    +
                    • BUILDING, indicating that the backup is in progress.
                    • COMPLETED, indicating that the backup is completed.
                    • FAILED, indicating that the backup failed.
                    +

                    begin_time

                    +

                    String

                    +

                    Backup start time. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

                    +

                    end_time

                    +

                    String

                    +

                    Backup end time. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time, and Z indicates the time zone offset.

                    +

                    database_tables

                    +

                    Array of objects

                    +

                    Database and table information in the backup. For details, see Table 7.

                    +
                    • Keep this parameter empty or ignore it when you query an instance backup.
                    • Specify this parameter when you query a database or table backup (if any).
                    +

                    deletable

                    +

                    Boolean

                    +

                    Whether a table can be deleted.

                    +
                    +
                    + +
                    + + + + + + + + + + + + + +
                    Table 6 Datastore

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    type

                    +

                    String

                    +

                    Database type.

                    +

                    version

                    +

                    String

                    +

                    Database version.

                    +
                    +
                    + +
                    + + + + + + + + + + + + + +
                    Table 7 QueryDatabaseTableInfo

                    Parameter

                    +

                    Type

                    +

                    Description

                    +

                    database_name

                    +

                    String

                    +

                    Database name.

                    +

                    table_names

                    +

                    Array of strings

                    +

                    Table names.

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

                    Example Request

                    • URI example
                      GET https://{Endpoint}/v3.1/
                      +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

                    +
                    Successful request
                    { 
                    +  "total_count" : 4, 
                    +  "backups" : [ { 
                    +    "id" : "43e4feaab48f11e89039fa163ebaa7e4br01", 
                    +    "name" : "backup-test", 
                    +    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", 
                    +    "instance_name" : "cluster-test", 
                    +    "datastore" : { 
                    +      "type" : "cassandra", 
                    +      "version" : "3.4" 
                    +    }, 
                    +    "type" : "Auto", 
                    +    "begin_time" : "2019-05-27T03:38:51+0000", 
                    +    "end_time" : "2019-05-27T03:39:51+0000", 
                    +    "status" : "COMPLETED", 
                    +    "size" : 2803, 
                    +    "description" : "backup description", 
                    +    "database_tables" : [ { 
                    +      "database_name" : "DATABASE_X", 
                    +      "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] 
                    +    }, { 
                    +      "database_name" : "DATABASE_Y", 
                    +      "table_names" : null 
                    +    } ] 
                    +    "deletable": null
                    +  }, { 
                    +    "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", 
                    +    "name" : "backup-test-2", 
                    +    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", 
                    +    "instance_name" : "cluster-test", 
                    +    "datastore" : { 
                    +      "type" : "cassandra", 
                    +      "version" : "3.4" 
                    +    }, 
                    +    "type" : "Manual", 
                    +    "begin_time" : "2019-05-27T03:38:51+0000", 
                    +    "end_time" : "2019-05-27T03:39:51+0000", 
                    +    "status" : "COMPLETED", 
                    +    "size" : 2803, 
                    +    "description" : "backup description", 
                    +    "database_tables" : [ { 
                    +      "database_name" : "DATABASE_X", 
                    +      "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] 
                    +    }, { 
                    +      "database_name" : "DATABASE_Y", 
                    +      "table_names" : null 
                    +    } ] 
                    +    "deletable": null
                    +  } ] 
                    +}
                    +
                    +
                    +

                    Status Codes

                    See Status Codes.

                    +
                    +

                    Error Codes

                    See Error Codes.

                    +
                    +
                    +
                    + +
                    + diff --git a/docs/geminidb/api-ref/nosql_06_0002.html b/docs/geminidb/api-ref/nosql_06_0002.html index 9d6bd568b..31e44d089 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 supports GeminiDB Cassandra instances.

                    +

                    Constraints

                    This API can be used for GeminiDB Cassandra instances.

                    URI

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

                    -
                    Table 1 Path parameters

                    Parameter

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

                    Request Parameters

                    -
                    Table 1 URI parameter

                    Parameter

                    Mandatory

                    Integer

                    Index offset.

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

                    @@ -56,7 +56,7 @@

                    Integer

                    Maximum number of instances that can be queried.

                    +

                    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.
                    Table 3 Request header parameters

                    Parameter

                    +
                    @@ -75,7 +75,16 @@ - + + + + + @@ -88,7 +97,7 @@
                    Table 3 Request header parameter

                    Parameter

                    Mandatory

                    X-Auth-Token

                    +

                    Content-Type

                    +

                    Yes

                    +

                    String

                    +

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

                    +

                    X-Auth-Token

                    Yes

                    -

                    Response Parameters

                    Status code: 200

                    +

                    Response Parameters

                    Status code: 200

                    @@ -188,7 +197,6 @@
                    Table 4 Response body parameters

                    Parameter

                    Instance type. The value can be:

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

                    -

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

                    user_defined

                    @@ -203,11 +211,11 @@
                    -

                    Example Requests

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

                    Example Request

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

                    Example Responses

                    Status code: 200

                    -

                    Success

                    +

                    Example Response

                    Status code: 200

                    +

                    Successful request

                    {
                       "count" : 2,
                       "quota": 100,
                    @@ -234,14 +242,14 @@
                       } ]
                     }
                    -

                    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/nosql_06_0003.html b/docs/geminidb/api-ref/nosql_06_0003.html index 5177d7075..9764f3434 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 supports GeminiDB Cassandra instances.

                    +

                    Constraints

                    This API can be used for GeminiDB Cassandra instances.

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

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

                    URI

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

                    -
                    Table 1 Path parameters

                    Parameter

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

                    Request Parameters

                    -
                    Table 1 URI parameter

                    Parameter

                    Mandatory

                    Table 2 Request header parameters

                    Parameter

                    +
                    - - - - - - - + + + + + @@ -123,7 +132,7 @@
                    Table 2 Request header parameter

                    Parameter

                    Mandatory

                    +

                    Mandatory

                    Type

                    +

                    Type

                    Description

                    +

                    Description

                    X-Auth-Token

                    +

                    Content-Type

                    Yes

                    +

                    Yes

                    String

                    +

                    String

                    User token.

                    +

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

                    +

                    X-Auth-Token

                    +

                    Yes

                    +

                    String

                    +

                    User token.

                    String

                    Database type. The value can be:

                    -

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

                    +

                    cassandra: GeminiDB Cassandra instance

                    version

                    @@ -140,9 +149,9 @@
                    -

                    Response Parameters

                    Status code: 200

                    +

                    Response Parameters

                    Status code: 200

                    -
                    Table 5 Response body parameters

                    Parameter

                    +
                    @@ -224,7 +233,7 @@
                    Table 5 Response body parameter

                    Parameter

                    Type

                    -

                    Example Requests

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

                      Example Request

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

                      Example Responses

                      Status code: 200

                      +

                      Example Response

                      Status code: 200

                      Success

                      {
                         "configuration" : {
                      @@ -253,9 +262,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/nosql_06_0004.html b/docs/geminidb/api-ref/nosql_06_0004.html index 0e53dab34..8470c4ab6 100644 --- a/docs/geminidb/api-ref/nosql_06_0004.html +++ b/docs/geminidb/api-ref/nosql_06_0004.html @@ -3,14 +3,14 @@

                      Modifying Parameters in a Parameter Template

                      Function

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

                      -

                      Constraints

                      This API supports GeminiDB Cassandra instances.

                      +

                      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.

                      Default parameter templates cannot be modified.

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

                      -

                      URI

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

                      +

                      URI

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

                      -
                      Table 1 Path parameters

                      Parameter

                      +
                      @@ -43,23 +43,32 @@

                      Request Parameters

                      -
                      Table 1 URI parameters

                      Parameter

                      Mandatory

                      Table 2 Request header parameters

                      Parameter

                      +
                      - - - - - - - + + + + + @@ -107,10 +116,10 @@
                      Table 2 Request header parameter

                      Parameter

                      Mandatory

                      +

                      Mandatory

                      Type

                      +

                      Type

                      Description

                      +

                      Description

                      X-Auth-Token

                      +

                      Content-Type

                      Yes

                      +

                      Yes

                      String

                      +

                      String

                      User token.

                      +

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

                      +

                      X-Auth-Token

                      +

                      Yes

                      +

                      String

                      +

                      User token.

                      -

                      Response Parameters

                      Status code: 200

                      -

                      No response parameters

                      +

                      Response Parameters

                      Status code: 200

                      +

                      None

                      -

                      Example Requests

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

                        Example Request

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

                          {
                          @@ -122,11 +131,11 @@
                           }
                        -

                        Example Responses

                        None

                        +

                        Example Response

                        None

                        -

                        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/nosql_06_0005.html b/docs/geminidb/api-ref/nosql_06_0005.html index 6186dea62..bffc922b1 100644 --- a/docs/geminidb/api-ref/nosql_06_0005.html +++ b/docs/geminidb/api-ref/nosql_06_0005.html @@ -3,12 +3,12 @@

                        Applying a Parameter Template

                        Function

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

                        -

                        Constraints

                        This API supports GeminiDB Cassandra instances.

                        +

                        Constraints

                        This API can be used for GeminiDB Cassandra instances.

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

                        -

                        URI

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

                        +

                        URI

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

                        -
                        Table 1 Path parameters

                        Parameter

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

                        Request Parameters

                        -
                        Table 1 URI parameters

                        Parameter

                        Mandatory

                        Table 2 Request header parameters

                        Parameter

                        +
                        - - - - - - - + + + + +
                        Table 2 Request header parameter

                        Parameter

                        Mandatory

                        +

                        Mandatory

                        Type

                        +

                        Type

                        Description

                        +

                        Description

                        X-Auth-Token

                        +

                        Content-Type

                        Yes

                        +

                        Yes

                        String

                        +

                        String

                        User token.

                        +

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

                        +

                        X-Auth-Token

                        +

                        Yes

                        +

                        String

                        +

                        User token.

                        -
                        Table 3 Request body parameters

                        Parameter

                        +
                        @@ -87,7 +96,7 @@
                        Table 3 Request body parameter

                        Parameter

                        Mandatory

                        -

                        Response Parameters

                        Status code: 200

                        +

                        Response Parameters

                        Status code: 202

                        @@ -109,34 +118,34 @@
                        Table 4 Response body parameters

                        Parameter

                        Boolean

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

                        -
                        • true, indicating the task is successfully submitted.
                        • false, indicating the task fails to be submitted.
                        +
                        • true: The task is successfully submitted.
                        • false: The task failed to be submitted.
                        -

                        Example Requests

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

                          Example Request

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

                          Example Responses

                          Status code: 200

                          +

                          Example Response

                          Status code: 202

                          Success

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

                          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/nosql_06_0006.html b/docs/geminidb/api-ref/nosql_06_0006.html index e4e45883f..2bd5b8cb6 100644 --- a/docs/geminidb/api-ref/nosql_06_0006.html +++ b/docs/geminidb/api-ref/nosql_06_0006.html @@ -3,13 +3,13 @@

                          Modifying Parameters of a Specified Instance

                          Function

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

                          -

                          Constraints

                          This API supports GeminiDB Cassandra instances.

                          +

                          Constraints

                          This API can be used for GeminiDB Cassandra instances.

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

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

                          -

                          URI

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

                          +

                          URI

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

                          -
                          Table 1 Path parameters

                          Parameter

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

                          Request Parameters

                          -
                          Table 1 URI parameters

                          Parameter

                          Mandatory

                          Table 2 Request header parameters

                          Parameter

                          +
                          - - - - - - - + + + + +
                          Table 2 Request header parameter

                          Parameter

                          Mandatory

                          +

                          Mandatory

                          Type

                          +

                          Type

                          Description

                          +

                          Description

                          X-Auth-Token

                          +

                          Content-Type

                          Yes

                          +

                          Yes

                          String

                          +

                          String

                          User token.

                          +

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

                          +

                          X-Auth-Token

                          +

                          Yes

                          +

                          String

                          +

                          User token.

                          -
                          Table 3 Request body parameters

                          Parameter

                          +
                          @@ -88,7 +97,7 @@
                          Table 3 Request body parameter

                          Parameter

                          Mandatory

                          -

                          Response Parameters

                          Status code: 200

                          +

                          Response Parameters

                          Status code: 202

                          @@ -117,7 +126,7 @@
                          Table 4 Response body parameters

                          Parameter

                          -

                          Example Requests

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

                            Example Request

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

                            Example Responses

                            Status code: 200

                            +

                            Example Response

                            Status code: 202

                            Success

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

                            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/nosql_06_0007.html b/docs/geminidb/api-ref/nosql_06_0007.html index c7442f6dc..27d9a6e5a 100644 --- a/docs/geminidb/api-ref/nosql_06_0007.html +++ b/docs/geminidb/api-ref/nosql_06_0007.html @@ -3,11 +3,11 @@

                            Querying Instance Parameter Settings

                            Function

                            This API is used to query instance parameter settings.

                            -

                            Constraints

                            This API supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

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

                            Request Parameters

                            -
                            Table 1 URI parameters

                            Parameter

                            Mandatory

                            Table 2 Request header parameters

                            Parameter

                            +
                            @@ -63,7 +63,7 @@
                            Table 2 Request header parameter

                            Parameter

                            Mandatory

                            -

                            Response Parameters

                            Status code: 200

                            +

                            Response Parameters

                            Status code: 200

                            @@ -116,7 +116,6 @@
                            Table 3 Response body parameters

                            Parameter

                            Instance type. The value can be:

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

                            -

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

                            configuration_parameters

                            @@ -193,10 +192,10 @@
                            -

                            Example Requests

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

                            Example Request

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

                            Example Responses

                            Status code: 200

                            +

                            Example Response

                            Status code: 200

                            Success

                            {
                               "datastore_version_name" : "3.11",
                            @@ -216,9 +215,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/nosql_06_0008.html b/docs/geminidb/api-ref/nosql_06_0008.html index 6b786f038..e9ef2f1a3 100644 --- a/docs/geminidb/api-ref/nosql_06_0008.html +++ b/docs/geminidb/api-ref/nosql_06_0008.html @@ -3,11 +3,11 @@

                            Obtaining Parameters of a Specified Parameter Template

                            Function

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

                            -

                            Constraints

                            This API supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

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

                            Request Parameters

                            -
                            Table 1 URI parameters

                            Parameter

                            Mandatory

                            Table 2 Request header parameters

                            Parameter

                            +
                            @@ -63,7 +63,7 @@
                            Table 2 Request header parameter

                            Parameter

                            Mandatory

                            -

                            Response Parameters

                            Status code: 200

                            +

                            Response Parameters

                            Status code: 200

                            @@ -198,10 +198,10 @@
                            Table 3 Response body parameters

                            Parameter

                            -

                            Example Requests

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

                            Example Request

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

                            Example Responses

                            Status code: 200

                            +

                            Example Response

                            Status code: 200

                            Success

                            {
                               "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605pr06",
                            @@ -222,9 +222,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/nosql_06_0009.html b/docs/geminidb/api-ref/nosql_06_0009.html index 6f8fa236c..a86a383b4 100644 --- a/docs/geminidb/api-ref/nosql_06_0009.html +++ b/docs/geminidb/api-ref/nosql_06_0009.html @@ -3,11 +3,11 @@

                            Deleting a Parameter Template

                            Function

                            This API is used to delete a specified parameter template.

                            -

                            Constraints

                            This API supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

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

                            Request Parameters

                            -
                            Table 1 URI parameters

                            Parameter

                            Mandatory

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

                            Parameter

                            +
                            @@ -64,16 +64,16 @@

                            Response Parameters

                            Status code: 200

                            -

                            No response parameters

                            +

                            None

                            -

                            Example Requests

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

                            Example Request

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

                            Example Responses

                            None

                            +

                            Example Response

                            None

                            -

                            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/nosql_06_0218.html b/docs/geminidb/api-ref/nosql_06_0218.html new file mode 100644 index 000000000..636218c78 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0218.html @@ -0,0 +1,144 @@ + + +

                            Applying a Parameter Template

                            +

                            Function

                            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 Applying a Parameter Template.

                            +
                            +
                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            +

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

                            +
                            +

                            URI

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

                            + +
                            Table 2 Request header parameter

                            Parameter

                            Mandatory

                            + + + + + + + + + + + + + + + + +
                            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

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            instance_ids

                            +

                            Yes

                            +

                            Array of strings

                            +

                            Instance IDs.

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 200

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            job_id

                            +

                            String

                            +

                            ID of an asynchronous task that applies the parameter template

                            +

                            success

                            +

                            Boolean

                            +

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

                            +
                            • true: The task is successfully submitted.
                            • false: The task failed to be submitted.
                            +
                            +
                            +
                            +

                            Example Request

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

                            Example Response

                            Status code: 200

                            +

                            Success

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

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            + +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_06_0219.html b/docs/geminidb/api-ref/nosql_06_0219.html new file mode 100644 index 000000000..5ed98552e --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_0219.html @@ -0,0 +1,147 @@ + + +

                            Modifying Parameters of a Specified Instance

                            +

                            Function

                            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 Parameters of a Specified Instance.

                            +
                            +
                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            +

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

                            +

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

                            +
                            +

                            URI

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

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

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            values

                            +

                            Yes

                            +

                            Map<String,String>

                            +

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

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 200

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            job_id

                            +

                            String

                            +

                            ID of the asynchronous task for modifying instance parameters.

                            +

                            restart_required

                            +

                            Boolean

                            +

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

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

                            Example Request

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

                            Example Response

                            Status code: 200

                            +

                            Success

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

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_06_3001.html b/docs/geminidb/api-ref/nosql_06_3001.html new file mode 100644 index 000000000..359d99b23 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_06_3001.html @@ -0,0 +1,15 @@ + + +

                            Backup and Restoration

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

                            Querying an Automated Backup Policy

                            +

                            Function

                            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 Backup Policy.

                            +
                            +
                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            +
                            +

                            URI

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

                            + +
                            + + + + + + + + + + + + + + + + +
                            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

                            +

                            type

                            +

                            No

                            +

                            String

                            +

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

                            +
                            • Instance: An instance backup is queried.
                            • DatabaseTable: A database or table backup is queried.
                            +
                            +
                            +
                            +

                            Request Parameters

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

                            Parameter

                            +

                            Mandatory

                            +

                            Type

                            +

                            Description

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token

                            +
                            +
                            +
                            +

                            Response Parameters

                            Status code: 202

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            backup_policy

                            +

                            object

                            +

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

                            +

                            database_tables

                            +

                            Array of objects

                            +

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

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            keep_days

                            +

                            Integer

                            +

                            Backup retention days.

                            +

                            differential_period

                            +

                            String

                            +

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

                            +

                            incremental_period

                            +

                            String

                            +

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

                            +

                            start_time

                            +

                            String

                            +

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

                            +

                            period

                            +

                            String

                            +

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

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

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            database_name

                            +

                            String

                            +

                            Database name

                            +

                            table_names

                            +

                            Array of strings

                            +

                            Table names

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

                            Example Request

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

                            Example Response

                            Status code: 202

                            +

                            Success

                            +

                            Response when an automated backup policy is enabled

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

                            Response when an automated backup policy is disabled

                            +
                            
                            +
                            +

                            Status Codes

                            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 1c09222dd..13ced0abd 100644 --- a/docs/geminidb/api-ref/nosql_10_0100.html +++ b/docs/geminidb/api-ref/nosql_10_0100.html @@ -145,7 +145,7 @@

                            jobs

                            Array of objects (Table 5)

                            +

                            Array of objects in Table 5

                            Task list.

                            String

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

                            -

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

                            +

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

                            end_time

                            @@ -203,7 +203,7 @@

                            String

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

                            -

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

                            +

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

                            progress

                            @@ -281,9 +281,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/nosql_12_0005.html b/docs/geminidb/api-ref/nosql_12_0005.html new file mode 100644 index 000000000..b3ebf095d --- /dev/null +++ b/docs/geminidb/api-ref/nosql_12_0005.html @@ -0,0 +1,18 @@ + + + +

                            APIs v3.1

                            + +
                            + + + diff --git a/docs/geminidb/api-ref/nosql_12_0006.html b/docs/geminidb/api-ref/nosql_12_0006.html new file mode 100644 index 000000000..2025f1d0d --- /dev/null +++ b/docs/geminidb/api-ref/nosql_12_0006.html @@ -0,0 +1,18 @@ + + + +

                            Versions and Specifications

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

                            Backup and Restoration

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

                            Parameter Templates

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

                            API v4

                            + +
                            + + + diff --git a/docs/geminidb/api-ref/nosql_12_0013.html b/docs/geminidb/api-ref/nosql_12_0013.html new file mode 100644 index 000000000..4dda68fab --- /dev/null +++ b/docs/geminidb/api-ref/nosql_12_0013.html @@ -0,0 +1,403 @@ + + +

                            Querying Backups

                            +

                            Function

                            This API is used to query backups based on specified conditions.

                            +
                            +

                            URI

                            GET https://{Endpoint}/v4/{project_id}/backups

                            + +
                            + + + + + + + + + + + +
                            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

                            +

                            instance_id

                            +

                            No

                            +

                            String

                            +

                            Instance ID, which can be obtained by calling the API for querying instances. If no instance is available, call the API for creating an instance.

                            +

                            datastore_type

                            +

                            No

                            +

                            String

                            +

                            Database type. The value can be:

                            +
                            • cassandra
                            +

                            backup_id

                            +

                            No

                            +

                            String

                            +

                            Backup ID

                            +

                            backup_type

                            +

                            No

                            +

                            String

                            +

                            Backup type, which is case sensitive. The value can be:

                            +
                            • Auto: automated full backup
                            • Manual: manual full backup
                            • If this parameter is not transferred, all automated and manual backups (including database- and table-level backups) are queried by default.
                            +

                            type

                            +

                            No

                            +

                            String

                            +

                            Backup policy type. The value can be:

                            +
                            • Instance: An instance backup is queried.
                            • DatabaseTable: A database or table backup is queried.
                            • The default value is Instance.
                            +

                            limit

                            +

                            No

                            +

                            Integer

                            +

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

                            +

                            Minimum value: 1

                            +

                            Maximum value: 100

                            +

                            offset

                            +

                            No

                            +

                            Integer

                            +

                            Index position. The query starts from the next backup creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data. The value must be greater than or equal to 0. If this parameter is not transferred, the index offset is 0 by default, indicating that the query starts from the latest created instance.

                            +

                            Minimum value: 0

                            +

                            begin_time

                            +

                            No

                            +

                            String

                            +

                            Start time of the backup query. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset. The default value is left blank by default.

                            +
                            • When end_time is not empty, begin_time is mandatory.
                            +

                            end_time

                            +

                            No

                            +

                            String

                            +

                            End time of the backup query. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset. The default value is left blank by default.

                            +
                            • When begin_time is not empty, end_time is mandatory.
                            +
                            +
                            +
                            +

                            Request Parameters

                            +
                            + + + + + + + + + + + +
                            Table 3 Request header parameter

                            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 backups

                            +

                            backups

                            +

                            Array of objects

                            +

                            Backup details. For details, see Table 5.

                            +
                            +
                            + +
                            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
                            Table 5 Backup

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            id

                            +

                            String

                            +

                            Backup ID

                            +

                            description

                            +

                            String

                            +

                            Backup description

                            +

                            instance_id

                            +

                            String

                            +

                            ID of an instance that a backup is created for

                            +

                            instance_name

                            +

                            String

                            +

                            Name of an instance that a backup is created for

                            +

                            datastore

                            +

                            object

                            +

                            Database version. For details, see Table 6.

                            +

                            name

                            +

                            String

                            +

                            Backup name

                            +

                            type

                            +

                            String

                            +
                            • Auto: automated full backup
                            • Manual: manual full backup
                            +

                            size

                            +

                            Double

                            +

                            Backup size, in KB

                            +

                            status

                            +

                            String

                            +

                            Backup status. The value can be:

                            +
                            • BUILDING: backup in progress
                            • COMPLETED: backup completed
                            • FAILED: backup failed
                            +

                            begin_time

                            +

                            String

                            +

                            Backup start time. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset.

                            +

                            end_time

                            +

                            String

                            +

                            Backup end time. The time point is in the yyyy-mm-ddThh:mm:ssZ format. T indicates the start time. Z indicates the time zone offset.

                            +

                            database_tables

                            +

                            Array of objects

                            +

                            Database and table information in a backup. For details, see Table 7.

                            +
                            • Keep this parameter empty or ignore it when you query an instance backup.
                            • Specify this parameter when you query a database or table backup (if any).
                            +
                            +
                            + +
                            + + + + + + + + + + + + + +
                            Table 6 Datastore

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            type

                            +

                            String

                            +

                            Database type

                            +

                            version

                            +

                            String

                            +

                            Database version

                            +
                            +
                            + +
                            + + + + + + + + + + + + + +
                            Table 7 QueryDatabaseTableInfo

                            Parameter

                            +

                            Type

                            +

                            Description

                            +

                            database_name

                            +

                            String

                            +

                            Database name

                            +

                            table_names

                            +

                            Array of strings

                            +

                            Table names

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

                            Example Request

                            • 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

                            +

                            Success

                            +
                            { 
                            +  "total_count" : 4, 
                            +  "backups" : [ { 
                            +    "id" : "43e4feaab48f11e89039fa163ebaa7e4br01", 
                            +    "name" : "backup-test", 
                            +    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01", 
                            +    "instance_name" : "cluster-test", 
                            +    "datastore" : { 
                            +      "type" : "cassandra", 
                            +      "version" : "3.4" 
                            +    }, 
                            +    "type" : "Auto", 
                            +    "begin_time" : "2019-05-27T03:38:51+0000", 
                            +    "end_time" : "2019-05-27T03:39:51+0000", 
                            +    "status" : "COMPLETED", 
                            +    "size" : 2803, 
                            +    "description" : "backup description", 
                            +    "database_tables" : [ { 
                            +      "database_name" : "DATABASE_X", 
                            +      "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] 
                            +    }, { 
                            +      "database_name" : "DATABASE_Y", 
                            +      "table_names" : null 
                            +    } ] 
                            +  }, { 
                            +    "id" : "43e4feaab48f11e89039fa163ebaa7e4br02", 
                            +    "name" : "backup-test-2", 
                            +    "instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br02", 
                            +    "instance_name" : "cluster-test", 
                            +    "datastore" : { 
                            +      "type" : "cassandra", 
                            +      "version" : "3.4" 
                            +    }, 
                            +    "type" : "Manual", 
                            +    "begin_time" : "2019-05-27T03:38:51+0000", 
                            +    "end_time" : "2019-05-27T03:39:51+0000", 
                            +    "status" : "COMPLETED", 
                            +    "size" : 2803, 
                            +    "description" : "backup description", 
                            +    "database_tables" : [ { 
                            +      "database_name" : "DATABASE_X", 
                            +      "table_names" : [ "TABLE_A", "TABLE_B", "TABLE_C" ] 
                            +    }, { 
                            +      "database_name" : "DATABASE_Y", 
                            +      "table_names" : null 
                            +    } ] 
                            +  } ] 
                            +}
                            +
                            +

                            Status Codes

                            See Status Codes.

                            +
                            +

                            Error Codes

                            See Error Codes.

                            +
                            +
                            +
                            + +
                            + diff --git a/docs/geminidb/api-ref/nosql_api_0030.html b/docs/geminidb/api-ref/nosql_api_0030.html index f8268a48e..f64f217f6 100644 --- a/docs/geminidb/api-ref/nosql_api_0030.html +++ b/docs/geminidb/api-ref/nosql_api_0030.html @@ -3,11 +3,11 @@

                            Querying an Automated Backup Policy

                            Function

                            This API is used to query an automated backup policy.

                            -

                            Constraints

                            This API supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            -

                            URI

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

                            +

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

                            +
                            @@ -43,9 +43,9 @@ - - @@ -53,10 +53,10 @@ - - @@ -64,7 +64,7 @@

                            Request Parameters

                            -
                            Table 1 URI parameters

                            Parameter

                            Mandatory

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            No

                            String

                            +

                            String

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

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

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

                            +
                            • Instance, indicating that an instance backup is queried.
                            • DatabaseTable, indicating that a database or table backup is queried.
                            • The default value is Instance.
                            Table 3 Request header parameters

                            Parameter

                            +
                            @@ -87,9 +87,9 @@
                            Table 3 Request header parameter

                            Parameter

                            Mandatory

                            -

                            Response Parameters

                            Status code: 202

                            +

                            Response Parameters

                            Status code: 200

                            -
                            - - - - - -
                            Table 4 Response body parameters

                            Parameter

                            +
                            @@ -104,14 +104,6 @@ - - - -
                            Table 4 Response body parameter

                            Parameter

                            Type

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

                            database_tables

                            -

                            Array of objects

                            -

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

                            -
                            • Keep this parameter empty or ignore it when you query an instance backup.
                            • Remember to specify this parameter when you query a database or table backup (if any).
                            -
                            @@ -131,18 +123,21 @@

                            Backup retention days.

                            differential_period

                            +

                            differential_period

                            String

                            +

                            String

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

                            +

                            Differential backup interval. Interval for automated differential backups.

                            +

                            Its value can be 30, 60, 180, 360, 720, or 1440.

                            +

                            Unit: minute

                            +

                            Example value: 30

                            incremental_period

                            +

                            incremental_period

                            String

                            +

                            String

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

                            +

                            Incremental backup interval, in minutes. Its value can be 5, 10, or 15.

                            start_time

                            @@ -162,67 +157,33 @@
                            - -
                            - - - - - - - - - - - - - -
                            Table 6 QueryDatabaseTableInfo

                            Parameter

                            -

                            Type

                            -

                            Description

                            -

                            database_name

                            -

                            String

                            -

                            Database name.

                            -

                            table_names

                            -

                            Array of strings

                            -

                            Table names.

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

                            Example Request

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

                            Example Requests

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

                            Example Responses

                            Status code: 202

                            -

                            Success

                            +

                            Example Response

                            Status code: 200

                            +

                            Successful request

                            Response when an automated backup policy is enabled

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

                            Response when an automated backup policy is disabled

                            
                             
                            -

                            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/nosql_api_0031.html b/docs/geminidb/api-ref/nosql_api_0031.html index f40ebfd59..132dcf38e 100644 --- a/docs/geminidb/api-ref/nosql_api_0031.html +++ b/docs/geminidb/api-ref/nosql_api_0031.html @@ -3,11 +3,11 @@

                            Configuring an Automated Backup Policy

                            Function

                            This API is used to configuring an automated backup policy.

                            -

                            Constraints

                            This API supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

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

                            Request Parameters

                            -
                            Table 1 URI parameters

                            Parameter

                            Mandatory

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

                            Parameter

                            +
                            - - - - - - - + + + + +
                            Table 2 Request header parameter

                            Parameter

                            Mandatory

                            +

                            Mandatory

                            Type

                            +

                            Type

                            Description

                            +

                            Description

                            X-Auth-Token

                            +

                            Content-Type

                            Yes

                            +

                            Yes

                            String

                            +

                            String

                            User token.

                            +

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

                            +

                            X-Auth-Token

                            +

                            Yes

                            +

                            String

                            +

                            User token.

                            -
                            Table 3 Request body parameters

                            Parameter

                            +
                            @@ -82,16 +91,6 @@ - - - - -
                            Table 3 Request body parameter

                            Parameter

                            Mandatory

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

                            database_tables

                            -

                            No

                            -

                            Array of objects

                            -

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

                            -
                            • If this parameter is empty, an automated backup policy for an instance is set.
                            • If this parameter is not empty, an automated backup policy for a databases or table is set.
                            -
                            @@ -141,58 +140,18 @@
                            - -
                            - - - - - - - - - - - - - - - - -
                            Table 5 PutDatabaseTablePolicy

                            Parameter

                            -

                            Mandatory

                            -

                            Type

                            -

                            Description

                            -

                            database_name

                            -

                            Yes

                            -

                            String

                            -

                            Database name.

                            -

                            table_names

                            -

                            No

                            -

                            Array of strings

                            -

                            Table names.

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

                            Response Parameters

                            Status code: 204

                            +

                            None

                            -

                            Response Parameters

                            Status code: 204

                            -

                            No response parameters

                            -
                            -

                            Example Requests

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

                              Example Request

                              • 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" : {
                                     "keep_days" : 7,
                                     "start_time" : "01:00-02:00",
                                     "period" : "1,2,3,4,5,6"
                                -  },
                                -   "database_tables" : [ { 
                                -     "database_name" : "databaseNameA", 
                                -     "table_names" : [ "table_A", "table_B" ] 
                                -   }, { 
                                -     "database_name" : "databaseNameB", 
                                -     "table_names" : null 
                                -   } ] 
                                +  }
                                 }

                                Disabling automated backup

                                {
                                @@ -202,13 +161,13 @@
                                 }
                              -

                              Example Responses

                              Status code: 204

                              +

                              Example Response

                              Status code: 204

                              No Content

                              { }
                              -

                              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/nosql_api_0032.html b/docs/geminidb/api-ref/nosql_api_0032.html new file mode 100644 index 000000000..546784ca3 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_api_0032.html @@ -0,0 +1,162 @@ + + +

                              Creating a Manual Backup

                              +

                              Function

                              This API is used to create a manual backup.

                              +
                              +

                              Constraints

                              This API supports the following instance type:

                              +
                              • GeminiDB Cassandra
                              +
                              +

                              URI

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

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

                              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

                              +

                              Manual backup name.

                              +

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

                              +

                              description

                              +

                              Yes

                              +

                              String

                              +

                              Manual backup description.

                              +

                              The description can include a maximum of 256 characters and cannot contain the following special characters: >!<"&'=

                              +
                              +
                              +
                              +

                              Response Parameters

                              Status code: 202

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

                              Parameter

                              +

                              Type

                              +

                              Description

                              +

                              job_id

                              +

                              String

                              +

                              Task ID.

                              +

                              backup_id

                              +

                              String

                              +

                              Backup ID.

                              +
                              +
                              +
                              +

                              Example Request

                              • 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

                              +

                              Success

                              +
                              { 
                              +  "job_id" : "8061ceaf-b319-4315-9338-7f3de8e26f05", 
                              +  "backup_id" : "646d88d0b03f4fd2ae944ae2a33bcb6ain06" 
                              +}
                              +
                              +

                              Status Codes

                              See Status Codes.

                              +
                              +

                              Error Codes

                              See Error Codes.

                              +
                              +
                              +
                              + +
                              + diff --git a/docs/geminidb/api-ref/nosql_change_history02.html b/docs/geminidb/api-ref/nosql_change_history02.html index 3306282d2..1a6d8af57 100644 --- a/docs/geminidb/api-ref/nosql_change_history02.html +++ b/docs/geminidb/api-ref/nosql_change_history02.html @@ -8,7 +8,22 @@

                            2023-08-10

                            +

                            2025-02-28

                            +

                            Added APIs v3.1 in:

                            +

                            Querying an Automated Backup Policy, Applying a Parameter Template, and Modifying Parameters of a Specified Instance

                            +

                            Added APIs v3 in:

                            +

                            Creating a Manual Backup, Querying an Automated Backup Policy, Applying a Parameter Template, and Modifying Parameters of a Specified Instance

                            +

                            2024-08-30

                            +

                            Added functions for GeminiDB Cassandra instances:

                            +

                            Configuring an Autoscaling Policy for Storage Space

                            +

                            Querying the Autoscaling Policy of Storage Space

                            +

                            2023-08-10

                            This issue is the third official release.

                            Updated status codes in Deleting an Instance.

                            diff --git a/docs/geminidb/api-ref/nosql_database_version.html b/docs/geminidb/api-ref/nosql_database_version.html index 7798c7557..f6d49189c 100644 --- a/docs/geminidb/api-ref/nosql_database_version.html +++ b/docs/geminidb/api-ref/nosql_database_version.html @@ -3,11 +3,11 @@

                            Querying Version Information

                            Function

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

                            -

                            Constraints

                            This API supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

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

                            Request Parameters

                            -
                            Table 1 URI parameters

                            Parameter

                            Mandatory

                            Table 2 Request header parameters

                            Parameter

                            +
                            @@ -64,9 +64,9 @@
                            Table 2 Request header parameter

                            Parameter

                            Mandatory

                            -

                            Response Parameters

                            Status code: 200

                            +

                            Response Parameters

                            Status code: 200

                            -
                            Table 3 Response body parameters

                            Parameter

                            +
                            @@ -86,18 +86,18 @@
                            Table 3 Response body parameter

                            Parameter

                            Type

                            -

                            Example Requests

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

                            Example Request

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

                            Example Responses

                            Status code: 200

                            +

                            Example Response

                            Status code: 200

                            Success

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

                            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/nosql_instance_specification.html b/docs/geminidb/api-ref/nosql_instance_specification.html index b8f1b5482..a19a5cc86 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 supports GeminiDB Cassandra instances.

                            +

                            Constraints

                            This API can be used for GeminiDB Cassandra instances.

                            URI

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

                            -
                            Table 1 Path parameters

                            Parameter

                            +
                            @@ -46,8 +46,8 @@ - @@ -75,7 +75,7 @@

                            Request Parameters

                            -
                            Table 1 URI parameter

                            Parameter

                            Mandatory

                            String

                            Database type. The value can be:

                            -
                            • cassandra, indicating that the instances are of the GeminiDB Cassandra type.
                            • If this parameter is not transferred, the default value is cassandra.
                            +

                            Database type.

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

                            offset

                            @@ -57,7 +57,7 @@

                            Integer

                            Index offset.

                            -
                            • If offset is set to N, the resource query starts from the N+1 piece of data. If action is set to filter, offset is 0 by default, indicating that the query starts from the first piece of data.
                            • The offset value must be a number but cannot be a negative number.
                            +
                            • 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

                            @@ -67,7 +67,7 @@

                            Integer

                            Maximum of specifications that can be queried

                            -
                            • The value ranges from 1 to 100.
                            • If this parameter is not transferred, the first 100 pieces of specification information is queried by default.
                            +
                            • The value ranges from 1 to 100.
                            • If this parameter is not transferred, the first 100 pieces of specification information can be queried by default.
                            Table 3 Request header parameters

                            Parameter

                            +
                            @@ -98,7 +98,7 @@
                            Table 3 Request header parameter

                            Parameter

                            Mandatory

                            -

                            Response Parameters

                            Status code: 200

                            +

                            Response Parameters

                            Status code: 200

                            @@ -152,14 +152,14 @@ - -
                            Table 4 Response body parameters

                            Parameter

                            String

                            Number of vCPUs

                            +

                            CPU cores

                            ram

                            String

                            Memory size in megabytes (MB)

                            +

                            Memory size (MB)

                            spec_code

                            @@ -193,11 +193,11 @@
                            -

                            Example Requests

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

                            Example Request

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

                            Example Responses

                            Status code: 200

                            -

                            Success

                            +

                            Example Response

                            Status code: 200

                            +

                            Successful request

                            {
                               "total_count" : 4,
                               "flavors" : [ {
                            @@ -247,14 +247,14 @@
                               } ]
                             }
                            -

                            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/nosql_metrics.html b/docs/geminidb/api-ref/nosql_metrics.html index fe903812a..03863e9ff 100644 --- a/docs/geminidb/api-ref/nosql_metrics.html +++ b/docs/geminidb/api-ref/nosql_metrics.html @@ -5,565 +5,565 @@

                            Namespace

                            SYS.NoSQL

                            -

                            GeminiDB Cassandra Metrics

                            -
                            Table 1 GeminiDB Cassandra metrics

                            Metric ID

                            +

                            GeminiDB Cassandra Instance Metrics

                            +
                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/geminidb/api-ref/nosql_projectid.html b/docs/geminidb/api-ref/nosql_projectid.html index 25086eda6..4fabe8aff 100644 --- a/docs/geminidb/api-ref/nosql_projectid.html +++ b/docs/geminidb/api-ref/nosql_projectid.html @@ -33,7 +33,7 @@ }

                            Obtaining a Project ID from the Console

                            1. Sign up and log in to the management console.
                            2. Move your pointer over the username and select My Credentials in the displayed drop-down list.

                              On the Projects tab page, view project IDs.

                              -
                              Figure 1 Viewing project IDs
                              +
                              Figure 1 Viewing project IDs
                            @@ -43,3 +43,10 @@ + + \ No newline at end of file diff --git a/docs/geminidb/api-ref/public_sys-resources/imageclose.gif b/docs/geminidb/api-ref/public_sys-resources/imageclose.gif new file mode 100644 index 000000000..3a3344af4 Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/imageclose.gif differ diff --git a/docs/geminidb/api-ref/public_sys-resources/imageclosehover.gif b/docs/geminidb/api-ref/public_sys-resources/imageclosehover.gif new file mode 100644 index 000000000..8699d5e36 Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/imageclosehover.gif differ diff --git a/docs/geminidb/api-ref/public_sys-resources/imagemax.gif b/docs/geminidb/api-ref/public_sys-resources/imagemax.gif new file mode 100644 index 000000000..99c07dc25 Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/imagemax.gif differ diff --git a/docs/geminidb/api-ref/public_sys-resources/imagemaxhover.gif b/docs/geminidb/api-ref/public_sys-resources/imagemaxhover.gif new file mode 100644 index 000000000..d01d77d6e Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/imagemaxhover.gif differ diff --git a/docs/geminidb/api-ref/public_sys-resources/macFFBgHack.png b/docs/geminidb/api-ref/public_sys-resources/macFFBgHack.png new file mode 100644 index 000000000..ec811470c Binary files /dev/null and b/docs/geminidb/api-ref/public_sys-resources/macFFBgHack.png differ diff --git a/docs/geminidb/api-ref/topic_300000001.html b/docs/geminidb/api-ref/topic_300000001.html index 6e20048c6..f768b7566 100644 --- a/docs/geminidb/api-ref/topic_300000001.html +++ b/docs/geminidb/api-ref/topic_300000001.html @@ -6,8 +6,6 @@
                            Table 1 GeminiDB Cassandra instance metrics

                            Metric ID

                            Name

                            +

                            Metric Name

                            Description

                            +

                            Description

                            Value Range

                            +

                            Value Range

                            Monitored Object

                            +

                            Monitored Object

                            Monitoring Period (Raw Data)

                            +

                            Monitoring Period (Raw Data)

                            nosql005_disk_usage

                            +

                            nosql005_disk_usage

                            Storage Space Usage

                            +

                            Storage Space Usage

                            Storage space usage of the monitored object.

                            +

                            Storage space usage of the monitored object.

                            Unit: Percent

                            0–100

                            +

                            0–100

                            GeminiDB Cassandra instances

                            +

                            GeminiDB Cassandra instances

                            1 minute

                            +

                            1 minute

                            nosql006_disk_total_size

                            +

                            nosql006_disk_total_size

                            Total Storage Space

                            +

                            Total Storage Space

                            Total storage space of the monitored object.

                            +

                            Total storage space of the monitored object.

                            Unit: GB

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instances

                            +

                            GeminiDB Cassandra instances

                            1 minute

                            +

                            1 minute

                            nosql007_disk_used_size

                            +

                            nosql007_disk_used_size

                            Used Storage Space

                            +

                            Used Storage Space

                            Used storage space of the monitored object.

                            +

                            Used storage space of the monitored object.

                            Unit: GB

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instances

                            +

                            GeminiDB Cassandra instances

                            1 minute

                            +

                            1 minute

                            nosql009_dfv_write_delay

                            +

                            nosql009_dfv_write_delay

                            Storage Write Latency

                            +

                            Storage Write Latency

                            Average delay of writing data to the storage layer in a specified period

                            +

                            Average latency of writing data to the storage layer in a specified period of time

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            nosql010_dfv_read_delay

                            +

                            nosql010_dfv_read_delay

                            Storage Read Latency

                            +

                            Storage Read Delay

                            Average latency of reading data from the storage layer in a specified period

                            +

                            Average delay of reading data from the storage layer in a specified period

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra001_cpu_usage

                            +

                            cassandra001_cpu_usage

                            CPU Usage

                            +

                            CPU Usage

                            CPU usage of an instance

                            +

                            CPU usage of an instance

                            Unit: Percent

                            0–100

                            +

                            0–100

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra002_mem_usage

                            +

                            cassandra002_mem_usage

                            Memory Usage

                            +

                            Memory Usage

                            Memory usage of the instance

                            +

                            Memory usage of an instance

                            Unit: Percent

                            0–100

                            +

                            0–100

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra003_bytes_out

                            +

                            cassandra003_bytes_out

                            Network Output Throughput

                            +

                            Network Output Throughput

                            Outgoing traffic in bytes per second

                            +

                            Outgoing traffic in bytes per second

                            Unit: byte/s

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra004_bytes_in

                            +

                            cassandra004_bytes_in

                            Network Input Throughput

                            +

                            Network Input Throughput

                            Incoming traffic in bytes per second

                            +

                            Incoming traffic in bytes per second

                            Unit: byte/s

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra014_connections

                            +

                            cassandra014_connections

                            Active Node Connections

                            +

                            Active Connections

                            Total number of connections attempting to connect to Cassandra instance nodes

                            +

                            Active connections to the current GeminiDB Cassandra instance node

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra015_read_latency

                            +

                            cassandra015_read_latency

                            Average Read Latency

                            +

                            Average Read Latency

                            Average amount of time consumed by read requests

                            +

                            Average latency of database reads

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra016_write_latency

                            +

                            cassandra016_write_latency

                            Average Write Latency

                            +

                            Average Write Latency

                            Average amount of time consumed by write requests

                            +

                            Average latency of database writes

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra037_pending_write

                            +

                            cassandra037_pending_write

                            Suspended Write Tasks

                            +

                            Suspended Write Tasks

                            Number of write tasks in waiting status

                            +

                            Number of write tasks waiting in the queue

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra038_pending_read

                            +

                            cassandra038_pending_read

                            Suspended Read Tasks

                            +

                            Suspended Read Tasks

                            Number of read tasks in waiting status

                            +

                            Read tasks in the waiting status

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra044_range_slice_latency

                            +

                            cassandra044_range_slice_latency

                            Scan Duration

                            +

                            Scan Duration

                            Average amount of time consumed by scan operations

                            +

                            Average scan duration

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra049_dropped_mutation

                            +

                            cassandra049_dropped_mutation

                            Dropped Writes

                            +

                            Dropped Writes

                            Average number of dropped writes

                            +

                            Average number of dropped writes

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra052_dropped_read

                            +

                            cassandra052_dropped_read

                            Dropped Reads

                            +

                            Dropped Reads

                            Average number of dropped reads

                            +

                            Average number of dropped reads

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra092_load_info

                            +

                            cassandra092_load_info

                            Data Volume on a Node

                            +

                            Data Volume on a Node

                            Data volume on a node

                            +

                            Data volume on a node

                            Unit: byte

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra093_write_count_latency

                            +

                            cassandra093_write_count_latency

                            Accumulated Write Requests

                            +

                            Accumulated Write Requests

                            Total number of write requests initiated by a node

                            +

                            Total write requests initiated by a node

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra094_write_1min_rate

                            +

                            cassandra094_write_1min_rate

                            Average Write Rate in the Last Minute

                            +

                            Average Write Rate in the Last Minute

                            Average write rate in the last minute

                            +

                            Average write rate in the last minute

                            Unit: count/s

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra095_write_p75_latency

                            +

                            cassandra095_write_p75_latency

                            p75 Write Latency

                            +

                            p75 Write Latency

                            p75 write latency

                            +

                            Given latency that 75% of write requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra096_write_p95_latency

                            +

                            cassandra096_write_p95_latency

                            p95 Write Latency

                            +

                            p95 Write Latency

                            p95 write latency

                            +

                            Given latency that 95% of write requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra097_write_p99_latency

                            +

                            cassandra097_write_p99_latency

                            p99 Write Latency

                            +

                            p99 Write Latency

                            p99 write latency

                            +

                            Given latency that 99% of write requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra098_read_count_latency

                            +

                            cassandra098_read_count_latency

                            Accumulated Read Requests

                            +

                            Accumulated Read Requests

                            Total number of read requests initiated by a node

                            +

                            Total read requests initiated by a node

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra099_read_1min_rate

                            +

                            cassandra099_read_1min_rate

                            Average Read Rate in the Last Minute

                            +

                            Average Read Rate in the Last Minute

                            Average read rate in the last minute

                            +

                            Average read rate in the last minute

                            Unit: count/s

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra100_read_p75_latency

                            +

                            cassandra100_read_p75_latency

                            p75 Read Latency

                            +

                            p75 Read Latency

                            p75 read latency

                            +

                            Given latency that 75% of read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra101_read_p95_latency

                            +

                            cassandra101_read_p95_latency

                            p95 Read Latency

                            +

                            p95 Read Latency

                            p95 read latency

                            +

                            Given latency that 95% of read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra102_read_p99_latency

                            +

                            cassandra102_read_p99_latency

                            p99 Read Latency

                            +

                            p99 Read Latency

                            p99 read latency

                            +

                            Given latency that 99% of read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra103_range_slice_count_latency

                            +

                            cassandra103_range_slice_count_latency

                            Accumulated Range Read Requests

                            +

                            Accumulated Range Read Requests

                            Accumulated range read requests

                            +

                            Accumulated range read requests

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra104_range_slice_1min_rate

                            +

                            cassandra104_range_slice_1min_rate

                            Average Range Read Rate in the Last Minute

                            +

                            Average Range Read Rate in the Last Minute

                            Average range read rate in the last minute

                            +

                            Average range read rate in the last minute

                            Unit: count/s

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra105_range_slice_p75_latency

                            +

                            cassandra105_range_slice_p75_latency

                            p75 Range Read Latency

                            +

                            p75 Range Read Latency

                            p75 range read latency

                            +

                            Given latency that 75% of range read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra106_range_slice_p95_latency

                            +

                            cassandra106_range_slice_p95_latency

                            p95 Range Read Latency

                            +

                            p95 Range Read Latency

                            p95 range read latency

                            +

                            Given latency that 95% of range read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra107_range_slice_p99_latency

                            +

                            cassandra107_range_slice_p99_latency

                            p99 Range Read Latency

                            +

                            p99 Range Read Latency

                            p99 range read latency

                            +

                            Given latency that 99% of range read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra163_write_p999_latency

                            +

                            cassandra163_write_p999_latency

                            p999 Write Latency

                            +

                            p999 Write Latency

                            p999 write latency

                            +

                            Given latency that 99.9% of write requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra164_read_p999_latency

                            +

                            cassandra164_read_p999_latency

                            p999 Read Latency

                            +

                            p999 Read Latency

                            p999 read latency

                            +

                            Given latency that 99.9% of read requests are faster than

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra165_large_partition_num

                            +

                            cassandra165_large_partition_num

                            Big Keys

                            +

                            Big Keys

                            Number of big keys on the current node

                            +

                            Number of big keys on the current node

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra166_write_max_latency

                            +

                            cassandra166_write_max_latency

                            Maximum Write Latency

                            +

                            Maximum Write Latency

                            Maximum write latency

                            +

                            Maximum write latency

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra167_read_max_latency

                            +

                            cassandra167_read_max_latency

                            Maximum Read Latency

                            +

                            Maximum Read Latency

                            Maximum read latency

                            +

                            Maximum read latency

                            Unit: ms

                            ≥ 0

                            +

                            ≥ 0 ms

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute

                            cassandra168_imbalance_table_num

                            +

                            cassandra168_imbalance_table_num

                            Tables with Uneven Data Distribution

                            +

                            Tables with Uneven Data Distribution

                            Number of tables in which data is not evenly distributed.

                            +

                            Number of tables in which data is not evenly distributed

                            Unit: count

                            ≥ 0

                            +

                            ≥ 0

                            GeminiDB Cassandra instance nodes

                            +

                            GeminiDB Cassandra instance nodes

                            1 minute

                            +

                            1 minute