From ec98136450bc3fc3c2d2cba2436f3e77fb237bf9 Mon Sep 17 00:00:00 2001 From: "Ru, Li Yi" Date: Wed, 9 Oct 2024 13:05:44 +0000 Subject: [PATCH] geminidb_api_20240905 Reviewed-by: Boka, Ladislav Co-authored-by: Ru, Li Yi Co-committed-by: Ru, Li Yi --- docs/geminidb/api-ref/ALL_META.TXT.json | 434 ++++++++++-------- docs/geminidb/api-ref/BatchTagAction.html | 4 +- docs/geminidb/api-ref/CLASS.TXT.json | 124 ++--- docs/geminidb/api-ref/ListSlowLogs.html | 2 +- docs/geminidb/api-ref/nosql_05_0005.html | 2 +- docs/geminidb/api-ref/nosql_05_0014.html | 2 +- docs/geminidb/api-ref/nosql_05_0109.html | 189 ++++++++ docs/geminidb/api-ref/nosql_05_0115.html | 147 ++++++ ...00001404778285.html => nosql_12_0004.html} | 2 +- .../api-ref/nosql_change_history02.html | 2 +- docs/geminidb/api-ref/nosql_error_code.html | 2 +- docs/geminidb/api-ref/topic_300000000.html | 2 +- docs/geminidb/api-ref/topic_300000001.html | 2 +- docs/geminidb/api-ref/topic_300000002.html | 6 +- docs/geminidb/api-ref/topic_300000003.html | 2 +- docs/geminidb/api-ref/topic_300000004.html | 2 +- docs/geminidb/api-ref/topic_300000005.html | 2 +- docs/geminidb/api-ref/topic_300000006.html | 2 +- docs/geminidb/api-ref/topic_300000007.html | 2 +- docs/geminidb/api-ref/topic_300000016.html | 2 +- 20 files changed, 666 insertions(+), 266 deletions(-) create mode 100644 docs/geminidb/api-ref/nosql_05_0109.html create mode 100644 docs/geminidb/api-ref/nosql_05_0115.html rename docs/geminidb/api-ref/{en-us_topic_0000001404778285.html => nosql_12_0004.html} (92%) diff --git a/docs/geminidb/api-ref/ALL_META.TXT.json b/docs/geminidb/api-ref/ALL_META.TXT.json index bebd18c3..b3cec769 100644 --- a/docs/geminidb/api-ref/ALL_META.TXT.json +++ b/docs/geminidb/api-ref/ALL_META.TXT.json @@ -1,6 +1,6 @@ [ { - "dockw":"" + "dockw":"API Reference" }, { "uri":"nosql_api_reference.html", @@ -14,8 +14,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -30,13 +30,13 @@ "code":"2", "des":"Welcome to GeminiDB API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on GeminiDB, such as creating, delet", "doc_type":"api", - "kw":"Overview,Before You Start", + "kw":"Overview,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -51,13 +51,13 @@ "code":"3", "des":"GeminiDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", "doc_type":"api", - "kw":"API Calling,Before You Start", + "kw":"API Calling,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -72,13 +72,13 @@ "code":"4", "des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.", "doc_type":"api", - "kw":"Endpoints,Before You Start", + "kw":"Endpoints,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -93,13 +93,13 @@ "code":"5", "des":"For more constraints, see the description of each API.", "doc_type":"api", - "kw":"Constraints,Before You Start", + "kw":"Constraints,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -114,13 +114,13 @@ "code":"6", "des":"AccountA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user ", "doc_type":"api", - "kw":"Concepts,Before You Start", + "kw":"Concepts,Before You Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -135,13 +135,13 @@ "code":"7", "des":"GeminiDB provides extended APIs. These APIs enable you to use some functions of GeminiDB.", "doc_type":"api", - "kw":"API Overview", + "kw":"API Overview,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -161,8 +161,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -177,13 +177,13 @@ "code":"9", "des":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is us", "doc_type":"api", - "kw":"Making an API Request,Calling APIs", + "kw":"Making an API Request,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -198,13 +198,13 @@ "code":"10", "des":"GeminiDB supports token-based authentication.The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.A t", "doc_type":"api", - "kw":"Authentication,Calling APIs", + "kw":"Authentication,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -219,13 +219,13 @@ "code":"11", "des":"After you send a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits ranging from 1xx to ", "doc_type":"api", - "kw":"Returned Values,Calling APIs", + "kw":"Returned Values,Calling APIs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -240,13 +240,13 @@ "code":"12", "des":"This section describes how to create a GeminiDB Cassandra instance by calling APIs.The token obtained from IAM is valid for only 24 hours. If you want to use a token for ", "doc_type":"api", - "kw":"Quick Start", + "kw":"Quick Start,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -255,8 +255,8 @@ "githuburl":"" }, { - "uri":"en-us_topic_0000001404778285.html", - "node_id":"en-us_topic_0000001404778285.xml", + "uri":"nosql_12_0004.html", + "node_id":"nosql_12_0004.xml", "product_code":"nosql", "code":"13", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -266,8 +266,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -287,8 +287,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -303,13 +303,13 @@ "code":"15", "des":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ", "doc_type":"api", - "kw":"Querying API Versions,API Versions", + "kw":"Querying API Versions,API Versions,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -324,13 +324,13 @@ "code":"16", "des":"This API is used to query version information of a specified API.GET https://{Endpoint}/{versionId}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 20", "doc_type":"api", - "kw":"Querying Version Information of an API,API Versions", + "kw":"Querying Version Information of an API,API Versions,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -350,8 +350,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -366,13 +366,13 @@ "code":"18", "des":"This API is used to query version information of a specified type of instances.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/datas", "doc_type":"api", - "kw":"Querying Version Information,Versions and Specifications", + "kw":"Querying Version Information,Versions and Specifications,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -387,13 +387,13 @@ "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", + "kw":"Querying Instance Specifications,Versions and Specifications,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -413,8 +413,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -429,13 +429,13 @@ "code":"21", "des":"This API can be used to create an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instancesStatus code: 202URI examplePOST", "doc_type":"api", - "kw":"Creating an Instance,Instances", + "kw":"Creating an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -450,13 +450,13 @@ "code":"22", "des":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This", "doc_type":"api", - "kw":"Deleting an Instance,Instances", + "kw":"Deleting an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -471,13 +471,13 @@ "code":"23", "des":"This API is used to query instances and details based on specified conditions.This API supports GeminiDB Cassandra instances.GET https://{Endpoint}/v3/{project_id}/instan", "doc_type":"api", - "kw":"Querying Instances and Details,Instances", + "kw":"Querying Instances and Details,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -492,13 +492,13 @@ "code":"24", "des":"This API is used to scale up storage space of an instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/e", "doc_type":"api", - "kw":"Scaling Up Storage Space of an Instance,Instances", + "kw":"Scaling Up Storage Space of an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -513,13 +513,13 @@ "code":"25", "des":"This API is used to add nodes for a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enla", "doc_type":"api", - "kw":"Adding Nodes for an Instance,Instances", + "kw":"Adding Nodes for an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -534,13 +534,13 @@ "code":"26", "des":"This API is used to delete nodes from a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/", "doc_type":"api", - "kw":"Deleting Nodes from a Specified Instance,Instances", + "kw":"Deleting Nodes from a Specified Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -555,13 +555,13 @@ "code":"27", "des":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ", "doc_type":"api", - "kw":"Changing Specifications of an Instance,Instances", + "kw":"Changing Specifications of an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -576,13 +576,13 @@ "code":"28", "des":"This API is used to reset the administrator password of an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.Only t", "doc_type":"api", - "kw":"Resetting the Administrator Password of an Instance,Instances", + "kw":"Resetting the Administrator Password of an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -597,13 +597,13 @@ "code":"29", "des":"This API is used to edit the name of an instance.This API supports GeminiDB Cassandra instances.The name of the instance that is being created or fails to be created cann", "doc_type":"api", - "kw":"Editing the Name of an Instance,Instances", + "kw":"Editing the Name of an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -618,13 +618,13 @@ "code":"30", "des":"This API is used to change the security group associated with an instance.This API supports GeminiDB Cassandra instances.Abnormal instances do not support this operation.", "doc_type":"api", - "kw":"Changing the Security Group of an Instance,Instances", + "kw":"Changing the Security Group of an Instance,Instances,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -632,11 +632,53 @@ "title":"Changing the Security Group of an Instance", "githuburl":"" }, + { + "uri":"nosql_05_0109.html", + "node_id":"nosql_05_0109.xml", + "product_code":"nosql", + "code":"31", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Configuring an Autoscaling Policy for Storage Space", + "githuburl":"" + }, + { + "uri":"nosql_05_0115.html", + "node_id":"nosql_05_0115.xml", + "product_code":"nosql", + "code":"32", + "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", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", + "prodname":"nosql", + "opensource":"true" + } + ], + "title":"Querying the Autoscaling Policy of Storage Space", + "githuburl":"" + }, { "uri":"topic_300000003.html", "node_id":"topic_300000003.xml", "product_code":"nosql", - "code":"31", + "code":"33", "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", @@ -644,8 +686,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -657,16 +699,16 @@ "uri":"nosql_api_0030.html", "node_id":"nosql_api_0030.xml", "product_code":"nosql", - "code":"32", + "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", + "kw":"Querying an Automated Backup Policy,Backups and Restorations,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -678,16 +720,16 @@ "uri":"nosql_api_0031.html", "node_id":"nosql_api_0031.xml", "product_code":"nosql", - "code":"33", + "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", "doc_type":"api", - "kw":"Configuring an Automated Backup Policy,Backups and Restorations", + "kw":"Configuring an Automated Backup Policy,Backups and Restorations,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -699,7 +741,7 @@ "uri":"topic_300000004.html", "node_id":"topic_300000004.xml", "product_code":"nosql", - "code":"34", + "code":"36", "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", @@ -707,8 +749,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -720,16 +762,16 @@ "uri":"nosql_06_0002.html", "node_id":"nosql_06_0002.xml", "product_code":"nosql", - "code":"35", + "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", + "kw":"Obtaining Parameter Templates,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -741,16 +783,16 @@ "uri":"nosql_06_0003.html", "node_id":"nosql_06_0003.xml", "product_code":"nosql", - "code":"36", + "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", "doc_type":"api", - "kw":"Creating a Parameter Template,Parameter Templates", + "kw":"Creating a Parameter Template,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -762,16 +804,16 @@ "uri":"nosql_06_0004.html", "node_id":"nosql_06_0004.xml", "product_code":"nosql", - "code":"37", + "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", "doc_type":"api", - "kw":"Modifying Parameters in a Parameter Template,Parameter Templates", + "kw":"Modifying Parameters in a Parameter Template,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -783,16 +825,16 @@ "uri":"nosql_06_0005.html", "node_id":"nosql_06_0005.xml", "product_code":"nosql", - "code":"38", + "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", + "kw":"Applying a Parameter Template,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -804,16 +846,16 @@ "uri":"nosql_06_0006.html", "node_id":"nosql_06_0006.xml", "product_code":"nosql", - "code":"39", + "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", + "kw":"Modifying Parameters of a Specified Instance,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -825,16 +867,16 @@ "uri":"nosql_06_0007.html", "node_id":"nosql_06_0007.xml", "product_code":"nosql", - "code":"40", + "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", "doc_type":"api", - "kw":"Querying Instance Parameter Settings,Parameter Templates", + "kw":"Querying Instance Parameter Settings,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -846,16 +888,16 @@ "uri":"nosql_06_0008.html", "node_id":"nosql_06_0008.xml", "product_code":"nosql", - "code":"41", + "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", "doc_type":"api", - "kw":"Obtaining Parameters of a Specified Parameter Template,Parameter Templates", + "kw":"Obtaining Parameters of a Specified Parameter Template,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -867,16 +909,16 @@ "uri":"nosql_06_0009.html", "node_id":"nosql_06_0009.xml", "product_code":"nosql", - "code":"42", + "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_", "doc_type":"api", - "kw":"Deleting a Parameter Template,Parameter Templates", + "kw":"Deleting a Parameter Template,Parameter Templates,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -888,7 +930,7 @@ "uri":"topic_300000005.html", "node_id":"topic_300000005.xml", "product_code":"nosql", - "code":"43", + "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":"Tags", @@ -896,8 +938,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -909,16 +951,16 @@ "uri":"ListInstancesByResourceTags.html", "node_id":"listinstancesbyresourcetags.xml", "product_code":"nosql", - "code":"44", + "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 ", "doc_type":"api", - "kw":"Querying an Instance by Tag,Tags", + "kw":"Querying an Instance by Tag,Tags,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -930,16 +972,16 @@ "uri":"BatchTagAction.html", "node_id":"batchtagaction.xml", "product_code":"nosql", - "code":"45", + "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", "doc_type":"api", - "kw":"Adding or Deleting Resource Tags in Batches,Tags", + "kw":"Adding or Deleting Resource Tags in Batches,Tags,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -951,16 +993,16 @@ "uri":"ListInstanceTags.html", "node_id":"listinstancetags.xml", "product_code":"nosql", - "code":"46", + "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", "doc_type":"api", - "kw":"Querying Tags of an Instance,Tags", + "kw":"Querying Tags of an Instance,Tags,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -972,7 +1014,7 @@ "uri":"topic_300000006.html", "node_id":"topic_300000006.xml", "product_code":"nosql", - "code":"47", + "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":"Logs", @@ -980,8 +1022,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -993,16 +1035,16 @@ "uri":"ListSlowLogs.html", "node_id":"listslowlogs.xml", "product_code":"nosql", - "code":"48", + "code":"50", "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", + "kw":"Querying Database Slow Logs,Logs,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1014,7 +1056,7 @@ "uri":"topic_300000007.html", "node_id":"topic_300000007.xml", "product_code":"nosql", - "code":"49", + "code":"51", "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "doc_type":"api", "kw":"Quotas", @@ -1022,8 +1064,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1035,16 +1077,16 @@ "uri":"ShowQuotas.html", "node_id":"showquotas.xml", "product_code":"nosql", - "code":"50", + "code":"52", "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", + "kw":"Querying Quota,Quotas,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1056,7 +1098,7 @@ "uri":"topic_300000016.html", "node_id":"topic_300000016.xml", "product_code":"", - "code":"51", + "code":"53", "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", @@ -1073,10 +1115,10 @@ "uri":"nosql_10_0100.html", "node_id":"nosql_10_0100.xml", "product_code":"", - "code":"52", + "code":"54", "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", + "kw":"Querying Tasks and Details,Task Management,API Reference", "search_title":"", "metedata":[ { @@ -1090,7 +1132,7 @@ "uri":"nosql_public_parameters.html", "node_id":"nosql_public_parameters.xml", "product_code":"nosql", - "code":"54", + "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":"Appendixes", @@ -1098,8 +1140,8 @@ "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1111,16 +1153,16 @@ "uri":"nosql_abnormal_result.html", "node_id":"nosql_abnormal_result.xml", "product_code":"nosql", - "code":"55", + "code":"56", "des":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", "doc_type":"api", - "kw":"Abnormal Request Results,Appendixes", + "kw":"Abnormal Request Results,Appendixes,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1132,16 +1174,16 @@ "uri":"nosql_status_code.html", "node_id":"nosql_status_code.xml", "product_code":"nosql", - "code":"56", + "code":"57", "des":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", "doc_type":"api", - "kw":"Status Codes,Appendixes", + "kw":"Status Codes,Appendixes,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1153,16 +1195,16 @@ "uri":"nosql_error_code.html", "node_id":"nosql_error_code.xml", "product_code":"nosql", - "code":"57", + "code":"58", "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", + "kw":"Error Codes,Appendixes,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1174,16 +1216,16 @@ "uri":"nosql_projectid.html", "node_id":"nosql_projectid.xml", "product_code":"nosql", - "code":"58", + "code":"59", "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", + "kw":"Obtaining a Project ID,Appendixes,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1195,16 +1237,16 @@ "uri":"nosql_metrics.html", "node_id":"nosql_metrics.xml", "product_code":"nosql", - "code":"59", + "code":"60", "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", + "kw":"Metrics,Appendixes,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1216,16 +1258,16 @@ "uri":"nosql_08_0001.html", "node_id":"nosql_08_0001.xml", "product_code":"nosql", - "code":"60", + "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":"Events Supported by Event Monitoring,Appendixes", + "kw":"Events Supported by Event Monitoring,Appendixes,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } @@ -1237,16 +1279,16 @@ "uri":"nosql_change_history02.html", "node_id":"nosql_change_history02.xml", "product_code":"nosql", - "code":"61", + "code":"62", "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", + "kw":"Change History,API Reference", "search_title":"", "metedata":[ { "documenttype":"api", - "IsBot":"Yes", - "IsMulti":"Yes", + "IsBot":"No;Yes", + "IsMulti":"No;Yes", "prodname":"nosql", "opensource":"true" } diff --git a/docs/geminidb/api-ref/BatchTagAction.html b/docs/geminidb/api-ref/BatchTagAction.html index b9d6e89f..0bcf6cf6 100644 --- a/docs/geminidb/api-ref/BatchTagAction.html +++ b/docs/geminidb/api-ref/BatchTagAction.html @@ -116,7 +116,7 @@

String

-

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

+

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

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

@@ -126,7 +126,7 @@

String

-

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

+

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

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

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

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

diff --git a/docs/geminidb/api-ref/CLASS.TXT.json b/docs/geminidb/api-ref/CLASS.TXT.json index 36b94854..718a2f3a 100644 --- a/docs/geminidb/api-ref/CLASS.TXT.json +++ b/docs/geminidb/api-ref/CLASS.TXT.json @@ -111,7 +111,7 @@ "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", "product_code":"nosql", "title":"APIs v3", - "uri":"en-us_topic_0000001404778285.html", + "uri":"nosql_12_0004.html", "doc_type":"api", "p_code":"", "code":"13" @@ -269,6 +269,24 @@ "p_code":"20", "code":"30" }, + { + "desc":"This API is used to configure an autoscaling policy for storage space.This API supports GeminiDB Cassandra instances.This API supports both pay-per-use and yearly/monthly", + "product_code":"nosql", + "title":"Configuring an Autoscaling Policy for Storage Space", + "uri":"nosql_05_0109.html", + "doc_type":"api", + "p_code":"20", + "code":"31" + }, + { + "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_", + "product_code":"nosql", + "title":"Querying the Autoscaling Policy of Storage Space", + "uri":"nosql_05_0115.html", + "doc_type":"api", + "p_code":"20", + "code":"32" + }, { "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", @@ -276,7 +294,7 @@ "uri":"topic_300000003.html", "doc_type":"api", "p_code":"13", - "code":"31" + "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", @@ -284,8 +302,8 @@ "title":"Querying an Automated Backup Policy", "uri":"nosql_api_0030.html", "doc_type":"api", - "p_code":"31", - "code":"32" + "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", @@ -293,8 +311,8 @@ "title":"Configuring an Automated Backup Policy", "uri":"nosql_api_0031.html", "doc_type":"api", - "p_code":"31", - "code":"33" + "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.", @@ -303,7 +321,7 @@ "uri":"topic_300000004.html", "doc_type":"api", "p_code":"13", - "code":"34" + "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", @@ -311,8 +329,8 @@ "title":"Obtaining Parameter Templates", "uri":"nosql_06_0002.html", "doc_type":"api", - "p_code":"34", - "code":"35" + "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", @@ -320,8 +338,8 @@ "title":"Creating a Parameter Template", "uri":"nosql_06_0003.html", "doc_type":"api", - "p_code":"34", - "code":"36" + "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", @@ -329,8 +347,8 @@ "title":"Modifying Parameters in a Parameter Template", "uri":"nosql_06_0004.html", "doc_type":"api", - "p_code":"34", - "code":"37" + "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", @@ -338,8 +356,8 @@ "title":"Applying a Parameter Template", "uri":"nosql_06_0005.html", "doc_type":"api", - "p_code":"34", - "code":"38" + "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", @@ -347,8 +365,8 @@ "title":"Modifying Parameters of a Specified Instance", "uri":"nosql_06_0006.html", "doc_type":"api", - "p_code":"34", - "code":"39" + "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", @@ -356,8 +374,8 @@ "title":"Querying Instance Parameter Settings", "uri":"nosql_06_0007.html", "doc_type":"api", - "p_code":"34", - "code":"40" + "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", @@ -365,8 +383,8 @@ "title":"Obtaining Parameters of a Specified Parameter Template", "uri":"nosql_06_0008.html", "doc_type":"api", - "p_code":"34", - "code":"41" + "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_", @@ -374,8 +392,8 @@ "title":"Deleting a Parameter Template", "uri":"nosql_06_0009.html", "doc_type":"api", - "p_code":"34", - "code":"42" + "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.", @@ -384,7 +402,7 @@ "uri":"topic_300000005.html", "doc_type":"api", "p_code":"13", - "code":"43" + "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 ", @@ -392,8 +410,8 @@ "title":"Querying an Instance by Tag", "uri":"ListInstancesByResourceTags.html", "doc_type":"api", - "p_code":"43", - "code":"44" + "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", @@ -401,8 +419,8 @@ "title":"Adding or Deleting Resource Tags in Batches", "uri":"BatchTagAction.html", "doc_type":"api", - "p_code":"43", - "code":"45" + "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", @@ -410,8 +428,8 @@ "title":"Querying Tags of an Instance", "uri":"ListInstanceTags.html", "doc_type":"api", - "p_code":"43", - "code":"46" + "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.", @@ -420,7 +438,7 @@ "uri":"topic_300000006.html", "doc_type":"api", "p_code":"13", - "code":"47" + "code":"49" }, { "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", @@ -428,8 +446,8 @@ "title":"Querying Database Slow Logs", "uri":"ListSlowLogs.html", "doc_type":"api", - "p_code":"47", - "code":"48" + "p_code":"49", + "code":"50" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -438,7 +456,7 @@ "uri":"topic_300000007.html", "doc_type":"api", "p_code":"13", - "code":"49" + "code":"51" }, { "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", @@ -446,8 +464,8 @@ "title":"Querying Quota", "uri":"ShowQuotas.html", "doc_type":"api", - "p_code":"49", - "code":"50" + "p_code":"51", + "code":"52" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -456,7 +474,7 @@ "uri":"topic_300000016.html", "doc_type":"", "p_code":"13", - "code":"51" + "code":"53" }, { "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", @@ -464,8 +482,8 @@ "title":"Querying Tasks and Details", "uri":"nosql_10_0100.html", "doc_type":"", - "p_code":"51", - "code":"52" + "p_code":"53", + "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.", @@ -474,7 +492,7 @@ "uri":"nosql_public_parameters.html", "doc_type":"api", "p_code":"", - "code":"54" + "code":"55" }, { "desc":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr", @@ -482,8 +500,8 @@ "title":"Abnormal Request Results", "uri":"nosql_abnormal_result.html", "doc_type":"api", - "p_code":"54", - "code":"55" + "p_code":"55", + "code":"56" }, { "desc":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc", @@ -491,8 +509,8 @@ "title":"Status Codes", "uri":"nosql_status_code.html", "doc_type":"api", - "p_code":"54", - "code":"56" + "p_code":"55", + "code":"57" }, { "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", @@ -500,8 +518,8 @@ "title":"Error Codes", "uri":"nosql_error_code.html", "doc_type":"api", - "p_code":"54", - "code":"57" + "p_code":"55", + "code":"58" }, { "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", @@ -509,8 +527,8 @@ "title":"Obtaining a Project ID", "uri":"nosql_projectid.html", "doc_type":"api", - "p_code":"54", - "code":"58" + "p_code":"55", + "code":"59" }, { "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", @@ -518,8 +536,8 @@ "title":"Metrics", "uri":"nosql_metrics.html", "doc_type":"api", - "p_code":"54", - "code":"59" + "p_code":"55", + "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.", @@ -527,8 +545,8 @@ "title":"Events Supported by Event Monitoring", "uri":"nosql_08_0001.html", "doc_type":"api", - "p_code":"54", - "code":"60" + "p_code":"55", + "code":"61" }, { "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", @@ -537,6 +555,6 @@ "uri":"nosql_change_history02.html", "doc_type":"api", "p_code":"", - "code":"61" + "code":"62" } ] \ No newline at end of file diff --git a/docs/geminidb/api-ref/ListSlowLogs.html b/docs/geminidb/api-ref/ListSlowLogs.html index 3f6dfb12..b2fcaffa 100644 --- a/docs/geminidb/api-ref/ListSlowLogs.html +++ b/docs/geminidb/api-ref/ListSlowLogs.html @@ -228,7 +228,7 @@ "slow_log_list" : [ { "time" : "513 ms", "database" : "cassandra", - "query_sample" : "SELECT * FROM cassandra.sz_user_hw LIMIT 100;", + "query_sample" : "SELECT * FROM cassandra.sz_user LIMIT 100;", "type" : "SELECT", "start_time" : "2020-11-15T22:49:38.643000Z" } ] diff --git a/docs/geminidb/api-ref/nosql_05_0005.html b/docs/geminidb/api-ref/nosql_05_0005.html index d6263aef..4d084e82 100644 --- a/docs/geminidb/api-ref/nosql_05_0005.html +++ b/docs/geminidb/api-ref/nosql_05_0005.html @@ -1,7 +1,7 @@

Concepts

-
  • Account

    A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.

    +
    • Account

      A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.

    • IAM User

      An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).

      API authentication requires information such as the account name, username, and password.

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

      diff --git a/docs/geminidb/api-ref/nosql_05_0014.html b/docs/geminidb/api-ref/nosql_05_0014.html index 8b774bb9..f7709306 100644 --- a/docs/geminidb/api-ref/nosql_05_0014.html +++ b/docs/geminidb/api-ref/nosql_05_0014.html @@ -489,7 +489,7 @@

      String

      Storage engine.

      -
      • rocksDB, indicating that the GeminiDB Cassandra instance support the RocksDB storage engine.
      +
      • rocksDB, indicating that the GeminiDB Cassandra instance supports the RocksDB storage engine.
      diff --git a/docs/geminidb/api-ref/nosql_05_0109.html b/docs/geminidb/api-ref/nosql_05_0109.html new file mode 100644 index 00000000..09ef2659 --- /dev/null +++ b/docs/geminidb/api-ref/nosql_05_0109.html @@ -0,0 +1,189 @@ + + +

      Configuring an Autoscaling Policy for Storage Space

      +

      Function

      This API is used to configure an autoscaling policy for storage space.

      +
      +

      Constraints

      • This API supports GeminiDB Cassandra instances.
      • This API supports both pay-per-use and yearly/monthly instances.
      • If the instance status is not normal, autoscaling of storage space cannot be configured.
      +
      +

      URI

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

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

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

      +
      +
      +
      +

      Request Parameters

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token.

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      instance_ids

      +

      Yes

      +

      Array of strings

      +

      IDs of the instances where autoscaling is enabled for storage space. Up to 50 instances are supported.

      +

      switch_option

      +

      No

      +

      String

      +

      Whether autoscaling is enabled. The value can be:

      +
      • on, indicating that autoscaling is enabled for storage space.
      • off, indicating that autoscaling is disabled for storage space.
      +

      The default value is on.

      +

      policy

      +

      No

      +

      Array of diskAutoExpansionPolicy

      +

      Autoscaling policies for storage space.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + + + + + +
      Table 4 diskAutoExpansionPolicy

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      threshold

      +

      No

      +

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

      step

      +

      No

      +

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

      size

      +

      No

      +

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

      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
          +
        • Enabling autoscaling for storage space (Set threshold to 90, step to 10, and size to 600.)
          { 
+  "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], 
+  "policy" : { 
+    "threshold" : 90, 
+    "step" : 10, 
+    "size" : 600 
+  } 
+}
          +
        +
      • Disabling the autoscaling policy of storage space
        • URI example
          POST https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/disk-auto-expansion
          +
        • Disabling the autoscaling policy of storage space
          { 
+  "instance_ids" : [ "93e4b3eda14349b1b870f72829bc3b9bin06" ], 
+  "switch_option":"off"
+}
          +
        +
      +
      +

      Example Responses

      Status code: 204

      +

      No Content

      +
      { }
      +
      +

      Status Codes

      For details, see Status Codes.

      +
      +

      Error Codes

      For details, see Error Codes.

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

      Querying the Autoscaling Policy of Storage Space

      +

      Function

      This API is used to query the autoscaling policy of storage space.

      +
      +

      Constraints

      This API supports the following types of instances:

      +
      • GeminiDB Cassandra
      +
      +

      URI

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

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      project_id

      +

      Yes

      +

      String

      +

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

      +

      instance_id

      +

      Yes

      +

      String

      +

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

      +
      +
      +
      +

      Request Parameters

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

      Parameter

      +

      Mandatory

      +

      Type

      +

      Description

      +

      X-Auth-Token

      +

      Yes

      +

      String

      +

      User token.

      +
      +
      +
      +

      Response Parameters

      Status code: 200

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

      Parameter

      +

      Type

      +

      Description

      +

      policy

      +

      object

      +

      Autoscaling policy for storage space.

      +

      No information is returned if the autoscaling policy is disabled.

      +

      For details, see Table 4.

      +
      +
      + +
      + + + + + + + + + + + + + + + + + +
      Table 4 AutoEnlargePolicy

      Parameter

      +

      Type

      +

      Description

      +

      threshold

      +

      Integer

      +

      Threshold for triggering autoscaling.

      +

      step

      +

      Integer

      +

      Percentage increase (step%). When autoscaling is triggered, the database system automatically scales up the current storage space of your instance by step%. If the increased storage space is not a multiple of 10 GB, the system rounds it up to the nearest multiple of 10 GB. The default minimum increment is 100 GB.

      +

      size

      +

      Integer

      +

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

      +
      +
      +
      +

      Example Requests

      • URI example
        GET https://{Endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/93e4b3eda14349b1b870f72829bc3b9bin06/disk-auto-expansion
        +
      • Example request body

        None

        +
      +
      +

      Example Responses

      Status code: 200

      +

      Success

      +
      { 
+  "policy" : { 
+    "threshold" : 90, 
+    "step" : 10, 
+    "size" : 600 
+  } 
+}
      +
      +

      Status Codes

      For details, see Status Codes.

      +
      +

      Error Codes

      For details, see Error Codes.

      +
      +
      +
      +
      +
      Parent topic: Instances
      +
      +
      + diff --git a/docs/geminidb/api-ref/en-us_topic_0000001404778285.html b/docs/geminidb/api-ref/nosql_12_0004.html similarity index 92% rename from docs/geminidb/api-ref/en-us_topic_0000001404778285.html rename to docs/geminidb/api-ref/nosql_12_0004.html index 1e27856e..1679b7ef 100644 --- a/docs/geminidb/api-ref/en-us_topic_0000001404778285.html +++ b/docs/geminidb/api-ref/nosql_12_0004.html @@ -1,4 +1,4 @@ - +

      APIs v3

      diff --git a/docs/geminidb/api-ref/nosql_change_history02.html b/docs/geminidb/api-ref/nosql_change_history02.html index 2165c16a..3306282d 100644 --- a/docs/geminidb/api-ref/nosql_change_history02.html +++ b/docs/geminidb/api-ref/nosql_change_history02.html @@ -14,7 +14,7 @@

      Updated status codes in Deleting an Instance.

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

      Updated status codes in Adding Nodes for an Instance.

      -

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

      +

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

      Updated status codes in Changing Specifications of an Instance.

      diff --git a/docs/geminidb/api-ref/nosql_error_code.html b/docs/geminidb/api-ref/nosql_error_code.html index 59ce6c3c..24b94ac6 100644 --- a/docs/geminidb/api-ref/nosql_error_code.html +++ b/docs/geminidb/api-ref/nosql_error_code.html @@ -2164,7 +2164,7 @@

      DBS.03000001

      -

      The instance has not build biactive relationship.

      +

      The instance has not built a dual-active DR relationship.

      Instance has no dual-active DR relationships.

      diff --git a/docs/geminidb/api-ref/topic_300000000.html b/docs/geminidb/api-ref/topic_300000000.html index f8f9c143..d0d40783 100644 --- a/docs/geminidb/api-ref/topic_300000000.html +++ b/docs/geminidb/api-ref/topic_300000000.html @@ -12,7 +12,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000001.html b/docs/geminidb/api-ref/topic_300000001.html index 991167c9..6e20048c 100644 --- a/docs/geminidb/api-ref/topic_300000001.html +++ b/docs/geminidb/api-ref/topic_300000001.html @@ -11,7 +11,7 @@
-
Parent topic: APIs v3
+
Parent topic: APIs v3
diff --git a/docs/geminidb/api-ref/topic_300000002.html b/docs/geminidb/api-ref/topic_300000002.html index 04171fab..29076dfd 100644 --- a/docs/geminidb/api-ref/topic_300000002.html +++ b/docs/geminidb/api-ref/topic_300000002.html @@ -24,10 +24,14 @@
  • Changing the Security Group of an Instance
    • +
  • Configuring an Autoscaling Policy for Storage Space
    +
    • +
  • Querying the Autoscaling Policy of Storage Space
    +
    • -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000003.html b/docs/geminidb/api-ref/topic_300000003.html index 70dac2a1..798de300 100644 --- a/docs/geminidb/api-ref/topic_300000003.html +++ b/docs/geminidb/api-ref/topic_300000003.html @@ -11,7 +11,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000004.html b/docs/geminidb/api-ref/topic_300000004.html index 15c74230..c237cba6 100644 --- a/docs/geminidb/api-ref/topic_300000004.html +++ b/docs/geminidb/api-ref/topic_300000004.html @@ -23,7 +23,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000005.html b/docs/geminidb/api-ref/topic_300000005.html index 281401e8..b1a45d18 100644 --- a/docs/geminidb/api-ref/topic_300000005.html +++ b/docs/geminidb/api-ref/topic_300000005.html @@ -13,7 +13,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000006.html b/docs/geminidb/api-ref/topic_300000006.html index c533053c..5c00f211 100644 --- a/docs/geminidb/api-ref/topic_300000006.html +++ b/docs/geminidb/api-ref/topic_300000006.html @@ -10,7 +10,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000007.html b/docs/geminidb/api-ref/topic_300000007.html index 3672e81f..57fe9fb4 100644 --- a/docs/geminidb/api-ref/topic_300000007.html +++ b/docs/geminidb/api-ref/topic_300000007.html @@ -9,7 +9,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3
    diff --git a/docs/geminidb/api-ref/topic_300000016.html b/docs/geminidb/api-ref/topic_300000016.html index 987c285f..ede67884 100644 --- a/docs/geminidb/api-ref/topic_300000016.html +++ b/docs/geminidb/api-ref/topic_300000016.html @@ -9,7 +9,7 @@
    -
    Parent topic: APIs v3
    +
    Parent topic: APIs v3