yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a2e28c76231c99d8bbac87147becbb2b7e6be32e
doc-exports/docs/geminidb/api-ref/CLASS.TXT.json
wangdengke2 59805c5073 GeminiDB_API 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2026-03-12 09:56:41 +00:00

938 lines
36 KiB
JSON
Raw Blame History

[
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Before You Start",
"uri":"nosql_api_reference.html",
"doc_type":"api",
"p_code":"",
"code":"1"
},
{
"desc":"Welcome to GeminiDB API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on GeminiDB, such as creating, delet",
"product_code":"nosql",
"title":"Overview",
"uri":"nosql_05_0001.html",
"doc_type":"api",
"p_code":"1",
"code":"2"
},
{
"desc":"GeminiDB supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.",
"product_code":"nosql",
"title":"API Calling",
"uri":"nosql_05_0002.html",
"doc_type":"api",
"p_code":"1",
"code":"3"
},
{
"desc":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see Regions and Endpoints.",
"product_code":"nosql",
"title":"Endpoints",
"uri":"nosql_05_0003.html",
"doc_type":"api",
"p_code":"1",
"code":"4"
},
{
"desc":"For more constraints, see the description of each API.",
"product_code":"nosql",
"title":"Constraints",
"uri":"nosql_05_0004.html",
"doc_type":"api",
"p_code":"1",
"code":"5"
},
{
"desc":"AccountA domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user ",
"product_code":"nosql",
"title":"Concepts",
"uri":"nosql_05_0005.html",
"doc_type":"api",
"p_code":"1",
"code":"6"
},
{
"desc":"GeminiDB provides extended APIs. These APIs enable you to use some functions of GeminiDB.",
"product_code":"nosql",
"title":"API Overview",
"uri":"nosql_05_0006.html",
"doc_type":"api",
"p_code":"",
"code":"7"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Calling APIs",
"uri":"nosql_05_0007.html",
"doc_type":"api",
"p_code":"",
"code":"8"
},
{
"desc":"This section describes the structure of a REST API, and uses the IAM API for obtaining a user token as an example to describe how to call an API. The obtained token is us",
"product_code":"nosql",
"title":"Making an API Request",
"uri":"nosql_05_0008.html",
"doc_type":"api",
"p_code":"8",
"code":"9"
},
{
"desc":"GeminiDB supports token-based authentication.The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.A t",
"product_code":"nosql",
"title":"Authentication",
"uri":"nosql_05_0009.html",
"doc_type":"api",
"p_code":"8",
"code":"10"
},
{
"desc":"After you send a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits ranging from 1xx to ",
"product_code":"nosql",
"title":"Returned Values",
"uri":"nosql_05_0010.html",
"doc_type":"api",
"p_code":"8",
"code":"11"
},
{
"desc":"This section describes how to create a GeminiDB Cassandra instance by calling APIs.The token obtained from IAM is valid for only 24 hours. If you want to use a token for ",
"product_code":"nosql",
"title":"Quick Start",
"uri":"nosql_05_0011.html",
"doc_type":"api",
"p_code":"",
"code":"12"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"",
"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":"API Versions and Specifications",
"uri":"nosql_12_0006.html",
"doc_type":"",
"p_code":"15",
"code":"16"
},
{
"desc":"This API is used to query all instance specifications under a specified condition.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{E",
"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 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":"19"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"",
"title":"Parameter Templates",
"uri":"nosql_12_0008.html",
"doc_type":"",
"p_code":"15",
"code":"20"
},
{
"desc":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API can be used for GeminiDB Cassandra and GeminiDB Influ",
"product_code":"nosql",
"title":"Obtaining Parameter Templates",
"uri":"nosql_06_0002.html",
"doc_type":"api",
"p_code":"20",
"code":"21"
},
{
"desc":"This API is used to apply a parameter template to one or more instances.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.This API is an asynchron",
"product_code":"nosql",
"title":"Applying a Parameter Template",
"uri":"nosql_06_0005.html",
"doc_type":"api",
"p_code":"20",
"code":"22"
},
{
"desc":"This API is used to modify parameters of a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.For configuration item values, you",
"product_code":"nosql",
"title":"Modifying Parameters of a Specified Instance",
"uri":"nosql_06_0006.html",
"doc_type":"api",
"p_code":"20",
"code":"23"
},
{
"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":"nosql_12_0004.html",
"doc_type":"api",
"p_code":"",
"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",
"title":"API Versions",
"uri":"topic_300000000.html",
"doc_type":"api",
"p_code":"24",
"code":"25"
},
{
"desc":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ",
"product_code":"nosql",
"title":"Querying API Versions",
"uri":"ListApiVersion.html",
"doc_type":"api",
"p_code":"25",
"code":"26"
},
{
"desc":"This API is used to query version information of a specified API.GET https://{Endpoint}/{version}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 200S",
"product_code":"nosql",
"title":"Querying Version Information of an API",
"uri":"ShowApiVersion.html",
"doc_type":"api",
"p_code":"25",
"code":"27"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Versions and Specifications",
"uri":"topic_300000001.html",
"doc_type":"api",
"p_code":"24",
"code":"28"
},
{
"desc":"This API is used to query version information of a specified type of instances.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endp",
"product_code":"nosql",
"title":"Querying Version Information",
"uri":"nosql_database_version.html",
"doc_type":"api",
"p_code":"28",
"code":"29"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Instances",
"uri":"topic_300000002.html",
"doc_type":"api",
"p_code":"24",
"code":"30"
},
{
"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":"30",
"code":"31"
},
{
"desc":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This",
"product_code":"nosql",
"title":"Deleting an Instance",
"uri":"nosql_05_0015.html",
"doc_type":"api",
"p_code":"30",
"code":"32"
},
{
"desc":"This API is used to query instances and details based on specified conditions.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpo",
"product_code":"nosql",
"title":"Querying Instances and Details",
"uri":"nosql_05_0016.html",
"doc_type":"api",
"p_code":"30",
"code":"33"
},
{
"desc":"This API is used to scale up storage space of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.POST https://{Endpoint}/v3/{project_id",
"product_code":"nosql",
"title":"Scaling Up Storage Space of an Instance",
"uri":"nosql_05_0050.html",
"doc_type":"api",
"p_code":"30",
"code":"34"
},
{
"desc":"This API is used to add nodes for a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.POST https://{Endpoint}/v3/{project_id}/i",
"product_code":"nosql",
"title":"Adding Nodes for an Instance",
"uri":"nosql_05_0051.html",
"doc_type":"api",
"p_code":"30",
"code":"35"
},
{
"desc":"This API is used to delete nodes from a specified instance.This API supports GeminiDB Cassandra instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/",
"product_code":"nosql",
"title":"Deleting Nodes from a Specified Instance",
"uri":"nosql_05_0052.html",
"doc_type":"api",
"p_code":"30",
"code":"36"
},
{
"desc":"This API is used to query instance specifications that can be changed.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpoint}/v3/",
"product_code":"nosql",
"title":"Querying Changeable Specifications",
"uri":"nosql_05_0156.html",
"doc_type":"api",
"p_code":"30",
"code":"37"
},
{
"desc":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ",
"product_code":"nosql",
"title":"Changing Specifications of an Instance",
"uri":"nosql_05_0100.html",
"doc_type":"api",
"p_code":"30",
"code":"38"
},
{
"desc":"This API is used to reset the administrator password of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.Abnormal instances do not su",
"product_code":"nosql",
"title":"Resetting the Administrator Password of an Instance",
"uri":"nosql_05_0101.html",
"doc_type":"api",
"p_code":"30",
"code":"39"
},
{
"desc":"This API is used to edit the name of an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.The name of the instance that is being created ",
"product_code":"nosql",
"title":"Editing the Name of an Instance",
"uri":"nosql_05_0102.html",
"doc_type":"api",
"p_code":"30",
"code":"40"
},
{
"desc":"This API is used to change the security group associated with an instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.Abnormal instances do ",
"product_code":"nosql",
"title":"Changing the Security Group of an Instance",
"uri":"nosql_05_0103.html",
"doc_type":"api",
"p_code":"30",
"code":"41"
},
{
"desc":"This API is used to patch databases in batches.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxUpgrad",
"product_code":"nosql",
"title":"Patching Databases In Batches",
"uri":"BatchUpgradeDbVersion.html",
"doc_type":"api",
"p_code":"30",
"code":"42"
},
{
"desc":"This API is used to enable or disable SSL.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxThe instanc",
"product_code":"nosql",
"title":"Enabling or Disabling SSL",
"uri":"nosql_05_0107.html",
"doc_type":"api",
"p_code":"30",
"code":"43"
},
{
"desc":"This API is used to restart an instance.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxGeminiDB CassandraGeminiDB InfluxIf the instan",
"product_code":"nosql",
"title":"Restarting an Instance",
"uri":"nosql_05_0108.html",
"doc_type":"api",
"p_code":"30",
"code":"44"
},
{
"desc":"This API is used to configure an autoscaling policy for storage space.This API supports GeminiDB Cassandra instances.This API supports both pay-per-use and yearly/monthly",
"product_code":"nosql",
"title":"Configuring an Autoscaling Policy for Storage Space",
"uri":"nosql_05_0109.html",
"doc_type":"api",
"p_code":"30",
"code":"45"
},
{
"desc":"This API is used to check whether the password is weak.POST https://{Endpoint}/v3/{project_id}/weak-password-verificationStatus code: 200URI examplePOST https://{Endpoint",
"product_code":"nosql",
"title":"Checking Password Strength",
"uri":"nosql_05_0110.html",
"doc_type":"api",
"p_code":"30",
"code":"46"
},
{
"desc":"This API is used to delete the node that fails to be added to an instance.This API supports the following types of instances:GeminiDB CassandraDELETE https://{Endpoint}/v",
"product_code":"nosql",
"title":"Deleting the Node that Fails to Be Added",
"uri":"nosql_05_0113.html",
"doc_type":"api",
"p_code":"30",
"code":"47"
},
{
"desc":"This API is used to query IP addresses required for creating an instance or adding nodes to an instance.This API supports the following instances:GeminiDB CassandraGemini",
"product_code":"nosql",
"title":"Querying IP Addresses Required for Creating an Instance or Adding Nodes",
"uri":"nosql_05_0114.html",
"doc_type":"api",
"p_code":"30",
"code":"48"
},
{
"desc":"This API is used to query the autoscaling policy of storage space.This API supports the following types of instances:GeminiDB CassandraGET https://{Endpoint}/v3/{project_",
"product_code":"nosql",
"title":"Querying the Autoscaling Policy of Storage Space",
"uri":"nosql_05_0115.html",
"doc_type":"api",
"p_code":"30",
"code":"49"
},
{
"desc":"This API is used to scale storage space of an instance.This API supports the following instances:GeminiDB CassandraThis API supports both yearly/monthly and pay-per-use i",
"product_code":"nosql",
"title":"Scaling Storage Space of an Instance",
"uri":"nosql_05_0116.html",
"doc_type":"api",
"p_code":"30",
"code":"50"
},
{
"desc":"This API is used to set the maintenance period of a specified instance.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraPUT https://{En",
"product_code":"",
"title":"Setting the Maintenance Period of an Instance",
"uri":"nosql_05_0062.html",
"doc_type":"",
"p_code":"30",
"code":"51"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Backups and Restorations",
"uri":"topic_300000003.html",
"doc_type":"api",
"p_code":"24",
"code":"52"
},
{
"desc":"This API is used to configuring an automated backup policy.This API can be used on GeminiDB Cassandra and GeminiDB Influx instances.PUT https://{Endpoint}/v3/{project_id}",
"product_code":"nosql",
"title":"Configuring an Automated Backup Policy",
"uri":"nosql_api_0031.html",
"doc_type":"api",
"p_code":"52",
"code":"53"
},
{
"desc":"This API is used to query the time window when a backup can be restored.This API supports the following instances:GeminiDB CassandraMake sure that full backup, incrementa",
"product_code":"nosql",
"title":"Querying the Time Window When a Backup Can Be Restored",
"uri":"ListRestoreTime.html",
"doc_type":"api",
"p_code":"52",
"code":"54"
},
{
"desc":"This API is used to create a manual backup.This API supports the following instances:GeminiDB CassandraGeminiDB InfluxPOST https://{Endpoint}/v3/{project_id}/instances/{i",
"product_code":"nosql",
"title":"Creating a Manual Backup",
"uri":"nosql_api_0032.html",
"doc_type":"api",
"p_code":"52",
"code":"55"
},
{
"desc":"This API is used to delete a manual backup.This API supports the following instances:GeminiDB CassandraGeminiDB InfluxDELETE https://{Endpoint}/v3/{project_id}/backups/{b",
"product_code":"nosql",
"title":"Deleting a Manual Backup",
"uri":"DeleteBackup.html",
"doc_type":"api",
"p_code":"52",
"code":"56"
},
{
"desc":"This API is used to query the recycling policy.GET https://{Endpoint}/v3/{project_id}/instances/recycle-policyStatus code: 200URI exampleGET https://{Endpoint}/v3/054e292",
"product_code":"nosql",
"title":"Querying the Recycling Policy",
"uri":"nosql_api_0033.html",
"doc_type":"api",
"p_code":"52",
"code":"57"
},
{
"desc":"This API is used to change a retention period for deleted instances. The new retention period is available to only those instances deleted after the change, but not to th",
"product_code":"nosql",
"title":"Modifying the Recycling Policy",
"uri":"nosql_api_0034.html",
"doc_type":"api",
"p_code":"52",
"code":"58"
},
{
"desc":"This API is used to query all instances in the recycle bin.GET https://{Endpoint}/v3/{project_id}/recycle-instancesStatus code: 200URI exampleGET https://{Endpoint}/v3/61",
"product_code":"nosql",
"title":"Querying Instances in the Recycle Bin",
"uri":"nosql_api_0035.html",
"doc_type":"api",
"p_code":"52",
"code":"59"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Parameter Templates",
"uri":"topic_300000004.html",
"doc_type":"api",
"p_code":"24",
"code":"60"
},
{
"desc":"This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.This API can be use",
"product_code":"nosql",
"title":"Creating a Parameter Template",
"uri":"nosql_06_0003.html",
"doc_type":"api",
"p_code":"60",
"code":"61"
},
{
"desc":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.The modified parameter template name must be ",
"product_code":"nosql",
"title":"Modifying Parameters in a Parameter Template",
"uri":"nosql_06_0004.html",
"doc_type":"api",
"p_code":"60",
"code":"62"
},
{
"desc":"This API is used to query instance parameter settings.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.GET https://{Endpoint}/v3/{project_id}/ins",
"product_code":"nosql",
"title":"Querying Instance Parameter Settings",
"uri":"nosql_06_0007.html",
"doc_type":"api",
"p_code":"60",
"code":"63"
},
{
"desc":"This API is used to obtain information about parameters of a specified parameter template.This API can be used for GeminiDB Cassandra instances.GET https://{Endpoint}/v3/",
"product_code":"nosql",
"title":"Obtaining Parameters of a Specified Parameter Template",
"uri":"nosql_06_0008.html",
"doc_type":"api",
"p_code":"60",
"code":"64"
},
{
"desc":"This API is used to delete a specified parameter template.This API can be used for GeminiDB Cassandra instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{",
"product_code":"nosql",
"title":"Deleting a Parameter Template",
"uri":"nosql_06_0009.html",
"doc_type":"api",
"p_code":"60",
"code":"65"
},
{
"desc":"This API is used to query instances that a parameter template can be applied to.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxGET https:",
"product_code":"nosql",
"title":"Querying Instances that a Parameter Template Can Be Applied To",
"uri":"QueryApplicableInstances.html",
"doc_type":"api",
"p_code":"60",
"code":"66"
},
{
"desc":"This API is used to view change history of parameters of an instance.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxThis API can be used ",
"product_code":"nosql",
"title":"Viewing Parameter Change History of an Instance",
"uri":"QueryModifyHistory.html",
"doc_type":"api",
"p_code":"60",
"code":"67"
},
{
"desc":"This API is used to view application records of a parameter template.This API supports the following instance types:GeminiDB CassandraGeminiDB InfluxAfter an instance is ",
"product_code":"nosql",
"title":"Viewing Application Records of a Parameter Template",
"uri":"QueryApplyHistory.html",
"doc_type":"api",
"p_code":"60",
"code":"68"
},
{
"desc":"This API is used to compare two parameter templates.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxThis API only compares parameter t",
"product_code":"nosql",
"title":"Comparing Parameter Templates",
"uri":"nosql_06_0110.html",
"doc_type":"api",
"p_code":"60",
"code":"69"
},
{
"desc":"This API is used to replicate a parameter template.This API supports the following types of instances:GeminiDB CassandraGeminiDB InfluxThe parameter template generated af",
"product_code":"nosql",
"title":"Replicating a Parameter Template",
"uri":"nosql_06_0111.html",
"doc_type":"api",
"p_code":"60",
"code":"70"
},
{
"desc":"This API is used to query database types that support parameter templates.GET https://{Endpoint}/v3/{project_id}/configurations/datastoresStatus code: 200URI exampleGET h",
"product_code":"nosql",
"title":"Querying Database Types That Support Parameter Templates",
"uri":"nosql_06_0112.html",
"doc_type":"api",
"p_code":"60",
"code":"71"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Tags",
"uri":"topic_300000005.html",
"doc_type":"api",
"p_code":"24",
"code":"72"
},
{
"desc":"This API is used to query a specified instance by tag.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum of 20 tags can be added to a DB ",
"product_code":"nosql",
"title":"Querying an Instance by Tag",
"uri":"ListInstancesByResourceTags.html",
"doc_type":"api",
"p_code":"72",
"code":"73"
},
{
"desc":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum",
"product_code":"nosql",
"title":"Adding or Deleting Resource Tags in Batches",
"uri":"BatchTagAction.html",
"doc_type":"api",
"p_code":"72",
"code":"74"
},
{
"desc":"This API is used to query tags of a specified instance.This API can be used for GeminiDB Cassandra and GeminiDB Influx instances.A maximum of 20 tags can be added to a DB",
"product_code":"nosql",
"title":"Querying Tags of an Instance",
"uri":"ListInstanceTags.html",
"doc_type":"api",
"p_code":"72",
"code":"75"
},
{
"desc":"This API is used to query tags of a specified project.GET https://{Endpoint}/v3/{project_id}/tagsStatus code: 200URI exampleGET https://{Endpoint}/v3/0549b4a43100d4f32f51",
"product_code":"nosql",
"title":"Querying Tags of a Specified Project",
"uri":"topic_300000015.html",
"doc_type":"api",
"p_code":"72",
"code":"76"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Logs",
"uri":"topic_300000006.html",
"doc_type":"api",
"p_code":"24",
"code":"77"
},
{
"desc":"This API is used to query the latest 2,000 slow query logs of an instance. Searching by keyword is not supported.This API can be used for GeminiDB Cassandra and GeminiDB ",
"product_code":"nosql",
"title":"Querying Database Slow Logs",
"uri":"ListSlowLogs.html",
"doc_type":"api",
"p_code":"77",
"code":"78"
},
{
"desc":"This API is used to query slow query logs of GeminiDB Cassandra instances. Searching for slow query logs by keyword is supported.Operators &&, ||, AND, OR, NOT, *, ?, :, ",
"product_code":"nosql",
"title":"Querying Slow Query Logs of a GeminiDB Cassandra Instance",
"uri":"nosql_10_0003.html",
"doc_type":"api",
"p_code":"77",
"code":"79"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Quotas",
"uri":"topic_300000007.html",
"doc_type":"api",
"p_code":"24",
"code":"80"
},
{
"desc":"This API is used to query GeminiDB resource quotas of a tenant.GET https://{Endpoint}/v3/{project_id}/quotasStatus code: 200URI exampleGET https://{Endpoint}/v3/0549b4a43",
"product_code":"nosql",
"title":"Querying Quota",
"uri":"ShowQuotas.html",
"doc_type":"api",
"p_code":"80",
"code":"81"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"",
"title":"Task Management",
"uri":"topic_300000016.html",
"doc_type":"",
"p_code":"24",
"code":"82"
},
{
"desc":"This API is used to query tasks (by default) and details.GET https://{Endpoint}/v3/{project_id}/jobsStatus code: 200URI exampleGET https://{endpoint}/v3/0549b4a43100d4f32",
"product_code":"",
"title":"Querying Tasks and Details",
"uri":"nosql_10_0100.html",
"doc_type":"",
"p_code":"82",
"code":"83"
},
{
"desc":"This function is used to query the maintenance period of an instance.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraGET https://{Endp",
"product_code":"",
"title":"Querying the Maintenance Period of an Instance",
"uri":"nosql_10_0101.html",
"doc_type":"",
"p_code":"82",
"code":"84"
},
{
"desc":"This function is used to query scheduled tasks based on specified conditions.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraGET https",
"product_code":"",
"title":"Querying Scheduled Tasks",
"uri":"nosql_10_0102.html",
"doc_type":"",
"p_code":"82",
"code":"85"
},
{
"desc":"This function is used to cancel a scheduled task based on the task ID.This API supports the following types of instances:GeminiDB InfluxGeminiDB CassandraDELETE https://{",
"product_code":"",
"title":"Canceling a Scheduled Task",
"uri":"nosql_10_0103.html",
"doc_type":"",
"p_code":"82",
"code":"86"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Enterprise Projects",
"uri":"topic_300000017.html",
"doc_type":"api",
"p_code":"24",
"code":"87"
},
{
"desc":"This API is used to query enterprise project quotas.GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotasStatus code: 200URI exampleGET https://{Endpoint}/v3/",
"product_code":"nosql",
"title":"Querying Enterprise Project Quotas",
"uri":"topic_300000018.html",
"doc_type":"api",
"p_code":"87",
"code":"88"
},
{
"desc":"This API is used to modify enterprise project quotas.PUT https://{Endpoint}/v3/{project_id}/enterprise-projects/quotasStatus code: 204No response parametersURI examplePUT",
"product_code":"nosql",
"title":"Modifying Enterprise Project Quotas",
"uri":"topic_300000019.html",
"doc_type":"api",
"p_code":"87",
"code":"89"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Historical APIs",
"uri":"nosql_05_0203.html",
"doc_type":"api",
"p_code":"",
"code":"90"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"",
"title":"Backup and Restoration",
"uri":"nosql_06_3001.html",
"doc_type":"",
"p_code":"90",
"code":"91"
},
{
"desc":"This API is used to query backups based on specified conditions.You can view incremental and differential backups and their sizes on GeminiDB Cassandra instances.GET http",
"product_code":"nosql",
"title":"Querying Backups (Recommended)",
"uri":"nosql_05_0211.html",
"doc_type":"api",
"p_code":"91",
"code":"92"
},
{
"desc":"This API is used to query an automated backup policy.This API will be unavailable. You are advised to switch workloads to the new API described in Querying an Automated B",
"product_code":"nosql",
"title":"Querying an Automated Backup Policy",
"uri":"nosql_06_3002.html",
"doc_type":"api",
"p_code":"91",
"code":"93"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Parameter Templates",
"uri":"nosql_05_0205.html",
"doc_type":"api",
"p_code":"90",
"code":"94"
},
{
"desc":"This API is used to apply a parameter template to one or more instances.This API will be unavailable. You are advised to switch workloads to the new API described in Appl",
"product_code":"nosql",
"title":"Applying a Parameter Template",
"uri":"nosql_06_0218.html",
"doc_type":"api",
"p_code":"94",
"code":"95"
},
{
"desc":"This API is used to modify parameters of a specified instance.This API will be unavailable. You are advised to switch workloads to the new API described in Modifying Para",
"product_code":"nosql",
"title":"Modifying Parameters of a Specified Instance",
"uri":"nosql_06_0219.html",
"doc_type":"api",
"p_code":"94",
"code":"96"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Appendixes",
"uri":"nosql_public_parameters.html",
"doc_type":"api",
"p_code":"",
"code":"97"
},
{
"desc":"Abnormal ResponseParameter descriptionParameterMandatoryTypeDescriptionerror_codeYesStringError code returned when a task submission exception occurs.error_msgYesStringEr",
"product_code":"nosql",
"title":"Abnormal Request Results",
"uri":"nosql_abnormal_result.html",
"doc_type":"api",
"p_code":"97",
"code":"98"
},
{
"desc":"NormalStatus CodeEncodingState Description200OKRequest succeeded.204No ContentRequest succeeded, but no response is returned.202AcceptedAsynchronous request submitted suc",
"product_code":"nosql",
"title":"Status Codes",
"uri":"nosql_status_code.html",
"doc_type":"api",
"p_code":"97",
"code":"99"
},
{
"desc":"If an error occurs during API calling, no results will be returned. You can locate the error cause based on error codes of each API. If an error occurs, an HTTP status co",
"product_code":"nosql",
"title":"Error Codes",
"uri":"nosql_error_code.html",
"doc_type":"api",
"p_code":"97",
"code":"100"
},
{
"desc":"When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first.You can obtain the required project ID with either o",
"product_code":"nosql",
"title":"Obtaining a Project ID",
"uri":"nosql_projectid.html",
"doc_type":"api",
"p_code":"97",
"code":"101"
},
{
"desc":"This section describes GeminiDB metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query metrics of monit",
"product_code":"nosql",
"title":"Metrics",
"uri":"nosql_metrics.html",
"doc_type":"api",
"p_code":"97",
"code":"102"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Events Supported by Event Monitoring",
"uri":"nosql_08_0001.html",
"doc_type":"api",
"p_code":"97",
"code":"103"
},
{
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"product_code":"nosql",
"title":"Change History",
"uri":"nosql_change_history02.html",
"doc_type":"api",
"p_code":"",
"code":"104"
}
]
View Git Blame Copy Permalink