forked from docs/doc-exports
zhangyue
2cbc3d7335
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
488 lines
18 KiB
JSON
488 lines
18 KiB
JSON
[
|
|
{
|
|
"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 GaussDB NoSQL API Reference. This document describes how to use application programming interfaces (APIs) to perform operations on GaussDB NoSQL, such as creat",
|
|
"product_code":"nosql",
|
|
"title":"Overview",
|
|
"uri":"nosql_05_0001.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"2"
|
|
},
|
|
{
|
|
"desc":"GaussDB NoSQL 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":"AccountAn account is generated after your registration. The account has full access permissions for all the resources and cloud services in it. You can use it to reset us",
|
|
"product_code":"nosql",
|
|
"title":"Concepts",
|
|
"uri":"nosql_05_0005.html",
|
|
"doc_type":"api",
|
|
"p_code":"1",
|
|
"code":"6"
|
|
},
|
|
{
|
|
"desc":"GaussDB NoSQL provides extended APIs. These APIs enable you to use some functions of GaussDB NoSQL.",
|
|
"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":"GaussDB NoSQL 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 callin",
|
|
"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 GaussDB NoSQL instance by calling APIs.The token obtained from IAM is valid for only 24 hours. If you want to use a token for authe",
|
|
"product_code":"nosql",
|
|
"title":"Quick Start",
|
|
"uri":"nosql_05_0011.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"12"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"nosql",
|
|
"title":"APIs v3",
|
|
"uri":"en-us_topic_0000001404778285.html",
|
|
"doc_type":"api",
|
|
"p_code":"",
|
|
"code":"13"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"nosql",
|
|
"title":"API Versions",
|
|
"uri":"topic_300000000.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"14"
|
|
},
|
|
{
|
|
"desc":"This API is used to query the supported API versions.GET https://{Endpoint}/NoneStatus code: 200URI exampleGET https://{Endpoint}/Status code: 200SuccessFor details, see ",
|
|
"product_code":"nosql",
|
|
"title":"Querying API Versions",
|
|
"uri":"ListApiVersion.html",
|
|
"doc_type":"api",
|
|
"p_code":"14",
|
|
"code":"15"
|
|
},
|
|
{
|
|
"desc":"This API is used to query version information of a specified API.GET https://{Endpoint}/{versionId}NoneStatus code: 200URI exampleGET https://{Endpoint}/v3Status code: 20",
|
|
"product_code":"nosql",
|
|
"title":"Querying Version Information of an API",
|
|
"uri":"ShowApiVersion.html",
|
|
"doc_type":"api",
|
|
"p_code":"14",
|
|
"code":"16"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"nosql",
|
|
"title":"DB Engine Versions and Specifications",
|
|
"uri":"topic_300000001.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"17"
|
|
},
|
|
{
|
|
"desc":"This API is used to query version information of a specified type of instances.This API supports GaussDB(for Cassandra) instances.GET https://{Endpoint}/v3/{project_id}/d",
|
|
"product_code":"nosql",
|
|
"title":"Querying Version Information",
|
|
"uri":"nosql_database_version.html",
|
|
"doc_type":"api",
|
|
"p_code":"17",
|
|
"code":"18"
|
|
},
|
|
{
|
|
"desc":"This API is used to query all instance specifications under a specified condition.This API supports GaussDB(for Cassandra) instances.GET https://{Endpoint}/v3.1/{project_",
|
|
"product_code":"nosql",
|
|
"title":"Querying Instance Specifications",
|
|
"uri":"nosql_instance_specification.html",
|
|
"doc_type":"api",
|
|
"p_code":"17",
|
|
"code":"19"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"nosql",
|
|
"title":"Instances",
|
|
"uri":"topic_300000002.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"20"
|
|
},
|
|
{
|
|
"desc":"This API can be used to create an instance.This API supports GaussDB(for Cassandra) instances.POST https://{Endpoint}/v3/{project_id}/instancesStatus code: 202URI example",
|
|
"product_code":"nosql",
|
|
"title":"Creating an Instance",
|
|
"uri":"nosql_05_0014.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"21"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete an instance. Only pay-per-use instances can be deleted. Yearly/Monthly instances need to be unsubscribed from if they are no longer needed.This",
|
|
"product_code":"nosql",
|
|
"title":"Deleting an Instance",
|
|
"uri":"nosql_05_0015.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"22"
|
|
},
|
|
{
|
|
"desc":"This API is used to query instances and details based on specified conditions.This API supports GaussDB(for Cassandra) instances.GET https://{Endpoint}/v3/{project_id}/in",
|
|
"product_code":"nosql",
|
|
"title":"Querying Instances and Details",
|
|
"uri":"nosql_05_0016.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"23"
|
|
},
|
|
{
|
|
"desc":"This API is used to scale up storage space of an instance.This API supports GaussDB(for Cassandra) instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_i",
|
|
"product_code":"nosql",
|
|
"title":"Scaling Up Storage Space of an Instance",
|
|
"uri":"nosql_05_0050.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"24"
|
|
},
|
|
{
|
|
"desc":"This API is used to add nodes for a specified instance.This API supports GaussDB(for Cassandra) instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/",
|
|
"product_code":"nosql",
|
|
"title":"Adding Nodes for an Instance",
|
|
"uri":"nosql_05_0051.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"25"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete nodes from a specified instance.This API supports GaussDB(for Cassandra) instances.POST https://{Endpoint}/v3/{project_id}/instances/{instance_",
|
|
"product_code":"nosql",
|
|
"title":"Deleting Nodes from a Specified Instance",
|
|
"uri":"nosql_05_0052.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"26"
|
|
},
|
|
{
|
|
"desc":"This API is used to change specifications of an instance.Services will be interrupted for 5 to 10 minutes when you change specifications of an instance. Exercise caution ",
|
|
"product_code":"nosql",
|
|
"title":"Changing Specifications of an Instance",
|
|
"uri":"nosql_05_0100.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"27"
|
|
},
|
|
{
|
|
"desc":"This API is used to reset the administrator password of an instance.This API supports GaussDB(for Cassandra) instances.Abnormal instances do not support this operation.On",
|
|
"product_code":"nosql",
|
|
"title":"Resetting the Administrator Password of an Instance",
|
|
"uri":"nosql_05_0101.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"code":"28"
|
|
},
|
|
{
|
|
"desc":"This API is used to edit the name of an instance.This API supports GaussDB(for Cassandra) instances.The name of the instance that is being created or fails to be created ",
|
|
"product_code":"nosql",
|
|
"title":"Editing the Name of an Instance",
|
|
"uri":"nosql_05_0102.html",
|
|
"doc_type":"api",
|
|
"p_code":"20",
|
|
"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":"Backups and Restorations",
|
|
"uri":"topic_300000003.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"30"
|
|
},
|
|
{
|
|
"desc":"This API is used to query an automated backup policy.This API supports GaussDB(for Cassandra) instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/bac",
|
|
"product_code":"nosql",
|
|
"title":"Querying an Automated Backup Policy",
|
|
"uri":"nosql_api_0030.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"code":"31"
|
|
},
|
|
{
|
|
"desc":"This API is used to configuring an automated backup policy.This API supports GaussDB(for Cassandra) instances.PUT https://{Endpoint}/v3/{project_id}/instances/{instance_i",
|
|
"product_code":"nosql",
|
|
"title":"Configuring an Automated Backup Policy",
|
|
"uri":"nosql_api_0031.html",
|
|
"doc_type":"api",
|
|
"p_code":"30",
|
|
"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",
|
|
"title":"Parameter Templates",
|
|
"uri":"topic_300000004.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"33"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain parameter templates, including all of the default and custom parameter templates.This API supports GaussDB(for Cassandra) instances.GET https:/",
|
|
"product_code":"nosql",
|
|
"title":"Obtaining Parameter Templates",
|
|
"uri":"nosql_06_0002.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"34"
|
|
},
|
|
{
|
|
"desc":"This API is used to create a parameter template and configure the name, description, DB engine version, and parameter values in the parameter template.This API supports G",
|
|
"product_code":"nosql",
|
|
"title":"Creating a Parameter Template",
|
|
"uri":"nosql_06_0003.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"35"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify parameters in a specified parameter template, including parameter names, descriptions, and values.This API supports GaussDB(for Cassandra) inst",
|
|
"product_code":"nosql",
|
|
"title":"Modifying Parameters in a Parameter Template",
|
|
"uri":"nosql_06_0004.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"36"
|
|
},
|
|
{
|
|
"desc":"This API is used to apply a parameter template to one or more instances.This API supports GaussDB(for Cassandra) instances.This API is an asynchronous API. A successful r",
|
|
"product_code":"nosql",
|
|
"title":"Applying a Parameter Template",
|
|
"uri":"nosql_06_0005.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"37"
|
|
},
|
|
{
|
|
"desc":"This API is used to modify parameters of a specified instance.This API supports GaussDB(for Cassandra) instances.For configuration item values, you can enter system-defin",
|
|
"product_code":"nosql",
|
|
"title":"Modifying Parameters of a Specified Instance",
|
|
"uri":"nosql_06_0006.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"38"
|
|
},
|
|
{
|
|
"desc":"This API is used to query instance parameter settings.This API supports GaussDB(for Cassandra) instances.GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/co",
|
|
"product_code":"nosql",
|
|
"title":"Querying Instance Parameter Settings",
|
|
"uri":"nosql_06_0007.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"39"
|
|
},
|
|
{
|
|
"desc":"This API is used to obtain information about parameters of a specified parameter template.This API supports GaussDB(for Cassandra) instances.GET https://{Endpoint}/v3/{pr",
|
|
"product_code":"nosql",
|
|
"title":"Obtaining Parameters of a Specified Parameter Template",
|
|
"uri":"nosql_06_0008.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"40"
|
|
},
|
|
{
|
|
"desc":"This API is used to delete a specified parameter template.This API supports GaussDB(for Cassandra) instances.DELETE https://{Endpoint}/v3/{project_id}/configurations/{con",
|
|
"product_code":"nosql",
|
|
"title":"Deleting a Parameter Template",
|
|
"uri":"nosql_06_0009.html",
|
|
"doc_type":"api",
|
|
"p_code":"33",
|
|
"code":"41"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"nosql",
|
|
"title":"Tags",
|
|
"uri":"topic_300000005.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"42"
|
|
},
|
|
{
|
|
"desc":"This API is used to query a specified instance by tag.This API supports GaussDB(for Cassandra) instances.A maximum of 20 tags can be added to a DB instance. The tag key m",
|
|
"product_code":"nosql",
|
|
"title":"Querying an Instance by Tag",
|
|
"uri":"ListInstancesByResourceTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"43"
|
|
},
|
|
{
|
|
"desc":"This API is used to add tags to or delete tags from a specified DB instance in batches.This API supports GaussDB(for Cassandra) instances.A maximum of 20 tags can be adde",
|
|
"product_code":"nosql",
|
|
"title":"Adding or Deleting Resource Tags in Batches",
|
|
"uri":"BatchTagAction.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"44"
|
|
},
|
|
{
|
|
"desc":"This API is used to query tags of a specified instance.This API supports GaussDB(for Cassandra) instances.A maximum of 20 tags can be added to a DB instance. The tag key ",
|
|
"product_code":"nosql",
|
|
"title":"Querying Tags of an Instance",
|
|
"uri":"ListInstanceTags.html",
|
|
"doc_type":"api",
|
|
"p_code":"42",
|
|
"code":"45"
|
|
},
|
|
{
|
|
"desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
|
|
"product_code":"nosql",
|
|
"title":"Logs",
|
|
"uri":"topic_300000006.html",
|
|
"doc_type":"api",
|
|
"p_code":"13",
|
|
"code":"46"
|
|
},
|
|
{
|
|
"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 GaussDB(for Cassandra) instances.This A",
|
|
"product_code":"nosql",
|
|
"title":"Querying Database Slow Logs",
|
|
"uri":"ListSlowLogs.html",
|
|
"doc_type":"api",
|
|
"p_code":"46",
|
|
"code":"47"
|
|
},
|
|
{
|
|
"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":"48"
|
|
},
|
|
{
|
|
"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":"48",
|
|
"code":"49"
|
|
},
|
|
{
|
|
"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":"48",
|
|
"code":"50"
|
|
},
|
|
{
|
|
"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":"48",
|
|
"code":"51"
|
|
},
|
|
{
|
|
"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":"48",
|
|
"code":"52"
|
|
},
|
|
{
|
|
"desc":"This section describes GaussDB NoSQL metrics reported to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query metrics of ",
|
|
"product_code":"nosql",
|
|
"title":"Monitoring Metrics",
|
|
"uri":"nosql_metrics.html",
|
|
"doc_type":"api",
|
|
"p_code":"48",
|
|
"code":"53"
|
|
},
|
|
{
|
|
"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":"54"
|
|
}
|
|
] |