diff --git a/docs/gaussdb_nosql/api-ref/ALL_META.TXT.json b/docs/gaussdb_nosql/api-ref/ALL_META.TXT.json index b542b4306..ffb4b702d 100644 --- a/docs/gaussdb_nosql/api-ref/ALL_META.TXT.json +++ b/docs/gaussdb_nosql/api-ref/ALL_META.TXT.json @@ -1,4 +1,7 @@ [ + { + "dockw":"API Reference" + }, { "uri":"nosql_api_reference.html", "node_id":"nosql_api_reference.xml", diff --git a/docs/gaussdb_nosql/api-ref/BatchTagAction.html b/docs/gaussdb_nosql/api-ref/BatchTagAction.html index 1e209229b..4dd75a161 100644 --- a/docs/gaussdb_nosql/api-ref/BatchTagAction.html +++ b/docs/gaussdb_nosql/api-ref/BatchTagAction.html @@ -84,7 +84,7 @@

String

Operation identifier. The value can be:

- +

tags

diff --git a/docs/gaussdb_nosql/api-ref/ListApiVersion.html b/docs/gaussdb_nosql/api-ref/ListApiVersion.html index c8e8cc61c..9a9f1df07 100644 --- a/docs/gaussdb_nosql/api-ref/ListApiVersion.html +++ b/docs/gaussdb_nosql/api-ref/ListApiVersion.html @@ -112,7 +112,7 @@ -

Request Example

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

Example Requests

URI example
GET https://{Endpoint}/

Example Response

Status code: 200

diff --git a/docs/gaussdb_nosql/api-ref/ShowApiVersion.html b/docs/gaussdb_nosql/api-ref/ShowApiVersion.html index cf2d24e9a..38f2ca920 100644 --- a/docs/gaussdb_nosql/api-ref/ShowApiVersion.html +++ b/docs/gaussdb_nosql/api-ref/ShowApiVersion.html @@ -135,7 +135,7 @@
-

Request Example

URI example
GET https://{Endpoint}/v3
+

Example Requests

URI example
GET https://{Endpoint}/v3

Example Response

Status code: 200

diff --git a/docs/gaussdb_nosql/api-ref/nosql_05_0014.html b/docs/gaussdb_nosql/api-ref/nosql_05_0014.html index 49ec04242..9a8186cd8 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_05_0014.html +++ b/docs/gaussdb_nosql/api-ref/nosql_05_0014.html @@ -151,7 +151,7 @@

String

Instance type. The value can be:

-
  • Cluster: indicates that GaussDB(for Cassandra) cluster instances are supported.
+
  • Cluster, indicating that GaussDB(for Cassandra) cluster instances are supported.

flavor

@@ -200,7 +200,7 @@

Whether SSL is enabled.

The value can be:

-
  • 0: indicates that SSL is disabled by default.
  • 1: indicates that SSL is enabled by default.
  • If this parameter is not transferred, SSL is disabled by default.
+
  • 0, indicating that SSL is disabled by default.
  • 1, indicating that SSL is enabled by default.
  • If this parameter is not transferred, SSL is disabled by default.
@@ -234,7 +234,7 @@

String

Database version. The value can be:

-
  • 3.11: indicates that GaussDB(for Cassandra) 3.11 is supported.
+
  • 3.11, indicating that GaussDB(for Cassandra) 3.11 is supported.

storage_engine

@@ -244,7 +244,7 @@

String

Storage engine. The value can be:

-
  • rocksDB: indicates that the storage engine is RocksDB.
+
  • rocksDB, indicating that the storage engine is RocksDB.
@@ -481,7 +481,7 @@

String

Database version. The value can be:

-
  • 3.11: indicates that GaussDB(for Cassandra) 3.11 is supported.
+
  • 3.11, indicating that GaussDB(for Cassandra) 3.11 is supported.

storage_engine

@@ -489,7 +489,7 @@

String

Storage engine. The value can be:

-
  • rocksDB: indicates that the storage engine is RocksDB.
+
  • rocksDB, indicating that the storage engine is RocksDB.
diff --git a/docs/gaussdb_nosql/api-ref/nosql_06_0003.html b/docs/gaussdb_nosql/api-ref/nosql_06_0003.html index 9c1bf0a5f..68773d640 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_06_0003.html +++ b/docs/gaussdb_nosql/api-ref/nosql_06_0003.html @@ -123,7 +123,7 @@

String

Database type. The value can be:

-

cassandra: indicates that the target instances are of the GaussDB(for Cassandra) type.

+

cassandra, indicating that the target instances are of the GaussDB(for Cassandra) type.

version

@@ -133,7 +133,7 @@

String

Database version. The value can be:

-

3.11: indicates that GaussDB(for Cassandra) 3.11 is supported.

+

3.11, indicating that GaussDB(for Cassandra) 3.11 is supported.

diff --git a/docs/gaussdb_nosql/api-ref/nosql_06_0005.html b/docs/gaussdb_nosql/api-ref/nosql_06_0005.html index 6cc6d0157..0de7b03cb 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_06_0005.html +++ b/docs/gaussdb_nosql/api-ref/nosql_06_0005.html @@ -109,7 +109,7 @@

Boolean

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

-
  • true: indicates the task is successfully submitted.
  • false: indicates the task fails to be submitted.
+
  • true, indicating the task is successfully submitted.
  • false, indicating the task fails to be submitted.
diff --git a/docs/gaussdb_nosql/api-ref/nosql_06_0006.html b/docs/gaussdb_nosql/api-ref/nosql_06_0006.html index 003bbe907..9a8f6ebcb 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_06_0006.html +++ b/docs/gaussdb_nosql/api-ref/nosql_06_0006.html @@ -110,7 +110,7 @@

Boolean

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

-
  • true: indicates that the instance needs to be restarted.
  • false: indicates that the instance does not need to be restarted.
+
  • true, indicating that the instance needs to be restarted.
  • false, indicating that the instance does not need to be restarted.
diff --git a/docs/gaussdb_nosql/api-ref/nosql_06_0008.html b/docs/gaussdb_nosql/api-ref/nosql_06_0008.html index bd4c77220..8c4e7a641 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_06_0008.html +++ b/docs/gaussdb_nosql/api-ref/nosql_06_0008.html @@ -162,7 +162,7 @@

Boolean

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

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

readonly

@@ -170,7 +170,7 @@

Boolean

Whether the parameter is read-only. The value can be:

-
  • false: indicates that the parameter is not read-only.
  • true: indicates that the parameter is read-only.
+
  • false, indicating that the parameter is not read-only.
  • true, indicating that the parameter is read-only.

value_range

diff --git a/docs/gaussdb_nosql/api-ref/nosql_api_0030.html b/docs/gaussdb_nosql/api-ref/nosql_api_0030.html index ca6855007..8d2fb5653 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_api_0030.html +++ b/docs/gaussdb_nosql/api-ref/nosql_api_0030.html @@ -56,7 +56,7 @@

String

Backup policy type. This parameter is available only to GaussDB(for Cassandra). The value can be:

-
  • Instance: indicates that an instance backup is queried.
  • DatabaseTable: indicates that a database or table backup is queried.
+
  • Instance, indicating that an instance backup is queried.
  • DatabaseTable, indicating that a database or table backup is queried.
@@ -131,6 +131,20 @@

Backup retention days

+

differential_period

+ +

String

+ +

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

+ + +

incremental_period

+ +

String

+ +

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

+ +

start_time

String

@@ -186,7 +200,9 @@ "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", - "period" : "1,2,4,5,6" + "period" : "1,2,4,5,6", + "incremental_period": "0", + "differential_period": "0" }, "database_tables" : [ { "database_name" : "databaseNameA", diff --git a/docs/gaussdb_nosql/api-ref/nosql_database_version.html b/docs/gaussdb_nosql/api-ref/nosql_database_version.html index 2eb18ad15..00867782c 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_database_version.html +++ b/docs/gaussdb_nosql/api-ref/nosql_database_version.html @@ -33,7 +33,7 @@

String

Database type. The value can be:

-
  • cassandra: indicates that the instances are of the GaussDB(for Cassandra) type.
+
  • cassandra, indicating that the instances are of the GaussDB(for Cassandra) type.
diff --git a/docs/gaussdb_nosql/api-ref/nosql_instance_specification.html b/docs/gaussdb_nosql/api-ref/nosql_instance_specification.html index aade626d4..43717536e 100644 --- a/docs/gaussdb_nosql/api-ref/nosql_instance_specification.html +++ b/docs/gaussdb_nosql/api-ref/nosql_instance_specification.html @@ -47,7 +47,7 @@

String

Database type. The value can be:

-
  • cassandra: indicates that the instances are of the GaussDB(for Cassandra) type.
  • If this parameter is not transferred, the default value is cassandra.
+
  • cassandra, indicating that the instances are of the GaussDB(for Cassandra) type.
  • If this parameter is not transferred, the default value is cassandra.

offset