3.11 and 4.0
InfluxDB
+Cluster (performance-enhanced)
+1.7
+Typical Application Scenarios
-IoT
GeminiDB is compatible with Cassandra APIs. It is designed for write-intensive scenarios, specifically applied in manufacturing, logistics, health care, real estate, energy production, and agriculture. It can process data sent by different types of sensors for further analysis.
+IoT
GeminiDB is compatible with Cassandra. It is designed for write-intensive scenarios, specifically in manufacturing, logistics, health care, real estate, energy production, and agriculture sectors. It can process data from different types of sensors for further analysis.
Highlights
- High Write Performance: GeminiDB provides higher write performance than other NoSQL services.
- High Scalability: Compute nodes can be scaled in or out to flexibly cope with traffic surges or large writes loads at any time.
Highlights
- High Write Performance: GeminiDB provides higher write performance than other NoSQL services.
- Big Data Analysis: GeminiDB can work with Spark to provide recommendations to your customers in real-time.
Finance
With Spark′s big data analysis capabilities, GeminiDB helps companies in the finance sector build risk control systems and mitigate fraud.
+Finance
By leveraging big data analysis tools such as Spark, GeminiDB helps companies in the finance sector build risk control systems and mitigate fraud.
Highlights
Big Data Analysis: Spark and other big data processing technologies enable real-time fraud detection and prevention.
Securities and Cryptocurrency Transactions
GeminiDB Influx API stores user bank statements and builds an anti-fraud system for the financial industry.
+Highlights
+- Efficient query: GeminiDB Influx instances are deployed nearby, so they can quickly address queries.
- Real-time analysis: Series data can be synchronized to the cloud and can be analyzed in real time.
Real-Time Monitoring of Hardware and Software
GeminiDB Influx API stores user behavior data, accelerating user profiling and precision marketing.
+Highlights
+- GeminiDB Influx API handles trillions of data points per day and supports multi-node and multi-thread parallel queries.
- Real-time analysis: Series data can be synchronized to the cloud and can be analyzed in real time.
Environmental Protection Industry
GeminiDB Influx API supports writes of massive amounts of time series data, stable and reliable for environmental protection data collection.
+Highlights
+Efficient write and query: Vectorized query engines and efficient time series data query operators such as aggregation and convolution can process enormous concurrent writes and queries.
+- By default, you can create up to 500 security group rules. However, too many rules increase network latency for initial access, so it is recommended that you add no more than 50 rules for each security group.
Procedure
- Log in to the management console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Network, click Virtual Private Cloud.
- In the navigation pane on the left, choose .
- On the Security Groups page, click the security group name.
- On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
- In the displayed dialog box, set required parameters.
- Click OK.
Procedure
- Log in to the management console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Network, click Virtual Private Cloud.
- In the navigation pane on the left, choose .
- On the Security Groups page, click the security group name.
- On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
- In the displayed dialog box, set required parameters.
- Click OK.
Precautions
- By default, you can create up to 500 security group rules. However, too many rules increase network latency for initial access, so it is recommended that you add no more than 50 rules for each security group.
- To access a GeminiDB Cassandra instance from resources outside the security group, you need to configure an inbound rule to allow access to the GeminiDB Cassandra instance.
Procedure
- Log in to the management console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Network, click Virtual Private Cloud.
- In the navigation pane on the left, choose .
- On the Security Groups page, click the security group name.
- On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
- In the displayed dialog box, set required parameters.
- Click OK.
Procedure
- Log in to the management console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Network, click Virtual Private Cloud.
- In the navigation pane on the left, choose .
- On the Security Groups page, click the security group name.
- On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
- In the displayed dialog box, set required parameters.
- Click OK.
Getting Started with GeminiDB Influx
+ +Creating a GeminiDB Influx Instance
+This section describes how to create a GeminiDB Influx instance on the GeminiDB console.
+Procedure
- Log in to the GeminiDB console.
- On the Instances page, click Create DB Instance.
- On the displayed page, select your DB instance specifications, and click Create Now.
+
+ +
+Table 1 Basic information Parameter
+Description
+Region
+The region where the tenant is located. It can be changed in the upper left corner.
+NOTICE:+Select the region nearest where you will be accessing the DB from so latency can be kept to a minimum and response time will be faster. Also, products deployed in different regions cannot communicate with each other through a private network and you cannot change the region of an instance after creating the instance.
+DB Instance Name
+The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
+Compatible API
+InfluxDB
+Storage Type
+- Cloud native: more flexible, new-gen version with support for more AZsNOTE:+
Cloud native storage is only available to cluster (performance-enhanced) instances.
+
DB Instance Type
+Performance-enhanced cluster instances can be created.
+- Cluster: One cluster consists of at least three nodes. A cluster is easy to scale out to meet increasing data growth needs.
- Compared with cluster instances, instances in a performance-enhanced cluster support a larger scale and higher read/write performance.
DB Engine Version
+1.7
+AZ
+An AZ is a part of a region with its own independent power supplies and networks. AZs are physically isolated but can communicate through an internal network connection.
++ +
+Table 2 Specifications and storage Parameter
+Description
+Instance Specifications
+Performance specifications vary depending on the connections and maximum IOPS.
+Nodes
+The number of nodes ranges from 2 to 9. After an instance is created, you can add nodes. For details, see Adding Nodes.
+Storage Space
+The storage is an integer, and the minimum storage is 100 GB. You can add at least 10 GB each time.
++ +
+Table 3 Network Parameter
+Description
+VPC
+The virtual network where your DB instances are located. A VPC isolates networks for different services. You can select an existing VPC or create a VPC.
+If there are no VPCs available, the system allocates resources to you by default.
+For details on how to create a subnet, see the "Creating a VPC" section in the Virtual Private Cloud User Guide.
+NOTE:+After the GeminiDB Influx instance is created, the VPC where the instance resides cannot be changed.
+Subnet
+A subnet provides dedicated network resources that are logically isolated from other networks for network security.
+Security Group
+A security group controls access between GeminiDB Influx instances and other services. When you select a security group, you must ensure that it allows the client to access DB instances.
+If no security group is available, the system creates one for you.
+SSL
+Secure Sockets Layer (SSL) encrypts connections between clients and servers, preventing data from being tampered with or stolen during transmission.
++ +
+Table 4 Database configuration Parameter
+Description
+Administrator
+The default administrator account is rwuser.
+Administrator Password
+Set a password for the administrator. The password:
+- Must be 8 to 32 characters long.
- Must contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?
- For security reasons, you must select a strong password. The system will verify the password strength.
Keep this password secure. If you lose it, the system cannot retrieve it.
+Confirm Password
+Enter the administrator password again.
+Parameter Template
+A parameter template contains engine configuration values that can be applied to one or more instances.
+After a DB instance is created, you can modify parameters to better meet your service requirements. For details, see Modifying a Parameter Template.
+Enterprise Project
+This parameter is provided for enterprise users.
+An enterprise project groups cloud resources, so you can manage resources and members by project. The default project is default.
++ - Cloud native: more flexible, new-gen version with support for more AZs
- On the displayed page, confirm the DB instance details.
- If you need to modify the specifications, click Previous to return to the previous page.
- If you do not need to modify the specifications, click Submit to start creating the instance.
- On the Instances page, view and manage your DB instances.
- Creating a DB instance takes about 5 to 9 minutes. During the process, the instance status displayed in the DB instance list is Creating.
- After the creation is complete, the status changes to Available.
You can click
+
in the upper right corner of the page to refresh the DB instance statuses. - During creation, an automated backup policy is enabled by default. A full backup is automatically triggered after a DB instance is created.
- After a DB instance is created, the default database port is 8635 and cannot be changed.
Configuring Security Group Rules
+Scenarios
The default security group rule allows all outgoing data packets. ECSs and GeminiDB instances in the same security group can access each other. After a security group is created, you can define different access rules. After a GeminiDB instance is added to the security group, it is protected by the access rules.
+The following describes how to set security groups.
+Precautions
- If the ECS and DB instance are in the same security group, they can communicate with each other by default. No security group rule needs to be configured.
- If the ECS and DB instance are in different security groups, you need to configure security group rules for the ECS and DB instance separately.
- To allow access to the GeminiDB Influx instance, you need to configure an inbound rule for the security group where the instance resides.
- By default, the security group allows all outbound data packets, so you do not need to configure a security rule for the ECS. If not all access from the ECS is allowed, you need to configure an outbound rule for the ECS.
- By default, you can create up to 500 security group rules. However, too many rules increase network latency for initial access, so it is recommended that you add no more than 50 rules for each security group.
- Currently, a GeminiDB Influx instance can be associated with only one security group.
- Table 1 lists security group rules.
Scenario + |
+Description + |
+
|---|---|
Connecting to an instance over a private network + |
+Configure security group rules as follows:
+
|
+
Procedure
- Log in to the console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Networking, click Virtual Private Cloud.
- In the navigation pane on the left, choose .
- On the Security Groups page, click the security group name.
- On the Inbound Rules tab, click Add Rule. In the displayed Add Inbound Rule dialog box, set required parameters to add inbound rules. On the Outbound Rules tab, click Add Rule. In the displayed Add Outbound Rule dialog box, set required parameters to add outbound rules.
- Click OK.
Connecting to a GeminiDB Influx Instance Over Private Networks
+Scenarios
This section uses the Linux operating system as an example to describe how to connect an ECS to a GeminiDB Influx instance over private networks.
+Usage Notes
- The target instance and ECS must be in the same VPC and subnet.
- The ECS must be in a security group that can access the target instance.
- If the target instance is associated with the default security group, you do not need to configure security group rules for the instance and ECS.
- If the target instance is associated with a non-default security group, check whether the non-default security group rules allow the ECS to access the instance. For details, see section Configuring Security Group Rules.
- The default port of the GeminiDB Influx instance is 8635 and cannot be changed.
Prerequisites
+
The instance and ECS must be in the same VPC and subnet.
+- Download the InfluxDB client from the official website.
SSL Connection
- Log in to the ECS. For details, see section "Creating ECSs" in the Elastic Cloud Server User Guide.
- Upload the InfluxDB client installation package to the ECS.
- Decompress the client package.
tar -xzf influxdb-1.7.9-static_linux_amd64.tar.gz
+ - Connect your instance to the InfluxDB client.
- Run the following command to go to the InfluxDB directory:
cd influxdb-1.7.9-1
+ - Run the following command to connect to the InfluxDB shell:
./influx -ssl -host <DB_HOST> -port <DB_PORT>
+Example:
+./influx -ssl -host 192.168.1.201 -port 8635
+ - Run the auth command to authenticate the user.
auth
+Enter the username and password as prompted.
+username:<DB_USER>
+password:<DB_PWD>
+
+
- <DB_USER> indicates the administrator name. The default value is rwuser.
- <DB_PWD> indicates the administrator password.
- <DB_HOST> indicates the private IP address of the node to be connected. Obtain the value from the Private IP Address column in the node list on the Basic Information page.
If your instance has multiple nodes, select the private IP address of a node.
+ - <DB_PORT> indicates the port. The default value is 8635 and cannot be changed.
- Run the following command to go to the InfluxDB directory:
- After the authentication is successful, run the show databases command.
If the following information is displayed, the connection is successful.
+name: databases +name +---- +_internal
+
Non-SSL Connection
- Log in to the ECS. For details, see section "Creating ECSs" in the Elastic Cloud Server User Guide.
- Upload the InfluxDB client installation package to the ECS.
- Decompress the client package.
tar -xzf influxdb-1.7.9-static_linux_amd64.tar.gz
+ - Connect your instance to the InfluxDB client.
- Run the following command to go to the InfluxDB directory: +
- Run the following command to connect to the InfluxDB shell:
./influx -host <DB_HOST> -port <DB_PORT>
+Example:
+./influx -host 192.168.1.201 -port 8635
+ - Run the auth command to authenticate the user.
auth
+Enter the username and password as prompted.
+username:<DB_USER>
+password:<DB_PWD>
+
+ - <DB_USER> indicates the administrator name. The default value is rwuser.
- <DB_PWD> indicates the administrator password.
- <DB_HOST> indicates the private IP address of the node to be connected. Obtain the value from the Private IP Address column in the node list on the Basic Information page.
If your instance has multiple nodes, select the private IP address of a node.
+ - <DB_PORT> indicates the port. The default value is 8635 and cannot be changed.
- After the authentication is successful, run the show databases command.
show databases
+If the following information is displayed, the connection is successful.
+name: databases +name +---- +_internal
+
Usage Notes
- This feature is available only to new GeminiDB Cassandra instances.
- After the automated backup policy is enabled, the system performs an incremental backup based on the preset interval. The incremental backup data is stored in OBS.
- Data can be restored to a specified time point only after the automated backup policy is enabled.
- During instance restoration, backups are downloaded from the OBS bucket to the data directory of the restored instance.
Procedure
- Log in to the GeminiDB console.
- On the Instances page, click the target GeminiDB Cassandra instance.
- In the navigation pane on the left, click Backups & Restorations.
- On the Backups & Restorations page, click Restore to Point In Time.Figure 1 Restoring data to a specified point in time-
- Select the restoration date and the time point to which the data is restored and then click OK.Figure 2 Restore to Point in Time+
@@ -19,3 +19,10 @@Procedure
- Log in to the GeminiDB console.
- On the Instances page, click the target GeminiDB Cassandra instance.
- In the navigation pane on the left, click Backups & Restorations.
- On the Backups & Restorations page, click Restore to Point In Time.Figure 1 Restoring data to a specified point in time+
- Select the restoration date and the time point to which the data is restored and then click OK.Figure 2 Restore to Point in Time
- On the displayed page, create a DB instance of the same specifications as the DB instance to be restored. The new DB instance is independent from the original one.
- You are recommended to deploy the restored DB instance in a different AZ to ensure that your applications will not be adversely affected by the failure in any single AZ.
- The compatible API, DB instance type, DB instance version, and CPU type are the same as those of the original and cannot be changed.
- Other settings are the same as those of the original instance by default and can be modified. For details, see Creating a GeminiDB Cassandra Instance.
+
Precautions
- If you delete a DB instance, all the data in it and all automated backups are automatically deleted as well and cannot be restored, so exercise caution when performing this operation.
- If you delete an instance, all nodes in the instance are also deleted.
Procedure
- Log in to the GeminiDB console.
- On the Instances page, locate the instance you want to delete and choose More > Delete in the Operation column.
- On the displayed page, click Yes.
Deleted DB instances are not displayed in the instance list.
+Procedure
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose More > Delete in the Operation column.
- On the displayed page, click Yes.
Deleted DB instances are not displayed in the instance list.
Modifying an Automated Backup Policy
- Log in to the GeminiDB console.
- On the Instances page, click the DB instance you wish to modify the policy for.
- On the Backups & Restorations page, click Modify Backup Policy. In the displayed dialog box, set the backup policy. Then, click Yes to save the configuration.
For details about how to set a backup policy, see Automated Backup Policy.
- - Check or manage the generated backups on the Backup Management page or on the Backups & Restorations page.
Modifying an Automated Backup Policy
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, click Modify Backup Policy. In the displayed dialog box, set the backup policy. Then, click Yes to save the configuration.
For details about how to set a backup policy, see Automated Backup Policy.
+ - Check or manage the generated backups on the Backups or Backups & Restorations page.
Disabling Automated Backup Policy
- Log in to the GeminiDB console.
- On the Instances page, click the DB instance you wish to modify the policy for.
- On the Backups & Restorations page, click Modify Backup Policy.
- In the displayed dialog box, click
to disable the backup policy and click Yes.When disabling the automated backup policy, you can decide whether to delete the automated backups by selecting Delete automated backups.diff --git a/docs/geminidb/umn/nosql_03_0008.html b/docs/geminidb/umn/nosql_03_0008.html index 10d593072..e1a07fad8 100644 --- a/docs/geminidb/umn/nosql_03_0008.html +++ b/docs/geminidb/umn/nosql_03_0008.html @@ -5,11 +5,11 @@- If you select it, all backup files within the retention period will be deleted. No automated backups are displayed in the backup list until you enable the automated backup policy again.
- If you do not select it, all backup files within the retention period will be retained, but you can still manually delete them later if needed. For details, see section Deleting an Automated Backup.
Disabling Automated Backup Policy
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, click Modify Backup Policy.
- In the displayed dialog box, click
to disable the backup policy and click Yes.When disabling the automated backup policy, you can decide whether to delete the automated backups by selecting Delete automated backups.- If you select it, all backup files within the retention period will be deleted. No automated backups are displayed in the backup list until you enable the automated backup policy again.
- If you do not select it, all backup files within the retention period will be retained, but you can still manually delete them later if needed. For details, see section Deleting an Automated Backup.
If the automated backup policy is disabled, any automated backups in progress stop immediately.
Deleting an Automated Backup
If the automated backup policy is disabled, you can delete stored automated backups to free up storage space.
-If the automated backup policy is enabled, the system will delete automated backups as they expire. You cannot delete them manually.
+If the automated backup policy is enabled, the system will delete automated backups as they expire. You cannot delete them.
- The deletion operation is irreversible, so exercise caution when performing this operation.
- Method 1
- On the Instances page, click the DB instance you wish to delete backups for.
- On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
- In the Delete Backup dialog box, confirm the backup information and click Yes.
- Method 2
- On the Backup Management page, locate the target backup and click Delete.
- In the Delete Backup dialog box, confirm the backup information and click Yes.
- Method 1
- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
- In the Delete Backup dialog box, confirm the backup information and click Yes.
- Method 2
- On the Backups page, locate the target backup and click Delete.
- In the Delete Backup dialog box, confirm the backup information and click Yes.
- By default, you can create up to 50 backups.
- Manual backups are full backups.
Creating a Manual Backup
- Log in to the GeminiDB console.
- Create a manual backup.
Method 1
-On the Instance Management page, locate the DB instance you wish to back up and click Create Backup or in the Operation column.
-Method 2-- On the Instance Management page, click the DB instance you wish to back up.
- On the Backups & Restorations page, click Create Backup.
On the Instances page, locate the target instance and click Create Backup in the Operation column.
+Method 2- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, click Create Backup.
Method 3
-In the navigation pane on the left, choose Backup Management. On the displayed page, click Create Backup.
+In the navigation pane, choose Backups. On the displayed page, click Create Backup.
- In the displayed dialog box, enter the backup name and description, and click OK.
-Table 1 Parameter description Parameter
- View the backup status after the task has been executed.
- During the creation of a manual backup, you can query the backup status on the Backup Management page or the Backups & Restorations page. The backup status is Backing up.
- If a manual backup was successfully created, the backup status is Completed.
- View the backup status after the task has been executed.
- While creating a manual backup, you can query the backup status on the Backups page or the Backups & Restorations page. The backup status becomes Backing up.
- If a manual backup was successfully created, the backup status is Completed.
Deleting a Manual Backup
If you do not need the manual backup, you can delete it on the Backup Management page or the Backups & Restorations page.
+Deleting a Manual Backup
If you do not need the manual backup, you can delete it on the Backups or Backups & Restorations page.
Deleted backups are not displayed in the backup list.
- The deletion operation is irreversible, so exercise caution when performing this operation.
Method 1- On the Instance Management page, click the DB instance whose backup you wish to delete.
- On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
- In the Delete Backup dialog box, confirm the backup details and click Yes.
Method 1- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
- In the Delete Backup dialog box, confirm the backup details and click Yes.
Method 2
-- On the Backup Management page, locate the target backup and click Delete.
- In the Delete Backup dialog box, confirm the backup details and click Yes.
- On the Backups page, locate the target backup and click Delete.
- In the Delete Backup dialog box, confirm the backup details and click Yes.
diff --git a/docs/geminidb/umn/nosql_03_0009.html b/docs/geminidb/umn/nosql_03_0009.html index b034d03c9..b0bb26cfc 100644 --- a/docs/geminidb/umn/nosql_03_0009.html +++ b/docs/geminidb/umn/nosql_03_0009.html @@ -4,14 +4,14 @@diff --git a/docs/geminidb/umn/nosql_03_0011.html b/docs/geminidb/umn/nosql_03_0011.html index 3462a790d..f981f86bf 100644 --- a/docs/geminidb/umn/nosql_03_0011.html +++ b/docs/geminidb/umn/nosql_03_0011.html @@ -6,573 +6,573 @@Scenarios
You can restore an existing backup to a new GeminiDB Cassandra instance.
Procedure
- Log in to the GeminiDB console.
- Restore a backup.
Method 1
-- On the Instance Management page, click the target DB instance.
- On the Backups & Restorations page, locate the target backup and click Restore.
- On the Instances page, click the target instance.
- On the Backups & Restorations page, locate the target backup and click Restore.
Method 2
-On the Backup Management page, locate the target backup and click Restore.
- - In the displayed dialog box, confirm the current instance details and restoration method and click OK.
- The default API type and DB engine version are the same as those of the original instance and cannot be changed.
- The system automatically calculates the minimum storage space required for restoring the new instance based on the size of the selected backup file. The storage space must be an integer multiple of 1.
- You need to set a new administrator password.
On the Backups page, locate the target backup and click Restore.
+ - In the displayed dialog box, confirm the current instance details and restoration method and click OK.
- The default API type and DB engine version are the same as those of the original instance and cannot be changed.
- The system automatically calculates the minimum storage space required for restoring the new instance based on the size of the selected backup file. The storage space must be an integer multiple of 1 GB.
- You need to set a new administrator password.
- To modify other parameters, see the description of creating DB instances of other DB engines in the Getting Started.
- View the restoration results.
A new DB instance is created using the backup data. The status of the DB instance changes from Creating to Available.
After the restoration, the system will perform a full backup.
-The new DB instance is independent from the original one.
+The new DB instance is independent of the original one.
Namespace
SYS.NoSQL
Metrics
-Table 1 Metrics Metric
+Table 1 Metrics Metric ID
Name
+Name
Description
+Description
Value Range
+Value Range
Monitored Object
+Monitored Object
Monitoring Interval (Raw Data)
+Monitoring Interval (Raw Data)
nosql005_disk_usage
+nosql005_disk_usage
Storage Space Usage
+Storage Space Usage
Storage space usage of the monitored object
+Storage space usage of the monitored object
Unit: %
0–100
+0–100
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB instance
1 minute
+1 minute
nosql006_disk_total_size
+nosql006_disk_total_size
Total Storage Space
+Total Storage Space
Total storage space of the monitored object
+Total storage space of the monitored object
Unit: GB
≥ 0
+≥ 0
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB instance
1 minute
+1 minute
nosql007_disk_used_size
+nosql007_disk_used_size
Used Storage Space
+Used Storage Space
Used storage space of the monitored object
+Used storage space of the monitored object
Unit: GB
≥ 0
+≥ 0
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB instance
1 minute
+1 minute
cassandra001_cpu_usage
+cassandra001_cpu_usage
CPU Usage
+CPU Usage
CPU usage of an instance
+CPU usage of an instance
Unit: %
0–100
+0–100
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra002_mem_usage
+cassandra002_mem_usage
Memory Usage
+Memory Usage
Memory usage of the instance
+Memory usage of the instance
Unit: %
0–100
+0–100
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra003_bytes_out
+cassandra003_bytes_out
Network Output Throughput
+Network Output Throughput
Outgoing traffic in bytes per second
+Outgoing traffic in bytes per second
Unit: byte/s
≥ 0
+≥ 0
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra004_bytes_in
+cassandra004_bytes_in
Network Input Throughput
+Network Input Throughput
Incoming traffic in bytes per second
+Incoming traffic in bytes per second
Unit: byte/s
≥ 0
+≥ 0
Measured object: ECS
+Measured object: ECS
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra014_connections
+cassandra014_connections
Active Node Connections
+Active Node Connections
Total number of connections attempting to connect to Cassandra instance nodes
+Total number of connections attempting to connect to Cassandra instance nodes
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra015_read_latency
+cassandra015_read_latency
Average Read Latency
+Average Read Latency
Average amount of time consumed by read requests
+Average amount of time consumed by read requests
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra016_write_latency
+cassandra016_write_latency
Average Write Latency
+Average Write Latency
Average amount of time consumed by write requests
+Average amount of time consumed by write requests
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra037_pending_write
+cassandra037_pending_write
Suspended Write Tasks
+Suspended Write Tasks
Number of write tasks in waiting status
+Number of write tasks in waiting status
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra038_pending_read
+cassandra038_pending_read
Suspended Read Tasks
+Suspended Read Tasks
Number of read tasks in waiting status
+Number of read tasks in waiting status
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra044_range_slice_latency
+cassandra044_range_slice_latency
Scan Duration
+Scan Duration
Average amount of time consumed by scan operations
+Average amount of time consumed by scan operations
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra049_dropped_mutation
+cassandra049_dropped_mutation
Dropped Writes
+Dropped Writes
Average number of dropped writes
+Average number of dropped writes
Unit: times
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra052_dropped_read
+cassandra052_dropped_read
Dropped Reads
+Dropped Reads
Average number of dropped reads
+Average number of dropped reads
Unit: times
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra092_load_info
+cassandra092_load_info
Data Volume on a Node
+Data Volume on a Node
Data volume on a node
+Data volume on a node
Unit: byte
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra093_write_count_latency
+cassandra093_write_count_latency
Accumulated Write Requests
+Accumulated Write Requests
Total number of write requests initiated by a node
+Total number of write requests initiated by a node
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra094_write_1min_rate
+cassandra094_write_1min_rate
Average Write Rate in the Last Minute
+Average Write Rate in the Last Minute
Average write rate in the last minute
+Average write rate in the last minute
Unit: times
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra095_write_p75_latency
+cassandra095_write_p75_latency
P75 Write Latency
+P75 Write Latency
P75 write latency
+P75 write latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra096_write_p95_latency
+cassandra096_write_p95_latency
P95 Write Latency
+P95 Write Latency
P95 write latency
+P95 write latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra097_write_p99_latency
+cassandra097_write_p99_latency
P99 Write Latency
+P99 Write Latency
P99 write latency
+P99 write latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra098_read_count_latency
+cassandra098_read_count_latency
Accumulated Read Requests
+Accumulated Read Requests
Total number of read requests initiated by a node
+Total number of read requests initiated by a node
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra099_read_1min_rate
+cassandra099_read_1min_rate
Average Read Rate in the Last Minute
+Average Read Rate in the Last Minute
Average read rate in the last minute
+Average read rate in the last minute
Unit: times
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra100_read_p75_latency
+cassandra100_read_p75_latency
P75 Read Latency
+P75 Read Latency
P75 read latency
+P75 read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra101_read_p95_latency
+cassandra101_read_p95_latency
P95 Read Latency
+P95 Read Latency
P95 read latency
+P95 read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra102_read_p99_latency
+cassandra102_read_p99_latency
P99 Read Latency
+P99 Read Latency
P99 read latency
+P99 read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra103_range_slice_count_latency
+cassandra103_range_slice_count_latency
Accumulated Range Read Requests
+Accumulated Range Read Requests
Accumulated range read requests
+Accumulated range read requests
Unit: times
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra104_range_slice_1min_rate
+cassandra104_range_slice_1min_rate
Average Range Read Rate in the Last Minute
+Average Range Read Rate in the Last Minute
Average range read rate in the last minute
+Average range read rate in the last minute
Unit: times
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra105_range_slice_p75_latency
+cassandra105_range_slice_p75_latency
P75 Range Read Latency
+P75 Range Read Latency
P75 range read latency
+P75 range read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra106_range_slice_p95_latency
+cassandra106_range_slice_p95_latency
P95 Range Read Latency
+P95 Range Read Latency
P95 range read latency
+P95 range read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra107_range_slice_p99_latency
+cassandra107_range_slice_p99_latency
P99 Range Read Latency
+P99 Range Read Latency
P99 range read latency
+P99 range read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra163_write_p999_latency
+cassandra163_write_p999_latency
P999 Write Latency
+P999 Write Latency
P999 write latency
+P999 write latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra164_read_p999_latency
+cassandra164_read_p999_latency
P999 Read Latency
+P999 Read Latency
P999 read latency
+P999 read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra165_large_partition_num
+cassandra165_large_partition_num
Large Keys
+Large Keys
Number of large keys on the current node
+Number of large keys on the current node
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra166_write_max_latency
+cassandra166_write_max_latency
Maximum Write Latency
+Maximum Write Latency
Maximum write latency
+Maximum write latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra167_read_max_latency
+cassandra167_read_max_latency
Maximum Read Latency
+Maximum Read Latency
Maximum read latency
+Maximum read latency
Unit: ms
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
cassandra168_imbalance_table_num
+cassandra168_imbalance_table_num
Tables with Uneven Data Distribution
+Tables with Uneven Data Distribution
Number of tables in which data is not evenly distributed.
+Number of tables in which data is not evenly distributed.
Unit: count
≥ 0
+≥ 0
Monitored object: database
+Monitored object: database
Monitored object: GeminiDB Cassandra instance node
1 minute
+1 minute
- The DB instance has been properly running for at least 10 minutes.
The monitoring data and graphics are available for a new DB instance after the instance runs for at least 10 minutes.
diff --git a/docs/geminidb/umn/nosql_03_0015.html b/docs/geminidb/umn/nosql_03_0015.html index e4006ded8..79267f1b6 100644 --- a/docs/geminidb/umn/nosql_03_0015.html +++ b/docs/geminidb/umn/nosql_03_0015.html @@ -23,7 +23,7 @@Procedure
- Log in to the GeminiDB console.
- On the Instance Management page, click the target DB instance.
- In the Node Information area on the Basic Information page, click View Metric in the Operation column.
- In the monitoring area, you can select a duration to view the monitoring data.
You can view the monitoring data of the service in the last 1, 3, or 12 hours.
-To view the monitoring curve in a longer time range, click
+
to enlarge the graph.Procedure
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the Node Information area on the Basic Information page, click View Metric in the Operation column.
- In the monitoring area, you can select a duration to view the monitoring data.
You can view the monitoring data of the service in the last 1, 3, or 12 hours.
+To view the monitoring curve in a longer time range, click
to enlarge the graph.
Parameter description:
The common parameters are as follows: NUMPROCESSES, RATEFILE, PAGESIZE, BEGINTOKEN, ENDTOKEN, MAXATTEMPTS, and MAXOUTPUTSIZE.
The newly added parameters are as follows: RESULTFILE, DATAFORMATS, and WHERECONDITION.
-For details about other COPY TO parameters, see the Cassandra official documentation.
+For details about other COPY TO parameters, see Cassandra Documentation.
- file name: specifies the directory or file the data is copied to. The data is exported to a file by default.
- If you specify an existing directory to export the file, the system exports data to different files in the directory based on the specified range. If no data is exported for a given range, no file is generated.
./cqlsh <DB_HOST> -e "COPY cycling.cyclist_name TO '/home/cas/copydata'"
- When you specify a file name, data is exported to the file. If the file does not exist, the system automatically creates a file as you named it.
./cqlsh <DB_HOST> -e "COPY cycling.cyclist_name TO '/home/cas/copydata/cycling.cyclist_name'"
Parameter description:
The common parameters are as follows: NUMPROCESSES, MAXROWS, INGESTRATE, ERRFILE, MAXBATCHSIZE, MINBATCHSIZE, CHUNKSIZE, MAXPARSEERRORS, MAXINSERTERRORS, SKIPROWS, and SKIPCOLS.
The newly added parameter is DATAFORMATS.
-For details about other COPY FROM parameters, see the Cassandra official documentation.
+For details about other COPY FROM parameters, see the Cassandra Documentation.
- file name is the path the file will be imported to. The value can be a directory, a file, or a list of file names separated by commas (,). If the value is set to a specified directory, all files in the directory are imported.
- NUMPROCESSES is the number of imported threads.
- MAXROWS is the maximum number of rows to be imported. By default, the number of rows is not limited.
- INGESTRATE is the maximum number of rows to be imported per second. The default value is 100000.
- ERRFILE: The columns that fail to be imported are stored in this file.
- MAXBATCHSIZE is the maximum number of rows to be imported in each batch. The default value is 20.
- MINBATCHSIZE is the minimum number of rows to be imported in each batch. The default value is 2.
- CHUNKSIZE is the number of rows that the main thread transfers to a child thread each time. The default value is 1000.
- MAXPARSEERRORS: indicates the maximum number of rows whose syntax parsing errors can be ignored. By default, the number of rows is not limited.
- MAXINSERTERRORS: indicates the maximum number of rows that can be ignored when the rows fail to be inserted. The default value is 1000.
- SKIPROWS is the number of rows that are skipped during the import. The default value is 0, meaning that no row is skipped.
- SKIPCOLS is the names of the columns that are ignored during the import. The column names are separated by commas (,). The value is not ignored by default.
- DATAFORMATS is the data format to be imported. The value can be csv or json. The default value is csv. If the data is in JSON format, set this value to json.
Querying Traces
After CTS is enabled, CTS starts recording operations on cloud resources. The CTS console stores the last seven days of operation records.
This section describes how to query operation records for the last 7 days on the CTS console.
-Procedure
- Log in to the management console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Management & Deployment, click Cloud Trace Service.
- Choose Trace List in the navigation pane on the left.
- Specify the filters used for querying traces. The following four filters are available:
- Trace Source, Resource Type, Search By, and Operator
Select the filter from the drop-down list.
+Procedure
- Log in to the management console.
- Click
in the upper left corner and select a region and a project. - Click Service List. Under Management & Deployment, click Cloud Trace Service.
- Choose Trace List in the navigation pane on the left.
- Specify the filters used for querying traces. The following four filters are available:
- Trace Source, Resource Type, Search By, and Operator
Select the filter from the drop-down list.
When you select Trace name for Search By, you also need to select a specific trace name.
When you select Resource ID for Search By, you also need to select or enter a specific resource ID.
When you select Resource name for Search By, you also need to select or enter a specific resource name.
- Operator: Select a specific operator (a user rather than tenant).
- Trace Status: Available options include All trace statuses, normal, warning, and incident. You can only select one of them.
- Start time and end time: You can specify the time period for query traces.
- Trace Source, Resource Type, Search By, and Operator
- Click
to the left of the record to be queried to extend its details. - Locate a trace and click View Trace in the Operation column.
- Click
to the left of the record to be queried to extend its details.- Locate a trace and click View Trace in the Operation column.
- Trace Source, Resource Type, Search By, and Operator
diff --git a/docs/geminidb/umn/nosql_03_0025.html b/docs/geminidb/umn/nosql_03_0025.html index 6d9f2a40c..e456784ce 100644 --- a/docs/geminidb/umn/nosql_03_0025.html +++ b/docs/geminidb/umn/nosql_03_0025.html @@ -3,12 +3,12 @@Changing a DB Instance Name
-Scenarios
This section describes how to change a GeminiDB Cassandra instance name to identify different DB instances.
Method 1
- Log in to the GeminiDB console.
- On the Instances page, click
to the right of the instance whose name you wish to change.- To submit the change, click OK.
The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
+-Method 1
- Log in to the GeminiDB console.
- On the Instances page, click
to the right of the instance whose name you wish to change.- To submit the change, click OK.
The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
- To cancel the change, click Cancel.
- To submit the change, click OK.
- View the results on the Instances page.
diff --git a/docs/geminidb/umn/nosql_03_0028.html b/docs/geminidb/umn/nosql_03_0028.html index fa12a0723..a0b7e4c4e 100644 --- a/docs/geminidb/umn/nosql_03_0028.html +++ b/docs/geminidb/umn/nosql_03_0028.html @@ -3,7 +3,7 @@Method 2
- Log in to the GeminiDB console.
- On the Instances page, click the instance whose name you wish to change.
- In the Instance Information area on the Basic Information page, click
in the DB Instance Name field to change the instance name.- To submit the change, click
.The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
- - To cancel the change, click
.
Method 2
- Log in to the GeminiDB console.
- On the Instances page, click the instance whose name you wish to change.
- In the Instance Information area on the Basic Information page, click
in the DB Instance Name field to change the instance name.- To submit the change, click
.The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
+ - To cancel the change, click
.
- To submit the change, click
- View the results on the Instances page.
- To submit the change, click
Slow Query Logs
-Scenarios
GeminiDB allows you to view slow query logs of databases. The unit of the execution time is ms. With slow query logs, you can identify and optimize slowly executed statements.
Viewing Log Details
- Log in to the GeminiDB console.
- On the Instance Management page, click the target DB instance.
- In the navigation pane on the left, click Slow Query Logs.
- On the Slow Query Logs page, set search criteria and click Search to view log information.
- If you select All nodes, the slow query logs of all nodes in the DB instance are displayed.
- Slow query logs of a node in different time periods
- Slow query statements of the following level
+diff --git a/docs/geminidb/umn/nosql_03_0201.html b/docs/geminidb/umn/nosql_03_0201.html new file mode 100644 index 000000000..991e9cbc9 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0201.html @@ -0,0 +1,22 @@ + + +
Viewing Log Details
- Log in to the GeminiDB console.
- On the Instances page, click the target instance.
- In the navigation pane on the left, click Slow Query Logs.
- On the Slow Query Logs page, set search criteria and click Search to view log information.
- If you select All nodes, the slow query logs of all nodes in the DB instance are displayed.
- Slow query logs of a node in different time periods
- Slow query statements of the following level
Recycle Bin
++Deleted GeminiDB instances will be moved to the recycle bin, so you can restore them if necessary.
++Usage Notes
- If an instance is abnormal, it will not be moved to the recycle bin after being deleted.
- The recycle bin is enabled by default and cannot be disabled. Instances in the recycle bin can be retained for 7 days by default. This function is free of charge.
- Operations after an instance is deleted
- If there are fewer than 100 backups (including automated full backups) in the recycle bin, the system retains the automated full backup from one day prior if available; otherwise, the latest one is retained. The system will also generate a new full backup. You can select one of the backups to rebuild the instance.
- If there are 100 or more backups (including automated full backups) in the recycle bin, the system retains the automated full backup from one day prior if available; otherwise, the latest one is retained. You can select this backup to rebuild the instance.
+Modifying the Recycling Policy
+ You can modify the retention period, and the changes only apply to the DB instances deleted after the changes, so exercise caution when performing this operation.
+- Log in to the GeminiDB console.
- On the Recycle Bin page, click Modify Recycling Policy. In the displayed dialog box, set the retention period (range: 1 to 7 days) for the deleted instances. Then, click OK.
+Rebuilding a DB instance
You can rebuild DB instances from the recycle bin within the retention period to restore data.
+- Log in to the GeminiDB console.
- On the Recycle Bin page, locate the target instance and click Rebuild in the Operation column.
- On the displayed page, set required parameters and submit the rebuilding task.
++ diff --git a/docs/geminidb/umn/nosql_03_0211.html b/docs/geminidb/umn/nosql_03_0211.html new file mode 100644 index 000000000..7fab8fac3 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0211.html @@ -0,0 +1,20 @@ + + +++Parent topic: DB Instance Management+Resetting the Administrator Password
+++Scenarios
For security reasons, change administrator passwords periodically.
++Usage Notes
If the instance status is Available, Backing up, Checking restoration, Scaling up or certain nodes become abnormal, you can reset the administrator password.
++Method 1
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the DB Information area, click Reset Password in the Administrator field.
- Enter and confirm the new administrator password and click OK.
The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?
+
+Method 2
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose More > Reset Password in the Operation column.
- Enter and confirm the new administrator password and click OK.
The password must be 8 to 32 characters in length and contain uppercase letters, lowercase letters, digits, and any of the following special characters: ~!@#%^*-_=+?
+
++ diff --git a/docs/geminidb/umn/nosql_03_0212.html b/docs/geminidb/umn/nosql_03_0212.html new file mode 100644 index 000000000..3ff575b72 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0212.html @@ -0,0 +1,18 @@ + + +++Parent topic: DB Instance Management+Restarting a DB Instance
+++Scenarios
You may need to occasionally restart a DB instance to perform routine maintenance.
++Precautions
- If the instance status is Available, Abnormal, or Checking restoration, you can restart the instance.
- Restarting a DB instance interrupts services, so exercise caution when performing this operation.
- If you restart a DB instance, all nodes in the instance are also restarted.
+Restarting a DB Instance
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose in the Operation column.
Alternatively, click the target DB instance, and on the displayed Basic Information page, click Restart in the upper right corner of the page.
+ - In the displayed dialog box, click Yes.
For GeminiDB Influx instances, you can restart several nodes at the same time or in sequence based on service requirements.
+
++ diff --git a/docs/geminidb/umn/nosql_03_0213.html b/docs/geminidb/umn/nosql_03_0213.html new file mode 100644 index 000000000..fa3ff1f0f --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0213.html @@ -0,0 +1,24 @@ + + +++Parent topic: DB Instance Management+Adding Nodes
+++Scenarios
This section describes how to add nodes to a DB instance to suit your service requirements. A node cannot be deleted after being added.
++Usage Notes
- Adding nodes may lead to the decrease of OPS. You are advised to perform this operation during off-peak hours.
- You can only add nodes when the instance status is Available or Checking restoration.
- A DB instance cannot be deleted when one or more nodes are being added.
+Method 1
- Log in to the GeminiDB console.
- On the Instances page, click the target instance.
- In the Node Information area on the Basic Information page, click Add Node.
- Specify Add Nodes and click Next.
- By default, the specifications of new nodes are the same as the instance specifications and cannot be modified.
- A GeminiDB Influx instance supports a maximum of nine nodes.
- On the displayed page, confirm node configurations.
- To modify the configuration, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit to add the nodes.
- View the result of adding nodes.
- The status of the DB instance in the instance list is Adding node.
- After the nodes are added, the DB instance status becomes Available.
- Click the DB instance name. In the Node Information area on the Basic Information page, view the information about the new nodes.
+Method 2
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose in the Operation column.
- Specify Add Nodes and click Next.
- By default, the specifications of new nodes are the same as the instance specifications and cannot be modified.
- On the displayed page, confirm node configurations.
- To modify the configuration, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit to add the nodes.
- View the result of adding nodes.
- The status of the DB instance in the instance list is Adding node.
- After the nodes are added, the DB instance status becomes Available.
- Click the DB instance name. In the Node Information area on the Basic Information page, view the information about the new nodes.
++ diff --git a/docs/geminidb/umn/nosql_03_0214.html b/docs/geminidb/umn/nosql_03_0214.html new file mode 100644 index 000000000..c559553ba --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0214.html @@ -0,0 +1,22 @@ + + +++Parent topic: DB Instance Management+Changing the CPU and Memory of an Instance
+++Scenarios
This section describes how to change the CPU or memory of your instance to suit your service requirements.
++Usage Notes
- Instances can be scaled up or down.
- Services will be interrupted for 5 to 10 minutes when you change DB instance CPU or memory, so you are advised to perform these operations during off-peak hours.
+Method 1
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the DB Information area, click Change in the Instance Class field.
- On the displayed page, select new specifications and click Next.
- On the displayed page, confirm the instance class.
- If you need to modify your settings, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit.
- Check the change results.
Go to the Basic Information page. In the Specification Information area, you can see the new instance specifications.
+
+Method 2
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose in the Operation column.
- On the displayed page, select new specifications and click Next.
- On the displayed page, confirm the instance class.
- If you need to modify your settings, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit.
- Check the change results.
Go to the Basic Information page. In the Specification Information area, you can see the new instance specifications.
+
++ diff --git a/docs/geminidb/umn/nosql_03_0216.html b/docs/geminidb/umn/nosql_03_0216.html new file mode 100644 index 000000000..f20e450c3 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0216.html @@ -0,0 +1,21 @@ + + +++Parent topic: DB Instance Management+Recycling an Instance
+++Usage Notes
- If an instance is abnormal, it will not be moved to the recycle bin after being deleted.
- The recycle bin is enabled by default and cannot be disabled. Instances in the recycle bin can be retained for 7 days by default. This function is free of charge.
- Operations after an instance is deleted
- If there are fewer than 100 backups (including automated full backups) in the recycle bin, the system retains the automated full backup from one day prior if available; otherwise, the latest one is retained. The system will also generate a new full backup. You can select one of the backups to rebuild the instance.
- If there are 100 or more backups (including automated full backups) in the recycle bin, the system retains the automated full backup from one day prior if available; otherwise, the latest one is retained. You can select this backup to rebuild the instance.
+Modifying the Recycling Policy
+ You can modify the retention period, and the changes only apply to the DB instances deleted after the changes, so exercise caution when performing this operation.
+- Log in to the GeminiDB console.
- On the Recycle Bin page, click Modify Recycling Policy. In the displayed dialog box, set the retention period (range: 1 to 7 days) for the deleted instances. Then, click OK.
+Rebuilding a DB Instance
Within the retention period, you can rebuild an instance from its backup.
+- Log in to the GeminiDB console.
- On the Recycle Bin page, locate the target instance and click Rebuild in the Operation column.
- On the displayed page, set required parameters and submit the rebuilding task.
++ diff --git a/docs/geminidb/umn/nosql_03_0231.html b/docs/geminidb/umn/nosql_03_0231.html new file mode 100644 index 000000000..074069998 --- /dev/null +++ b/docs/geminidb/umn/nosql_03_0231.html @@ -0,0 +1,17 @@ + + +++Parent topic: DB Instance Management+Overview
++GeminiDB Influx API supports backups and restorations to ensure data reliability.
+Data can be backed up automatically or manually.
++ +Automated Backup
Automated backups are created during the backup time window of your GeminiDB Influx instances. GeminiDB saves automated backups based on a specified retention period. You can restore data to any point in time within the backup retention period.
++Manual Backup
Manual backups are full backups that you initiated. They are retained until you delete them manually.
+++ diff --git a/docs/geminidb/umn/nosql_04_change_history.html b/docs/geminidb/umn/nosql_04_change_history.html index 91328071c..f4bacb237 100644 --- a/docs/geminidb/umn/nosql_04_change_history.html +++ b/docs/geminidb/umn/nosql_04_change_history.html @@ -8,7 +8,13 @@ -++Parent topic: Backup and Restoration+2025-02-28
+2025-10-28
+This issue is the tenth official release, which incorporates the following change:
+Added GeminiDB Influx API.
+2025-02-28
This issue is the ninth official release.
Added Restoring a Backup to a Specified Point in Time.
diff --git a/docs/geminidb/umn/nosql_05_0002.html b/docs/geminidb/umn/nosql_05_0002.html index 45c8b38e6..0b1b6a542 100644 --- a/docs/geminidb/umn/nosql_05_0002.html +++ b/docs/geminidb/umn/nosql_05_0002.html @@ -3,8 +3,8 @@Creating a Parameter Template
You can use database parameter templates to manage the DB engine configuration. A database parameter template acts as a container for engine configuration values that can be applied to one or more DB instances.
Each user can create up to 100 parameter templates. All types of instances in the same project can share the quota.
-Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Parameter Template Management.
- On the Parameter Template Management page, click Create Parameter Template.
- Select a compatible DB engine version, name the parameter group, add the parameter group description, and click OK to create a parameter group template.
- Compatible API: Select the API type that is compatible with your DB engine parameter template.
- DB Engine Version: Select a DB engine version, for example, 3.11.
- Parameter Template Name: The template name must consist of 1 to 64 characters. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
- Description: The description can contain a maximum of 256 characters except the carriage return character and the following special characters: > ! < " & ' =
- On the Parameter Template Management page, view the created parameter template.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click Create Parameter Template.
- Select a compatible DB engine version, name the parameter group, add the parameter group description, and click OK to create a parameter group template.
- Compatible API: Select the API type that is compatible with your DB engine parameter template.
- DB Engine Version: Select a DB engine version, for example, 3.11.
- Parameter Template Name: The template name must consist of 1 to 64 characters. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
- Description: The description can contain a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
- On the Parameter Templates page, view the created parameter template.
diff --git a/docs/geminidb/umn/nosql_05_0003.html b/docs/geminidb/umn/nosql_05_0003.html index 8f80e7dae..cb7d49d67 100644 --- a/docs/geminidb/umn/nosql_05_0003.html +++ b/docs/geminidb/umn/nosql_05_0003.html @@ -5,15 +5,15 @@Note that parameter values in default parameter templates cannot be changed.
- Though parameter values in a default template cannot be changed, you can view details about a default parameter template. If a custom parameter template is set incorrectly, the database startup may fail. You can re-configure the custom parameter template according to the configurations of the default parameter template.
Modifying Parameters in Custom Parameter Template
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Parameter Template Management.
- In the navigation pane on the left, choose Parameter Template Management. On the Custom Templates tab, click the parameter template you wish to modify.
- Change parameter values as required.
- To save the modifications, click Save.
- To cancel the modifications, click Cancel.
- To preview the modifications, click Preview.
-Modifying Parameters in Custom Parameter Template
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Custom Templates tab, click the target parameter template.
- Change parameter values as required.
- To save the modifications, click Save.
- To cancel the modifications, click Cancel.
- To preview the modifications, click Preview.
- After parameters are modified, click Change History to view parameter modification details.For details about how to view parameter modification details, see Viewing Parameter Change History.
- The modifications take effect only after you apply the parameter template to DB instances. For details, see Applying a Parameter Template.
- The change history page displays only the modifications of the last seven days.
Modifying Parameters of a Specified DB Instance
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Instance Management. On the displayed page, click the target DB instance.
- In the navigation pane on the left, choose Parameters. On the displayed page, modify parameters as required.
- To save the modifications, click Save.
- To cancel the modifications, click Cancel.
- To preview the modifications, click Preview.
Modifying Parameters of a Specified DB Instance
- Log in to the GeminiDB console.
- In the navigation pane, choose Instances. Click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, choose Parameters. On the displayed page, modify parameters as required.
- To save the modifications, click Save.
- To cancel the modifications, click Cancel.
- To preview the modifications, click Preview.
- After parameters are modified, click Change History to view parameter modification details.For how to view parameter modification details, see Viewing Parameter Change History.diff --git a/docs/geminidb/umn/nosql_05_0004.html b/docs/geminidb/umn/nosql_05_0004.html index f3bf0c355..320c5371c 100644 --- a/docs/geminidb/umn/nosql_05_0004.html +++ b/docs/geminidb/umn/nosql_05_0004.html @@ -3,10 +3,10 @@
After you modify instance parameters, the modifications immediately take effect for the instance.
-Check the value in the Effective upon Restart column.- If the value is Yes and the DB instance status on the Instance Management page is Pending restart, you must restart the DB instance for the modifications to take effect.
- If the value is No, the modifications take effect immediately.
Check the value in the Effective upon Restart column.- If the value is Yes and the instance status on the Instances page is Pending restart, restart the instance to apply the changes.
- If the value is No, the modifications take effect immediately.
Exporting a Parameter Template
-Scenarios
- You can export a parameter template of a DB instance for future use. To learn how to apply the exported parameter template to a DB instance, refer to section Applying a Parameter Template.
- You can export the parameter template details (parameter names, values, and descriptions) of a DB instance to a CSV file for review and analysis.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Instance Management. On the displayed page, click the target DB instance.
- In the navigation pane on the left, choose Parameters. On the Parameters tab, above the parameter list, click Export.
- Parameter Template: You can export the parameters of the DB instance to a template for future use.In the displayed dialog box, configure required details and click OK.
- The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, numbers, hyphens (-), underscores (_), and periods (.).
- The template description consists of a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Instances. Click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, choose Parameters. On the Parameters tab, above the parameter list, click Export.
- Parameter Template: You can export the parameters of the DB instance to a template for future use.In the displayed dialog box, configure required details and click OK.-
- The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, numbers, hyphens (-), underscores (_), and periods (.).
- The template description consists of a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
After the parameter template is exported, a new template is generated in the list on the Parameter Template Management page.
+After the parameters are exported, a template is generated in the list on the Parameter Templates page.
- File: You can export the parameter template information (parameter names, values, and descriptions) of a DB instance to a CSV file for viewing and analysis.In the displayed dialog box, enter the file name and click OK.diff --git a/docs/geminidb/umn/nosql_05_0005.html b/docs/geminidb/umn/nosql_05_0005.html index b4e7905ed..06a36c58c 100644 --- a/docs/geminidb/umn/nosql_05_0005.html +++ b/docs/geminidb/umn/nosql_05_0005.html @@ -3,10 +3,10 @@
The file name must start with a letter and consist of 4 to 81 characters. It can contain only letters, numbers, hyphens (-), and underscores (_).
Comparing Parameter Templates
-Scenarios
This section guides you on how to compare two parameter templates of the same node type and DB engine version to know their current settings.
Comparing Parameter Templates
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- In the parameter template list, locate the parameter template that you created and click Compare in the Operation column.
- In the displayed dialog box, select a parameter template that shares the same DB engine with the template 1 and click OK.
- If their settings are different, the parameter names and values of both parameter templates are displayed.
- If their settings are the same, no data is displayed.
-Comparing Parameter Templates
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- In the parameter template list, locate the parameter template that you created and click Compare in the Operation column.
- In the displayed dialog box, select a parameter template that shares the same DB engine with the template 1 and click OK.
- If their settings are different, the parameter names and values of both parameter templates are displayed.
- If their settings are the same, no data is displayed.
diff --git a/docs/geminidb/umn/nosql_05_0006.html b/docs/geminidb/umn/nosql_05_0006.html index f4ce6de0f..e95478df4 100644 --- a/docs/geminidb/umn/nosql_05_0006.html +++ b/docs/geminidb/umn/nosql_05_0006.html @@ -4,9 +4,9 @@Comparing Parameter Templates of a Specified Instance
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Instance Management.
- On the Instance Management page, click the target DB instance.
- In the navigation pane on the left, choose Parameters. On the Parameters tab, click Compare above the parameter list.
- In the displayed dialog box, select a parameter template to be compared and click OK.
- If their settings are different, the parameter names and values of both parameter templates are displayed.
- If their settings are the same, no data is displayed.
Comparing Parameter Templates of an Instance
- Log in to the GeminiDB console.
- In the navigation pane, choose Instances.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, choose Parameters. On the Parameters tab, click Compare above the parameter list.
- In the displayed dialog box, select a parameter template to be compared and click OK.
- If their settings are different, the parameter names and values of both parameter templates are displayed.
- If their settings are the same, no data is displayed.
-Scenarios
You can replicate a parameter template you have created. When you have already created a parameter template and want to include most of the custom parameters and values from that template in a new parameter template, you can replicate that parameter template. You can also export the parameter template to generate a new parameter template for future use.
Default parameter templates cannot be replicated, but you can create parameter templates based on the default templates provided.
diff --git a/docs/geminidb/umn/nosql_05_0007.html b/docs/geminidb/umn/nosql_05_0007.html index 0b271f077..e2ba7687c 100644 --- a/docs/geminidb/umn/nosql_05_0007.html +++ b/docs/geminidb/umn/nosql_05_0007.html @@ -3,7 +3,7 @@Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- On the Parameter Template Management page, click the Custom Templates tab. Locate the target parameter template and click Replicate in the Operation column.
Alternatively, click the target DB instance on the Instance Management page. On the Parameters page, click Export to generate a new parameter template for future use.
+Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click the Custom Templates tab. Locate the target parameter template and click Replicate in the Operation column.
You can also click the target instance on the Instances page. On the Parameters page, click Export to generate a new parameter template for future use.
- In the displayed dialog box, enter the parameter template name and description and click OK.
- The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, numbers, hyphens (-), underscores (_), and periods (.).
- The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
After the parameter template is replicated, a new template is generated in the list on the Parameter Template Management page.
+After the replication, a new template is generated in the list.
Resetting a Parameter Template
-Scenarios
You can reset all parameters in a custom parameter template to their default settings.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- On the Parameter Template Management page, click the Custom Templates tab. Locate the target parameter template and choose More > Reset in the Operation column.
- Click Yes to reset the parameter template.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click the Custom Templates tab. Locate the target parameter template and choose More > Reset in the Operation column.
- Click Yes to reset the parameter template.
diff --git a/docs/geminidb/umn/nosql_05_0008.html b/docs/geminidb/umn/nosql_05_0008.html index f50445e6e..b6027492c 100644 --- a/docs/geminidb/umn/nosql_05_0008.html +++ b/docs/geminidb/umn/nosql_05_0008.html @@ -3,7 +3,7 @@Applying a Parameter Template
-Scenarios
Modifications to parameters in a custom parameter template take effect for DB instances only after you have applied the template to the target DB instances.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- On the Parameter Templates page, perform the following operations based on the template type:
- To apply a default template, click Default Templates, locate the target parameter template, and in the Operation column, click Apply.
- To apply a custom template, click Custom Templates, locate the target parameter template, and in the Operation column, choose More > Apply.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, perform the following operations based on the template type:
- To apply a default template, click Default Templates, locate the target parameter template, and in the Operation column, click Apply.
- To apply a custom template, click Custom Templates, locate the target parameter template, and in the Operation column, choose More > Apply.
A parameter template can be applied to one or more DB instances.
- In the displayed dialog box, select one or more DB instances to which the parameter template will be applied and click OK.
After a parameter template is applied, you can view its application records.
Viewing Application Records of a Parameter Template
-Scenarios
You can view the application records of a parameter template.
diff --git a/docs/geminidb/umn/nosql_05_0010.html b/docs/geminidb/umn/nosql_05_0010.html index 9abc99514..962b388b4 100644 --- a/docs/geminidb/umn/nosql_05_0010.html +++ b/docs/geminidb/umn/nosql_05_0010.html @@ -3,7 +3,7 @@Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- On the Parameter Template Management page, locate the target parameter template and choose More > View Application Record in the Operation column.
You can view the name or ID of the DB instance that the parameter template applies to, as well as the application status, application time, and the causes of any failures that have occurred.
+Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, perform the following operations based on the template type:
- On the Default Templates page, locate the target parameter template and click View Application Records in the Operation column.
- On the Custom Templates page, locate the target template and choose More > Apply in the Operation column.
You can view the name or ID of the DB instance that the parameter template applies to, as well as the application status, application time, and the causes of any failures that have occurred.
Modifying a Parameter Template Description
--Scenarios
You can modify the description of a custom parameter template if needed.
diff --git a/docs/geminidb/umn/nosql_05_0011.html b/docs/geminidb/umn/nosql_05_0011.html index 172213848..b3a874753 100644 --- a/docs/geminidb/umn/nosql_05_0011.html +++ b/docs/geminidb/umn/nosql_05_0011.html @@ -5,7 +5,7 @@Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- On the Parameter Template Management page, click the Custom Templates tab. Locate the target parameter template and click
in the Description column. - Enter a new description. You can click
to submit or 
to cancel the modification.- After you submit the modification, you can view the new description in the Description column on the Parameter Template Management page.
- The description can include up to 256 characters but cannot contain the following special characters: >!<"&'=
Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click the Custom Templates tab. Locate the target parameter template and click
in the Description column. - Enter a new description. You can click
to submit or 
to cancel the modification.- After submitting the modification, you can view the new description in the Description column on the Parameter Templates page.
- The description can include up to 256 characters but cannot contain the following special characters: >!<"&'=
- Deleted templates cannot be recovered, so exercise caution when performing this operation.
- Default parameter templates cannot be deleted.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, click Parameter Template Management.
- On the Parameter Templates page, click Custom Templates. Locate the parameter template you want to delete and choose More > Delete in the Operation column.
- Click Yes to delete the parameter template.
Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click Custom Templates. Locate the parameter template you want to delete and choose More > Delete in the Operation column.
- Click Yes to delete the parameter template.
diff --git a/docs/geminidb/umn/nosql_05_0012.html b/docs/geminidb/umn/nosql_05_0012.html index 6c90c5df7..50cf39bae 100644 --- a/docs/geminidb/umn/nosql_05_0012.html +++ b/docs/geminidb/umn/nosql_05_0012.html @@ -1,14 +1,14 @@Viewing Parameter Change History
-Scenarios
You can view the change history of a parameter template.
+-Scenarios
You can view the change history of a parameter template.
In a newly exported or created parameter template, change history is left blank.
Viewing Change History of a Custom Parameter Template
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Parameter Template Management. On the Custom Templates page, click the parameter template you wish to view.
- In the navigation pane on the left, choose Change History. Then, view the parameter name, original parameter value, new parameter value, modification status, and modification time.
You can apply the parameter template to DB instances as required by referring to section Applying a Parameter Template.
+-Viewing Change History of a Custom Parameter Template
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates. On the Custom Templates tab, click the target parameter template.
- In the navigation pane on the left, choose Change History. Then, view the parameter name, original parameter value, new parameter value, modification status, and modification time.
You can apply the parameter template to DB instances as required by referring to section Applying a Parameter Template.
Viewing Change History of DB Instance Parameters
- Log in to the GeminiDB console.
- On the Instance Management page, click the target DB instance. The Basic Information page is displayed.
- In the navigation pane on the left, click Parameters. On the Change History tab, view the parameter name, original parameter value, new parameter value, modification status, and modification time.
Viewing Change History of DB Instance Parameters
- Log in to the GeminiDB console.
- On the Instances page, click the instance name. The Basic Information page is displayed.
- In the navigation pane on the left, click Parameters. On the Change History tab, view the parameter name, original parameter value, new parameter value, modification status, and modification time.
diff --git a/docs/geminidb/umn/nosql_06_0003.html b/docs/geminidb/umn/nosql_06_0003.html index 25a429590..09b50d412 100644 --- a/docs/geminidb/umn/nosql_06_0003.html +++ b/docs/geminidb/umn/nosql_06_0003.html @@ -1,7 +1,7 @@Creating a GeminiDB Cassandra Instance
-+ + \ No newline at end of file diff --git a/docs/geminidb/umn/nosql_06_0010.html b/docs/geminidb/umn/nosql_06_0010.html new file mode 100644 index 000000000..a31831398 --- /dev/null +++ b/docs/geminidb/umn/nosql_06_0010.html @@ -0,0 +1,54 @@ + + +This section describes how to create a DB instance that is compatible with Cassandra APIs.
+This section describes how to create a GeminiDB Cassandra instance on the GeminiDB console.
@@ -176,3 +176,10 @@Procedure
- Log in to the GeminiDB console.
- On the Instances page, click Create DB Instance.
- On the displayed page, select your DB instance specifications and click Create Now.
Table 1 Basic information Parameter
The storage space varies depending on the instance specifications. The minimum storage is 10 GB. To scale up storage, you need to add at least 10 GB each time. The value must be an integer.
After a DB instance is created, you can scale up its storage space. For details, see Scaling Up Storage Space.
When configuring storage space of a GeminiDB Cassandra instance, you are advised to enable autoscaling. Then set trigger conditions and limit of autoscaling. After autoscaling is triggered, the system automatically scales up the storage to ensure that the instance has sufficient storage and keeps available.
-Figure 1 Auto Scale+
Figure 1 Auto Scale
Pay attention to the following parameters:
-- Trigger If Available Storage Drops To: storage threshold for triggering autoscaling. When the available storage usage drops to this value or the available storage space drops to 10 GB, autoscaling is triggered.
- Increase By: percentage that your instance storage will be scaled up at. If the increased storage is not a multiple of 10 GB, the system will round it up to the nearest multiple of 10 GB. At least 100 GB is added each time.
- Storage Limit: maximum amount that the system can automatically scale up an instance's storage space to. The value must be no less than the current storage of your instance and cannot exceed the maximum storage supported by your instance.
- Trigger If Available Storage Drops To: storage threshold for triggering autoscaling. When the available storage usage drops to this value or the available storage space drops to 10 GB, autoscaling is triggered.
- Increase By: percentage of storage to be automatically added. If the increased storage is not a multiple of 10 GB, the system will round it up to the nearest multiple of 10 GB. At least 100 GB is added each time.
- Storage Limit: maximum amount that the system can automatically scale up an instance's storage space to. The value must be no less than the current storage of your instance and cannot exceed the maximum storage supported by your instance.
NOTE:- Once autoscaling is enabled, an agency will be created and fees will be automatically deducted.
- You can enable autoscaling after an instance is created. For details, see Configuring Autoscaling.
The setting is optional. Adding tags helps you better identify and manage your DB instances. You can add a maximum of 20 tags for each instance.
A tag is composed of a key-value pair.
-- Key: Mandatory if the DB instance is going to be tagged
Each tag key is unique for each instance. The key can include up to 36 characters, including digits, letters, underscores (_), and hyphens (-).
- - Value: Optional if the DB instance is going to be tagged
The value can contain up to 43 characters, including digits, letters, underscores (_), periods (.), and hyphens (-).
+- A tag key is mandatory if the instance will be tagged.
Each tag key is unique for each instance. The key can include up to 36 characters, including digits, letters, underscores (_), and hyphens (-).
+ - A tag value is optional if the instance will be tagged.
The value can contain up to 43 characters, including digits, letters, underscores (_), periods (.), and hyphens (-).
After a DB instance is created, you can view its tag details on the Tags tab. In addition, you can add, modify, and delete tags for existing DB instances. For details, see Managing Tags.
- A tag key is mandatory if the instance will be tagged.
- On the displayed page, confirm the DB instance details.
- If you need to modify the specifications, click Previous to return to the previous page.
- If you do not need to modify the specifications, click Submit to start creating the instance.
- On the Instances page, view and manage your DB instances.
- Creating a DB instance takes about 5 to 9 minutes. During the process, the instance status displayed in the DB instance list is Creating.
- After the creation is complete, the status changes to Available.
You can click
+
in the upper right corner of the page to refresh the DB instance statuses. - On the Instances page, view and manage your DB instances.
- Creating a DB instance takes about 5 to 9 minutes. During the process, the instance status displayed in the DB instance list is Creating.
- After the creation is complete, the status changes to Available.
You can click
in the upper right corner of the page to refresh the DB instance statuses. - During creation, an automated backup policy is enabled by default. A full backup is automatically triggered after a DB instance is created.
Instance Connection Methods
++You can connect to a GeminiDB Influx instance using a private network or program code.
+Figure 1 shows how to connect to a GeminiDB Influx instance.
+ + ++
+Table 1 Connection methods Method
+Scenario
+Description
+Console
+You can connect to a GeminiDB Influx instance on a web-based console.
+- Easy to use, secure, advanced, and intelligent
- By default, you have the permission of remote login. DAS is secure and convenient for connecting to instances.
Private network
+A private IP address is provided by default.
+Your applications are deployed on an ECS that is in the same region and VPC as your instances.
+High security and performance
+Program code
+Connect to a GeminiDB Influx instance using Go, Java, or Python.
+-
+++ + + \ No newline at end of file diff --git a/docs/geminidb/umn/nosql_06_0015.html b/docs/geminidb/umn/nosql_06_0015.html new file mode 100644 index 000000000..96cf4ca38 --- /dev/null +++ b/docs/geminidb/umn/nosql_06_0015.html @@ -0,0 +1,17 @@ + + +++Parent topic: Getting Started with GeminiDB Influx+Connecting to a GeminiDB Influx Instance Over Private Networks
+ +++ diff --git a/docs/geminidb/umn/nosql_07_0001.html b/docs/geminidb/umn/nosql_07_0001.html new file mode 100644 index 000000000..2e4574d22 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0001.html @@ -0,0 +1,35 @@ + + +-
+
- Configuring Security Group Rules
+
+ - Connecting to a GeminiDB Influx Instance Over Private Networks
+
+
++Parent topic: Getting Started with GeminiDB Influx+Parameter Template Management
+ +++ diff --git a/docs/geminidb/umn/nosql_07_0002.html b/docs/geminidb/umn/nosql_07_0002.html new file mode 100644 index 000000000..58f2facdc --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0002.html @@ -0,0 +1,15 @@ + + +-
+
- Creating a Parameter Template
+
+ - Modifying a Parameter Template
+
+ - Viewing Parameter Change History
+
+ - Exporting a Parameter Template
+
+ - Comparing Parameter Templates
+
+ - Replicating a Parameter Template
+
+ - Resetting a Parameter Template
+
+ - Applying a Parameter Template
+
+ - Viewing Application Records of a Parameter Template
+
+ - Modifying a Parameter Template Description
+
+ - Deleting a Parameter Template
+
+
++Parent topic: Working with GeminiDB Influx API+Creating a Parameter Template
++You can use database parameter templates to manage DB engine configurations. A database parameter template acts as a container for engine configuration values that can be applied to one or more DB instances.
+Each user can create up to 100 parameter templates. The parameter template quota is shared by all DB instances in a project.
++Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click Create Parameter Template.
- Select a compatible DB engine version, name the parameter template, add the parameter template description, and click OK to create a parameter group template.
- Compatible API: Select the API type that is compatible with your DB engine parameter template.
- DB Engine Version: Select a DB engine version, for example, 1.7.
- Parameter Template Name: The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
- Description: The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
- On the Parameter Templates page, view the created parameter template.
++ diff --git a/docs/geminidb/umn/nosql_07_0003.html b/docs/geminidb/umn/nosql_07_0003.html new file mode 100644 index 000000000..a3b832d81 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0003.html @@ -0,0 +1,27 @@ + + +++Parent topic: Parameter Template Management+Modifying a Parameter Template
++You can modify parameters in a custom parameter template to bring out the best performance of the service.
+Note that parameter values in default parameter templates cannot be changed.
++ Though parameter values in a default template cannot be changed, you can view details about a default parameter template. If a custom parameter template is set incorrectly, the database startup may fail. You can re-configure the custom parameter template according to the configurations of the default parameter template.
++Modifying Parameters in a Custom Parameter Template
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Custom Templates tab, click the target parameter template.
- Change parameter values as required.
- To save the modifications, click Save.
- To cancel the modifications, click Cancel.
- To preview the modifications, click Preview.
- After parameters are modified, click Change History to view parameter modification details.For how to view parameter modification details, see Viewing Parameter Change History.++
- The modifications take effect only after you apply the parameter template to DB instances. For details, see Applying a Parameter Template.
- The change history page displays only the modifications of the last seven days.
+Modifying Parameters of a Specified DB Instance
- Log in to the GeminiDB console.
- In the navigation pane, choose Instances. Click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, choose Parameters. On the displayed page, modify parameters as required.
- To save the modifications, click Save.
- To cancel the modifications, click Cancel.
- To preview the modifications, click Preview.
- After parameters are modified, click Change History to view parameter modification details.For how to view parameter modification details, see Viewing Parameter Change History.++ After the parameter template is modified, choose whether to reboot the instance based on the information in the Effective upon Reboot column.+
- If the value is Yes and the instance status on the Instances page is Pending restart, restart the instance to apply the changes.
- If the value is No, the modifications take effect immediately.
++ diff --git a/docs/geminidb/umn/nosql_07_0004.html b/docs/geminidb/umn/nosql_07_0004.html new file mode 100644 index 000000000..1291450f5 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0004.html @@ -0,0 +1,22 @@ + + +++Parent topic: Parameter Template Management+Exporting a Parameter Template
+++Scenarios
- You can export a parameter template of a DB instance for future use. To learn how to apply the exported parameter template to a DB instance, refer to section Applying a Parameter Template.
- You can export the parameter template details (parameter names, values, and descriptions) of a DB instance to a CSV file for review and analysis.
+Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Instances. Click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, choose Parameters. On the Parameters tab, above the parameter list, click Export.
- Parameter Template: You can export the parameters of the DB instance to a template for future use.In the displayed dialog box, configure required details and click OK.++
- Parameter Template Name: The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
- The template description consists of a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
After the parameters are exported, a template is generated in the list on the Parameter Templates page.
+ - File: You can export the parameter template details (parameter names, values, and descriptions) of a DB instance to a CSV file for review and analysis.In the displayed dialog box, enter the file name and click OK.++
The file name must start with a letter and consist of 4 to 81 characters. It can contain only letters, digits, hyphens (-), and underscores (_).
+
- Parameter Template: You can export the parameters of the DB instance to a template for future use.
++ diff --git a/docs/geminidb/umn/nosql_07_0005.html b/docs/geminidb/umn/nosql_07_0005.html new file mode 100644 index 000000000..729a3f0d6 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0005.html @@ -0,0 +1,18 @@ + + +++Parent topic: Parameter Template Management+Comparing Parameter Templates
+++Scenarios
This section describes how to compare two parameter templates of the same node type and DB engine version.
++Comparing Parameter Templates
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Parameter Templates.
- In the parameter template list, locate the parameter template that you created and click Compare in the Operation column.
- In the displayed dialog box, select a parameter template that uses the same DB engine as the target template and click OK.
- If their settings are different, the parameter names and values of both parameter templates are displayed.
- If their settings are the same, no data is displayed.
+Comparing Parameter Templates of an Instance
- Log in to the GeminiDB console.
- In the navigation pane, choose Instances.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, choose Parameters. On the Parameters tab, click Compare above the parameter list.
- In the displayed dialog box, select a parameter template to be compared and click OK.
- If their settings are different, the parameter names and values of both parameter templates are displayed.
- If their settings are the same, no data is displayed.
++ diff --git a/docs/geminidb/umn/nosql_07_0006.html b/docs/geminidb/umn/nosql_07_0006.html new file mode 100644 index 000000000..6df35cb8d --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0006.html @@ -0,0 +1,18 @@ + + +++Parent topic: Parameter Template Management+Replicating a Parameter Template
+++Scenarios
Replicating a parameter template makes it easy to bring most of your custom parameters and values into a new one. You can also export the parameter template to generate a new parameter template for future use.
+Default parameter templates cannot be replicated. You can create parameter templates based on the default ones.
++Procedure
- Log in to the GeminiDB console.
- In the navigation pane on the left, choose Parameter Templates.
- On the Parameter Templates page, click the Custom Templates tab. Locate the parameter template that you want to replicate and click Replicate in the Operation column.
Alternatively, click the instance name on the Instances page. On the Parameters page, click Export to generate a new parameter template for future use.
+ - In the displayed dialog box, enter the parameter template name and description and click OK.
- New Parameter Template: The template name can be up to 64 characters long. It can contain only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), and periods (.).
- Description: The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
After the replication, a new template is generated in the list on the Custom Templates tab.
+
++ diff --git a/docs/geminidb/umn/nosql_07_0007.html b/docs/geminidb/umn/nosql_07_0007.html new file mode 100644 index 000000000..017481a8b --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0007.html @@ -0,0 +1,14 @@ + + +++Parent topic: Parameter Template Management+Resetting a Parameter Template
+++Scenarios
You can reset all parameters in a custom parameter template to their default settings.
++Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click the Custom Templates tab. Locate the target parameter template and choose More > Reset in the Operation column.
- Click Yes to reset the parameter template.
++ diff --git a/docs/geminidb/umn/nosql_07_0008.html b/docs/geminidb/umn/nosql_07_0008.html new file mode 100644 index 000000000..2088b8db8 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0008.html @@ -0,0 +1,17 @@ + + +++Parent topic: Parameter Template Management+Applying a Parameter Template
+++Scenarios
Modifications to parameters in a custom parameter template take effect for DB instances only after you have applied the template to the target DB instances.
++Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, perform the following operations based on the template type:
- To apply a default template, click Default Templates, locate the target parameter template, and in the Operation column, click Apply.
- To apply a custom template, click Custom Templates, locate the target parameter template, and in the Operation column, choose More > Apply.
A parameter template can be applied to one or more DB instances.
+ - In the displayed dialog box, select one or more DB instances to which the parameter template will be applied and click OK.
After a parameter template is applied, you can view its application records.
+
++ diff --git a/docs/geminidb/umn/nosql_07_0009.html b/docs/geminidb/umn/nosql_07_0009.html new file mode 100644 index 000000000..296432fdc --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0009.html @@ -0,0 +1,16 @@ + + +++Parent topic: Parameter Template Management+Viewing Application Records of a Parameter Template
+++Scenarios
You can view the application records of a parameter template.
++Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, perform the following operations based on the template type:
- On the Default Templates page, locate the target parameter template and click View Application Records in the Operation column.
- On the Custom Templates page, locate the target template and choose More > Apply in the Operation column.
You can view the name or ID of the DB instance that the parameter template applies to, as well as the application status, application time, and the causes of any failures that have occurred.
+
++ diff --git a/docs/geminidb/umn/nosql_07_0010.html b/docs/geminidb/umn/nosql_07_0010.html new file mode 100644 index 000000000..3bf7b67b2 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0010.html @@ -0,0 +1,15 @@ + + +++Parent topic: Parameter Template Management+Modifying a Parameter Template Description
+++Scenarios
You can modify the description of a custom parameter template if needed.
++Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click the Custom Templates tab. Locate the target parameter template and click
in the Description column. - Enter a new description. You can click
to submit or 
to cancel the modification.- After submitting the modification, you can view the new description in the Description column on the Parameter Templates page.
- The description can include up to 256 characters but cannot contain the following special characters: >!<"&'=
++ diff --git a/docs/geminidb/umn/nosql_07_0011.html b/docs/geminidb/umn/nosql_07_0011.html new file mode 100644 index 000000000..5ca518866 --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0011.html @@ -0,0 +1,16 @@ + + +++Parent topic: Parameter Template Management+Deleting a Parameter Template
+++Scenarios
You can delete a custom parameter template that is no longer in use.
++ - Deleted templates cannot be recovered, so exercise caution when performing this operation.
- Default parameter templates cannot be deleted.
+Procedure
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates.
- On the Parameter Templates page, click Custom Templates. Locate the parameter template you want to delete and choose More > Delete in the Operation column.
- Click Yes to delete the parameter template.
++ diff --git a/docs/geminidb/umn/nosql_07_0012.html b/docs/geminidb/umn/nosql_07_0012.html new file mode 100644 index 000000000..9b3adb5da --- /dev/null +++ b/docs/geminidb/umn/nosql_07_0012.html @@ -0,0 +1,19 @@ + + +++Parent topic: Parameter Template Management+Viewing Parameter Change History
+++Scenarios
You can view the change history of a parameter template.
++ In a newly exported or created parameter template, change history is left blank.
++Viewing Change History of a Custom Parameter Template
- Log in to the GeminiDB console.
- In the navigation pane, choose Parameter Templates. On the Custom Templates tab, click the target parameter template.
- In the navigation pane on the left, choose Change History. Then, view the parameter name, original parameter value, new parameter value, modification status, and modification time.
You can apply the parameter template to DB instances as required by referring to section Applying a Parameter Template.
+
+Viewing Change History of DB Instance Parameters
- Log in to the GeminiDB console.
- On the Instances page, click the instance name. The Basic Information page is displayed.
- In the navigation pane, choose Parameters.
- Click Change History. You can see the parameter name, original parameter value, new parameter value, modification status, and modification time.
++ diff --git a/docs/geminidb/umn/nosql_09_0004.html b/docs/geminidb/umn/nosql_09_0004.html new file mode 100644 index 000000000..760d6ed12 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0004.html @@ -0,0 +1,31 @@ + + +++Parent topic: Parameter Template Management+DB Instance Management
+ +++ diff --git a/docs/geminidb/umn/nosql_09_0005.html b/docs/geminidb/umn/nosql_09_0005.html new file mode 100644 index 000000000..240df4e1f --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0005.html @@ -0,0 +1,20 @@ + + +-
+
- Changing an Instance Name
+
+ - Resetting the Administrator Password
+
+ - Restarting a DB Instance
+
+ - Adding Nodes
+
+ - Scaling Up Storage Space
+
+ - Changing the CPU and Memory of an Instance
+
+ - Deleting an Instance
+
+ - Managing Tags
+
+ - Recycling an Instance
+
+
++Parent topic: Working with GeminiDB Influx API+Changing an Instance Name
+++Scenarios
This section describes how to change a GeminiDB Influx instance name to identify different instances.
++Method 1
- Log in to the GeminiDB console.
- On the Instances page, click
next to the target instance.- To submit the change, click OK.
The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.
+ - To cancel the change, click Cancel.
- To submit the change, click OK.
- View the results on the Instances page.
+Method 2
- Log in to the GeminiDB console.
- On the Instances page, click the target instance name.
- In the Instance Information area on the Basic Information page, click
in the DB Instance Name field.- To submit the change, click
.The new name can be the same as an existing instance name. It must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.
+ - To cancel the change, click
.
- To submit the change, click
- View the results on the Instances page.
++ diff --git a/docs/geminidb/umn/nosql_09_0012.html b/docs/geminidb/umn/nosql_09_0012.html new file mode 100644 index 000000000..c2b76f99a --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0012.html @@ -0,0 +1,17 @@ + + +++Parent topic: DB Instance Management+Deleting an Instance
+++Scenarios
This section describes how to delete a DB instance no longer used to release resources.
++Constraints
- If you delete a DB instance, all the data in it and all automated backups are automatically deleted as well and cannot be restored, so exercise caution when performing this operation.
- If you delete an instance, all nodes in the instance are also deleted.
+Procedure
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose More > Delete in the Operation column.
- On the displayed page, click Yes.
Deleted DB instances are not displayed in the instance list.
+
++ diff --git a/docs/geminidb/umn/nosql_09_0015.html b/docs/geminidb/umn/nosql_09_0015.html new file mode 100644 index 000000000..d56249b06 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0015.html @@ -0,0 +1,28 @@ + + +++Parent topic: DB Instance Management+Data Migration
++InfluxDB Community Edition is a popular time series database that focuses on high-performance queries and storage.
+GeminiDB Influx API has better query, write, and data compression performance than InfluxDB Community Edition.
+This section describes how to migrate data from InfluxDB Community Edition to GeminiDB Influx API.
++How Data Is Migrated
Use a migration tool to parse the TSM and WAL files of InfluxDB Community Edition and write the files to a line protocol file. Then, the line protocol file data is parsed and migrated to the destination side.
+The migration process is divided into two phases:
+- Export: TSM and WAL files of InfluxDB Community Edition are concurrently parsed, and the parsed data is written into a line protocol file.
- Import: Data in the line protocol file is concurrently read and is sent to each node in the GeminiDB Influx cluster.
The migration tool supports full migration and incremental migration, which can be configured in the configuration file.
++Usage Notes
- Deploy the migration tool on the same server as InfluxDB Community Edition and prepare a configuration file.
- The migration tool needs to extract data from TSM and WAL files to the local line protocol file, obtain data from the line protocol file, and send the data to the destination GeminiDB Influx instance. This process may affect the performance of the source database. You are advised to run the migration tool during off-peak hours.
- Reserve sufficient disk space because TSM and WAL file data needs to be extracted to the line protocol file.
- The migration tool supports only InfluxDB 1.X Community Edition.
+Prerequisites
- The network between the source InfluxDB (Community Edition) instance and destination GeminiDB Influx instance is connected.
- The corresponding database has been created and the retention policy has been configured in the destination GeminiDB Influx instance.
+Procedure
To migrate data from InfluxDB (Community Edition) to GeminiDB Influx API, contact technical support.
++Migration Performance Reference
- Migration environment:
- Source: Deploy a single-node InfluxDB instance and the migration tool on an ECS with 4 vCPUs and 16 GB of memory.
- Destination: Deploy a three-node GeminiDB Influx instance with 4 vCPUs and 16 GB of memory.
- Migration performance:
- The data export rate of a single process on the source database is 1 GB/min.
- The import rate of a single thread on the destination database is 1 GB/min.
++ diff --git a/docs/geminidb/umn/nosql_09_0016.html b/docs/geminidb/umn/nosql_09_0016.html new file mode 100644 index 000000000..4ad03dfa5 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0016.html @@ -0,0 +1,19 @@ + + + +++Parent topic: Working with GeminiDB Influx API+Database Commands
+ +++ +++ diff --git a/docs/geminidb/umn/nosql_09_0017.html b/docs/geminidb/umn/nosql_09_0017.html new file mode 100644 index 000000000..0d673ec6a --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0017.html @@ -0,0 +1,839 @@ + + +-
+
- Supported Commands
+
+
++Parent topic: Working with GeminiDB Influx API+Supported Commands
++The following tables list commands supported by GeminiDB Influx API.
++User Management
++
+Table 1 Commands supported by user management Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+create user
+√
+√
+show user
+√
+√
+drop user
+√
+√
+set password
+√
+√
+grant
+√
+√
+show grants
+√
+√
+revoke
+√
+√
++CLI Commands Used on an Influx client
++
+Table 2 CLI commands used on an Influx client Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+connect
+√
+√
+auth
+√
+√
+pretty
+√
+√
+chunked
+√
+√
+chunk size
+√
+√
+use
+√
+√
+format
+√
+√
+precision
+√
+√
+consistency
+√
+√
+history
+√
+√
+settings
+√
+√
+clear
+√
+√
+exit/quit/ctrl+d
+√
+√
++Metadata Management
++
+Table 3 Commands supported by metadata management Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+create database
+√
+√
+show databases
+√
+√
+drop database
+√
+√
+show measurements
+√
+√
+show measurement cardinality
+√
+√
+show measurement exact cardinality
+√
+√
+drop measurement
+√
+√
+create retention policy
+√
+√
+alter retention policy
+√
+√
+drop retention policy
+√
+√
+show retention policies
+√
+√
+create continuous query
+√
+√
+show continuous queries
+√
+√
+drop continuous query
+√
+√
+show series
+√
+√
+show series cardinality
+√
+√
+show series exact cardinality
+√
+√
+drop series
+×
+×
+show tag keys
+√
+√
+show tag key cardinality
+√
+√
+show tag key exact cardinality
+√
+√
+show tag values
+√
+√
+show tag values cardinality
+√
+√
+show tag values exact cardinality
+√
+√
+show field keys
+√
+√
+show field key cardinality
+√
+√
+show field key exact cardinality
+√
+√
+show shards
+√
+√
+show shard groups
+√
+√
+drop shard
+×
+×
++Monitoring and Management of Queries
++
+Table 4 Commands for monitoring and management of queries Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+kill query
+√
+√
+show queries
+√
+√
++Querying, Writing, and Deleting Data Points
++
+Table 5 Commands supported by data points Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+select
+√
+√
+select xxx into
+√
+√
+insert into
+√
+×
+insert
+√
+×
+limit
+√
+√
+offset
+√
+√
+delete
+×
+×
+explain
+√
+√
+explain analyze
+√
+√
++Aggregate Functions
++
+Table 6 Commands supported by aggregate functions Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+count
+√
+√
+distinct
+√
+√
+integral
+√
+√
+mean
+√
+√
+median
+√
+√
+mode
+√
+√
+spread
+√
+√
+stddev
+√
+√
+sum
+√
+√
++SELECT Function
++
+Table 7 Commands supported by the SELECT function Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+bottom
+√
+√
+top
+√
+√
+first
+√
+√
+last
+√
+√
+max
+√
+√
+min
+√
+√
+percentile
+√
+√
+sample
+√
+√
++Conversion Functions
++
+Table 8 Commands supported by conversion functions Command
+Supported in Read/Write Mode
+Supported in Read-Only Mode
+abs
+√
+√
+acos
+√
+√
+asin
+√
+√
+atan
+√
+√
+atan2
+√
+√
+ceil
+√
+√
+cos
+√
+√
+sin
+√
+√
+tan
+√
+√
+sqrt
+√
+√
+round
+√
+√
+floor
+√
+√
+exp
+√
+√
+ln
+√
+√
+log2
+√
+√
+log10
+√
+√
+log
+√
+√
+pow
+√
+√
+cumulative_sum
+√
+√
+difference
+√
+√
+non_negative_difference
+√
+√
+derivative
+√
+√
+non_negative_derivative
+√
+√
+elapsed
+√
+√
+moving_average
+√
+√
++ + √ indicates that a command is supported, and × indicates that a command is not supported.
+++ diff --git a/docs/geminidb/umn/nosql_09_0035.html b/docs/geminidb/umn/nosql_09_0035.html new file mode 100644 index 000000000..cdcf62d82 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0035.html @@ -0,0 +1,23 @@ + + + +++Parent topic: Database Commands+Monitoring and Alarm Reporting
+ +++ ++ + ++ diff --git a/docs/geminidb/umn/nosql_09_0036.html b/docs/geminidb/umn/nosql_09_0036.html new file mode 100644 index 000000000..83528e1f9 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0036.html @@ -0,0 +1,244 @@ + + +++Parent topic: Working with GeminiDB Influx API+GeminiDB Influx Instance Metrics
+++Description
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 the metrics of the monitored object and alarms generated for GeminiDB.
++Namespace
SYS.NoSQL
++Metrics
++
+Table 1 Metrics Metric ID
+Metric Name
+Description
+Value Range
+Monitored Object
+Monitoring Interval (Raw Data)
+gemini001_cpu_usage
+CPU Usage
+CPU usage of the monitored system
+Unit: %
+0–100
+Measured object: ECS
+Monitored object: GeminiDB instance
+1 minute
+gemini002_mem_usage
+Memory Usage
+Memory usage of the monitored system
+Unit: %
+0–100
+Measured object: ECS
+Monitored object: GeminiDB instance
+1 minute
+gemini003_bytes_out
+Network Output Throughput
+Outgoing traffic in bytes per second
+Unit: kbit/s
+≥ 0
+Measured object: ECS
+Monitored object: GeminiDB instance
+1 minute
+gemini004_bytes_in
+Network Input Throughput
+Incoming traffic in bytes per second
+Unit: kbit/s
+≥ 0
+Measured object: ECS
+Monitored object: GeminiDB instance
+1 minute
+influxdb001_series_num
+Time Series
+Total number of time series
+Unit: count
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+influxdb002_query_req_ps
+Query Requests Per Second
+Number of query requests per second
+Unit: count/second
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+influxdb003_write_req_ps
+Write Requests Per Second
+Number of write requests per second
+Unit: count/second
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+influxdb004_write_points_ps
+Write Points
+Number of write points per second
+Unit: count/second
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+influxdb005_write_concurrency
+Concurrent Write Requests
+Number of concurrent write requests
+Unit: count
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+influxdb006_query_concurrency
+Concurrent Queries
+Number of concurrent query requests
+Unit: count
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+nosql005_disk_usage
+Storage Space Usage
+Storage usage of a monitored object
+Unit: %
+0–100
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+nosql006_disk_total_size
+Total Storage Space
+Disk size of a monitored object
+Unit: GB
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
+nosql007_disk_used_size
+Used Storage Space
+Used storage of a monitored object
+Unit: GB
+≥ 0
+Monitored object: database
+Monitored object: GeminiDB Influx instance node
+1 minute
++Dimensions
++
+Key
+Value
+influxdb_cluster_id.influxdb_node_id
+Cluster ID or node ID of the GeminiDB Influx instance
+++ diff --git a/docs/geminidb/umn/nosql_09_0037.html b/docs/geminidb/umn/nosql_09_0037.html new file mode 100644 index 000000000..5a3583f27 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0037.html @@ -0,0 +1,17 @@ + + +++Parent topic: Monitoring and Alarm Reporting+Setting Alarm Rules
+++Scenarios
You can set alarm rules to customize the monitored objects and notification policies and to stay aware of the database operating status.
+The alarm rules include alarm rule names, monitored objects, metric, thresholds, monitoring intervals, and whether to send notifications. This section describes how to set an alarm rule.
++ For more information about GeminiDB alarm rules, see Cloud Eye User Guide.
++Procedure
- Log in to the management console.
- After the alarm rule is set, the system automatically notifies you when an alarm is triggered.
++ diff --git a/docs/geminidb/umn/nosql_09_0038.html b/docs/geminidb/umn/nosql_09_0038.html new file mode 100644 index 000000000..8997bd0fd --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0038.html @@ -0,0 +1,22 @@ + + +++Parent topic: Monitoring and Alarm Reporting+Viewing Metrics
+++Scenarios
Cloud Eye monitors instance running statuses. You can view the GeminiDB metrics on the management console.
+Monitored data requires a period of time for transmission and display. The status of the monitored object displayed on the Cloud Eye page is the status obtained 5 to 10 minutes before. You can view the monitored data of a newly created DB instance 5 to 10 minutes later.
++Prerequisites
+ ++Procedure
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the Node Information area on the Basic Information page, click View Metric in the Operation column.
- In the monitoring area, you can select a duration to view the monitoring data.
You can view the monitoring data of the service in the last 1, 3, or 12 hours.
+To view the monitoring curve in a longer time range, click
+
to enlarge the graph.
++ diff --git a/docs/geminidb/umn/nosql_09_0039.html b/docs/geminidb/umn/nosql_09_0039.html new file mode 100644 index 000000000..2bc91c4f6 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0039.html @@ -0,0 +1,18 @@ + + +++Parent topic: Monitoring and Alarm Reporting+Auditing
++++ + ++ diff --git a/docs/geminidb/umn/nosql_09_0040.html b/docs/geminidb/umn/nosql_09_0040.html new file mode 100644 index 000000000..b5f8076ff --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0040.html @@ -0,0 +1,227 @@ + + +++Parent topic: Working with GeminiDB Influx API+Key Operations Recorded by CTS
++With CTS, you can record GeminiDB key operations for later query, audit, and backtracking.
+Table 1 lists the key operations that can be recorded by CTS.
+ ++
+Table 1 GeminiDB Influx key operations Operation
+Resource
+Trace Name
+Creating a DB instance
+instance
+NoSQLCreateInstance
+Deleting a DB instance
+instance
+NoSQLDeleteInstance
+Adding nodes
+instance
+NoSQLEnlargeInstance
+Restarting a DB instance
+instance
+NoSQLRestartInstance
+Restoring data to new DB instances
+instance
+NoSQLRestoreNewInstance
+Scaling up storage space
+instance
+NoSQLExtendInstanceVolume
+Resetting a password
+instance
+NoSQLResetPassword
+Changing DB instance names
+instance
+NoSQLRenameInstance
+Changing a DB instance class
+instance
+NoSQLResizeInstance
+Binding an EIP
+instance
+NoSQLBindEIP
+Unbinding an EIP
+instance
+NoSQLUnBindEIP
+Creating a backup
+backup
+NoSQLCreateBackup
+Deleting a backup
+backup
+NoSQLDeleteBackup
+Setting a backup policy
+backup
+NoSQLSetBackupPolicy
+Adding an instance tag
+tag
+NoSQLAddTags
+Modifying an instance tag
+tag
+NoSQLModifyInstanceTag
+Deleting an instance tag
+tag
+NoSQLDeleteInstanceTag
+Creating a parameter template
+parameterGroup
+NoSQLCreateConfigurations
+Modifying a parameter template
+parameterGroup
+NoSQLUpdateConfigurations
+Modifying instance parameters
+parameterGroup
+NoSQLUpdateInstanceConfigurations
+Replicating a parameter template
+parameterGroup
+NoSQLCopyConfigurations
+Resetting a parameter template
+parameterGroup
+NoSQLResetConfigurations
+Applying a parameter template
+parameterGroup
+NoSQLApplyConfigurations
+Deleting a parameter template
+parameterGroup
+NoSQLDeleteConfigurations
+Deleting nodes that failed to be added
+instance
+NoSQLDeleteEnlargeFailNode
+Enabling SSL
+instance
+NoSQLSwitchSSL
+Changing a security group
+instance
+NoSQLModifySecurityGroup
+Modifying the recycling policy
+instance
+NoSQLModifyRecyclePolicy
+Exporting a parameter template
+instance
+NoSQLSaveConfigurations
+++ diff --git a/docs/geminidb/umn/nosql_09_0041.html b/docs/geminidb/umn/nosql_09_0041.html new file mode 100644 index 000000000..54e1f46a0 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0041.html @@ -0,0 +1,19 @@ + + +++Parent topic: Auditing+Querying Traces
++After CTS is enabled, CTS starts recording operations on cloud resources. The CTS console stores the last seven days of operation records.
+This section describes how to query operation records for the last 7 days on the CTS console.
++Procedure
- Log in to the management console.
- Click in the upper left corner and select a region and a project.
- Click Service List. Under Management & Deployment, click Cloud Trace Service.
- Choose Trace List in the navigation pane on the left.
- Specify the filters used for querying traces. The following four filters are available:
- Trace Source, Resource Type, Search By, and Operator
Select the filter from the drop-down list.
+When you select Trace name for Search By, you also need to select a specific trace name.
+When you select Resource ID for Search By, you also need to select or enter a specific resource ID.
+When you select Resource name for Search By, you also need to select or enter a specific resource name.
+ - Operator: Select a specific operator (a user rather than tenant).
- Trace Status: Available options include All trace statuses, normal, warning, and incident. You can only select one of them.
- Start time and end time: You can specify the time period for query traces.
- Trace Source, Resource Type, Search By, and Operator
- Click to the left of the record to be queried to extend its details.
- Locate a trace and click View Trace in the Operation column.
++ diff --git a/docs/geminidb/umn/nosql_09_0044.html b/docs/geminidb/umn/nosql_09_0044.html new file mode 100644 index 000000000..756c7155b --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0044.html @@ -0,0 +1,51 @@ + + +++Parent topic: Auditing+Managing Tags
+++Scenarios
Tag Management Service (TMS) enables you to use tags on the management console to manage resources. TMS works with other cloud services to manage tags. TMS manages tags globally and other cloud services manage their own tags.
+Adding tags to GeminiDB instances helps you better identify and manage them. An instance can be tagged during or after it is created.
+After an instance is tagged, you can search for the tag key or value to quickly query the instance details.
++Usage Notes
- You are advised to set predefined tags on the TMS console.
- A tag consists of a key and value. You can add only one value for each key. For details about the naming rules of tag keys and tag values, see Table 1.
- Up to 20 tags can be added for each instance.
+
+Table 1 Naming rules Parameter
+Requirement
+Example Value
+Tag key
+- The key cannot be left blank.
- Each tag key is unique for each instance.
- A tag key consists of a maximum of 36 characters.
- The key can only consist of digits, letters, underscores (_), hyphens (-), and at signs (@).
Organization
+Tag value
+- This tag value can be left blank.
- The value consists of up to 43 characters.
- The value can only consist of digits, letters, underscores (_), hyphens (-), and at signs (@).
geminidb_01
++Adding a Tag
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, click Tags.
- On the Tags page, click Add Tag. In the displayed dialog box, enter a tag key and value, and click OK.
- View and manage tags on the Tags page.
+Editing a Tag
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, click Tags.
- On the Tags page, locate the tag to be edited and click Edit in the Operation column. In the displayed dialog box, change the tag value and click OK.
Only the tag value can be edited when editing a tag.
+ - View and manage tags on the Tags page.
+Deleting a Tag
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the navigation pane on the left, click Tags.
- On the Tags page, locate the tag to be deleted and click Delete in the Operation column. In the displayed dialog box, click Yes.
- After a tag has been deleted, it will not be displayed on the Tags page.
+Searching an Instance by Tag
- Log in to the GeminiDB console.
- On the Instances page, click Search by Tag in the upper right corner of the instance list.
- Enter the key or value of the tag to be queried and click Search to query the instance associated with the tag.
++ diff --git a/docs/geminidb/umn/nosql_09_0046.html b/docs/geminidb/umn/nosql_09_0046.html new file mode 100644 index 000000000..263071193 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0046.html @@ -0,0 +1,22 @@ + + +++Parent topic: DB Instance Management+Backup and Restoration
+++++ diff --git a/docs/geminidb/umn/nosql_09_0047.html b/docs/geminidb/umn/nosql_09_0047.html new file mode 100644 index 000000000..5e7789d1b --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0047.html @@ -0,0 +1,36 @@ + + +-
+
- Overview
+
+ - Managing Automated Backups
+
+ - Managing Manual Backups
+
+ - Restoring Data to a New DB Instance
+
+
++Parent topic: Working with GeminiDB Influx API+Managing Automated Backups
++GeminiDB Influx API creates automated backups to ensure data reliability. If a database or table is deleted, maliciously or accidentally, backups can help recover your data.
++Configuring an Automated Backup Policy
Automated backups are generated according to a backup policy and saved as packages in OBS buckets to ensure data confidentiality and durability. You are advised to regularly back up your database, in case it becomes faulty or damaged. However, backing up data might affect the database read and write performance so it is recommended that you enable automated backups during off-peak hours.
+When you create a DB instance, an automated backup policy is enabled by default.+- Retention Period: Automated backup files are saved for seven days by default. The backup retention period can range from 1 to 35 days.+
- If the retention period is less than seven days, the system automatically backs up data every day.
- The system checks existing automated backup files and deletes the files that exceed the backup retention period you set.
- Time Window: An hour within 24 hours, such as 01:00-02:00 or 12:00-13:00. The backup time is in GMT format. If the DST or standard time is switched, the backup time segment changes with the time zone.
- Backup Cycle: By default, each day of the week is selected.
- All: Each day of the week is selected. The system automatically backs up data every day.
- Select a cycle: You can select one or more days in a week. The system automatically backs up data at the specified time.
+ A full backup starts within one hour of the time you specify. The amount of time required for the backup depends on the amount of data to be backed up. The more data has to be backed up, the longer it will take.
+ - After a DB instance is created, you can modify the automated backup policy as needed. You can change the time window after the DB instance is created. The system backs up data based on the automated backup policy you have set.
- If the automated backup policy is disabled, any automated backups in progress stop immediately.
+Modifying an Automated Backup Policy
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, click Modify Backup Policy. In the displayed dialog box, set the backup policy. Then, click Yes to save the configuration.
For details about how to set a backup policy, see Configuring an Automated Backup Policy.
+ - Check or manage the generated backups on the Backups or Backups & Restorations page.
+Disabling an Automated Backup Policy
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, click Modify Backup Policy.
- In the displayed dialog box, click
to disable the backup policy and click Yes.When disabling the automated backup policy, you can decide whether to delete the automated backups by selecting Delete automated backups.+- If you select it, all backup files within the retention period will be deleted. No automated backups are displayed in the backup list until you enable the automated backup policy again.
- If you do not select it, all backup files within the retention period will be retained, but you can still manually delete them later if needed. For details, see section Deleting an Automated Backup.
If the automated backup policy is disabled, any automated backups in progress stop immediately.
+
+Deleting an Automated Backup
After the automated backup policy is disabled, you can manually delete the saved automated backups to release storage.
+After the automated backup policy is enabled, the system checks and automatically deletes expired automated backups. You cannot delete automated backups.
++ The deletion operation is irreversible, so exercise caution when performing this operation.
+- Method 1
- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
- In the Delete Backup dialog box, confirm the backup information and click Yes.
- Method 2
- On the Backups page, locate the target backup and click Delete.
- In the Delete Backup dialog box, confirm the backup information and click Yes.
++ diff --git a/docs/geminidb/umn/nosql_09_0048.html b/docs/geminidb/umn/nosql_09_0048.html new file mode 100644 index 000000000..ce2f37b54 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0048.html @@ -0,0 +1,56 @@ + + +++Parent topic: Backup and Restoration+Managing Manual Backups
++To ensure data reliability, GeminiDB Influx API allows you to manually back up DB instances whose status is Available. If a database or table is deleted, maliciously or accidentally, backups can help recover your data.
++ - By default, you can create up to 50 backups.
- Manual backups are full backups.
+Creating a Manual Backup
- Log in to the GeminiDB console.
- Create a manual backup.
Method 1
+On the Instances page, locate the target instance and click Create Backup or choose in the Operation column.
+Method 2+- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, click Create Backup.
Method 3
+In the navigation pane, choose Backups. On the displayed page, click Create Backup.
+ - In the displayed dialog box, enter the backup name and description, and click OK.
+
+
+Table 1 Parameter description Parameter
+Description
+DB Instance Name
+The default value is the name of the DB instance to be backed up and cannot be modified.
+Backup Name
+The backup name must be 4 to 64 characters in length and start with a letter. Backup names are case-insensitive and can only contain letters, digits, hyphens (-), and underscores (_).
+Description
+The description contains a maximum of 256 characters and cannot include line breaks or the following special characters: >!<"&'=
+ - View the backup status after the task has been executed.
- While creating a manual backup, you can query the backup status on the Backups page or the Backups & Restorations page. The backup status becomes Backing up.
- If a manual backup was successfully created, the backup status is Completed.
+Deleting a Manual Backup
If you do not need the manual backup, you can delete it on the Backups or Backups & Restorations page.
+Deleted backups are not displayed in the backup list.
++ The deletion operation is irreversible, so exercise caution when performing this operation.
+Method 1+- On the Instances page, click the target instance. The Basic Information page is displayed.
- On the Backups & Restorations page, locate the backup you wish to delete and click Delete.
- In the Delete Backup dialog box, confirm the backup details and click Yes.
Method 2
+- On the Backups page, locate the target backup and click Delete.
- In the Delete Backup dialog box, confirm the backup details and click Yes.
++ diff --git a/docs/geminidb/umn/nosql_09_0049.html b/docs/geminidb/umn/nosql_09_0049.html new file mode 100644 index 000000000..f26b20e92 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0049.html @@ -0,0 +1,23 @@ + + +++Parent topic: Backup and Restoration+Restoring Data to a New DB Instance
+++Scenarios
GeminiDB Influx API allows you to restore the existing backup to a new DB instance.
++Procedure
- Log in to the GeminiDB console.
- Restore a DB instance from the backup.
Method 1
+- On the Instances page, click the target instance.
- On the Backups & Restorations page, locate the target backup and click Restore.
Method 2
+On the Backups page, locate the target backup and click Restore.
+ - In the displayed dialog box, confirm the current instance details and restoration method and click OK.
- The default API type and DB engine version are the same as those of the original instance and cannot be changed.
- The system automatically calculates the minimum storage space required for restoring the new instance based on the size of the selected backup file. The storage space must be an integer multiple of 1.
- You need to set a new administrator password.
- You can modify other parameters. For details, see Creating a GeminiDB Influx Instance.
- View the restoration results.
A new DB instance is created using the backup data. The instance status changes from Creating to Available.
+A full backup is triggered after the new DB instance is created.
+The new DB instance is independent of the original one.
+
++ diff --git a/docs/geminidb/umn/nosql_09_0050.html b/docs/geminidb/umn/nosql_09_0050.html new file mode 100644 index 000000000..9919905fa --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0050.html @@ -0,0 +1,25 @@ + + +++Parent topic: Backup and Restoration+Scaling Up Storage Space
+++Scenarios
This section describes how to scale up the storage space of a DB instance to suit your service requirements.
+During the scale-up process, the DB instance will not restart, and your services will not be interrupted.
++Usage Notes
Storage space can only be scaled up. It cannot be scaled down.
++Method 1
- Log in to the GeminiDB console.
- On the Instances page, click the target instance.
- In the Storage Space area on the Basic Information page, click Scale.
- On the displayed page, specify the new storage capacity and click Next.
Select at least 10 GB each time, and the value must be an integer.
+ - On the displayed page, confirm the storage space.
- If you need to modify your settings, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit to scale up the storage space.
- Check the scale-up result.
- The status of the DB instance in the instance list is Scaling up.
- After the scale up is completed, the DB instance status becomes Available.
- In the Storage Space area on the Basic Information page, check whether the scale up was successful.
+Method 2
- Log in to the GeminiDB console.
- On the Instances page, locate the target instance and choose in the Operation column.
- On the displayed page, specify the new storage capacity and click Next.
Select at least 10 GB each time, and the value must be an integer.
+ - On the displayed page, confirm the storage space.
- If you need to modify your settings, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit to scale up the storage space.
- Check the scale-up result.
- The status of the DB instance in the instance list is Scaling up.
- After the scale up is completed, the DB instance status becomes Available.
- In the Storage Space area on the Basic Information page, check whether the scale up was successful.
++ diff --git a/docs/geminidb/umn/nosql_09_0071.html b/docs/geminidb/umn/nosql_09_0071.html new file mode 100644 index 000000000..4a6ca2d35 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0071.html @@ -0,0 +1,16 @@ + + +++Parent topic: DB Instance Management+Downloading the Default SSL Certificate
+++Scenarios
Secure Sockets Layer (SSL) certificates set up encrypted connections between clients and servers, preventing data from being tampered with or stolen during transmission.
+To improve data security, a GeminiDB Influx instance provides a default SSL certificate. When creating an instance, you can enable SSL to encrypt connections to the instance.
+This section describes how to obtain the default SSL security certificate provided by GeminiDB Influx API.
++Procedure
- Log in to the GeminiDB console.
- On the Instance Management page, click the target DB instance. The Basic Information page is displayed.
- In the DB Information area, click
in the SSL field to download the SSL certificate.
++ diff --git a/docs/geminidb/umn/nosql_09_0072.html b/docs/geminidb/umn/nosql_09_0072.html new file mode 100644 index 000000000..1846d0aff --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0072.html @@ -0,0 +1,15 @@ + + +++Parent topic: Certificate Management+Certificate Management
+ ++ + ++ diff --git a/docs/geminidb/umn/nosql_09_0073.html b/docs/geminidb/umn/nosql_09_0073.html new file mode 100644 index 000000000..51becc86c --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0073.html @@ -0,0 +1,36 @@ + + +++Parent topic: Working with GeminiDB Influx API+Connecting to an Instance Using Go
++This section describes how to connect to a GeminiDB Influx instance using the Go programming language.
++Prerequisites
- You have downloaded the client code from the InfluxDB open-source project website.
+Example Code
package main + +import ( + "fmt" + _ "github.com/influxdata/influxdb1-client" // this is important because of the bug in go mod + client "github.com/influxdata/influxdb1-client/v2" +) + +func main(){ + c, err := client.NewHTTPClient(client.HTTPConfig{ + Addr: "http://ip:port", + Username: "******", + Password: "******", + }) + if err != nil { + fmt.Println("Error creating InfluxDB Client: ", err.Error()) + } + q := client.NewQuery("select * from cpu","db0","ns") + if response, err := c.Query(q); err == nil && response.Error() == nil { + fmt.Println("the result is: ",response.Results) + } +}+++ diff --git a/docs/geminidb/umn/nosql_09_0092.html b/docs/geminidb/umn/nosql_09_0092.html new file mode 100644 index 000000000..bdc2c9056 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0092.html @@ -0,0 +1,42 @@ + + ++ ++Connecting to a GeminiDB Influx Instance on the Console
++You can connect to a GeminiDB Influx instance on the console.
++Prerequisites
There is an available GeminiDB Influx instance.
++Usage Notes
- SELECT query commands are supported.
- INSERT commands for writing data are supported.
- Commands for database operations (including creating, deleting, and displaying databases) are supported.
- Commands for user operations (including creating, deleting, displaying, and authorizing users, and changing user passwords) are supported.
- Commands of retention policies (including creating, deleting, displaying, and modifying retention policies) are supported.
- CONTINUOUS QUERY commands (including CREATE CONTINUOUS QUERY, DROP CONTINUOUS QUERY, and SHOW CONTINUOUS QUERY) are supported.
+Procedure
- Log in to the GeminiDB console.
- In the instance list, locate a target instance and click Log In in the Operation column.
Alternatively, click the instance name to go to the Basic Information page. Click Log In in the upper right corner of the page.
+ - Enter the password for logging in to the instance.
If you need to log in again after the password is reset, click Re-login in the upper right corner and use the new password.
+ - Manage relevant databases.
- Save commands to the execution record.
This function is enabled by default to save the recently executed commands for your later query.
+Then you can click the Executed Commands tab on the lower page to view historical commands.
++ Commands with passwords are not displayed on the Executed Commands tab page.
+If this function is disabled, the commands executed subsequently are not displayed any longer. You can click
+
next to Save Executed SQL Statements in the upper right corner to disable this function. - Execute a command.
You can enter a command in the command window and click Execute or F8.
+After a command is executed, you can view the execution result on the Results page.
+ - Save a command.
You can save a command to all instances or the current instance. Then you can view details in My Commands.
++ Commands with passwords cannot be saved to My Commands.
+ - View my commands.
Common commands are displayed the My Commands page.
+You can set a filter to narrow the scope of commands. If you select All, all commands saved in the current account are displayed.
+Alternatively, you can enter a command title or statement in the search box to search for the corresponding command.
+On the My Commands page, you can also create, edit, and delete a command or copy it to the command window.
+ - Clear commands.
You can also press F10 to clear the command in the command window.
+
- Save commands to the execution record.
++ + + \ No newline at end of file diff --git a/docs/geminidb/umn/nosql_09_0100.html b/docs/geminidb/umn/nosql_09_0100.html new file mode 100644 index 000000000..231e1e5ea --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0100.html @@ -0,0 +1,23 @@ + + + +++Parent topic: Getting Started with GeminiDB Influx+Connecting to a GeminiDB Influx Instance Using Program Code
+ +++ +++ diff --git a/docs/geminidb/umn/nosql_09_0101.html b/docs/geminidb/umn/nosql_09_0101.html new file mode 100644 index 000000000..51fd8ed47 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0101.html @@ -0,0 +1,56 @@ + + +-
+
- Connecting to an Instance Using Go
+
+ - Connecting to an Instance Using Java
+
+ - Connecting to an Instance Using Python
+
+
++Parent topic: Getting Started with GeminiDB Influx+Connecting to an Instance Using Java
++This section describes how to connect to a GeminiDB Influx instance using the Java programming language.
++Prerequisites
- You have downloaded the client code from the InfluxDB open-source project website.
+Example Code
package influxdb; + +import okhttp3.OkHttpClient; +import org.influxdb.InfluxDB; +import org.influxdb.InfluxDBFactory; +import org.influxdb.dto.Point; +import org.influxdb.dto.Query; +import org.influxdb.dto.QueryResult; + +import java.util.concurrent.TimeUnit; + +public class demoNoSSL { + public static void main(String[] args) { + OkHttpClient.Builder client = new OkHttpClient.Builder() + .connectTimeout(10, TimeUnit.SECONDS) + .writeTimeout(10, TimeUnit.SECONDS) + .readTimeout(10, TimeUnit.SECONDS) + .retryOnConnectionFailure(true); + + final String serverURL = "http://xx.xx.xx.xx:xx", username = "xx", password = "xx"; + InfluxDB influxdb = InfluxDBFactory.connect(serverURL, username, password, client); + + // Create a database... + String databaseName = "foo"; + + influxdb.query(new Query("CREATE DATABASE " + databaseName, databaseName)); + influxdb.setDatabase(databaseName); + + // Write points to influxdb. + influxdb.write(Point.measurement("bar") + .time(System.currentTimeMillis(), TimeUnit.MILLISECONDS) + .tag("location", "chengdu") + .addField("temperature", 22) + .build()); + + // Query your data using InfluxQL. + QueryResult queryResult = influxdb.query(new Query("SELECT * FROM bar", databaseName)); + + // Close it if your application is terminating or you are not using it anymore. + influxdb.close(); + } +}+++ diff --git a/docs/geminidb/umn/nosql_09_0102.html b/docs/geminidb/umn/nosql_09_0102.html new file mode 100644 index 000000000..d19526fc6 --- /dev/null +++ b/docs/geminidb/umn/nosql_09_0102.html @@ -0,0 +1,21 @@ + + ++ ++Connecting to an Instance Using Python
++This section describes how to connect to a GeminiDB Influx instance using Python.
++Prerequisites
The Python client of InfluxDB has been installed.
++Example Code
from influxdb import InfluxDBClient + +client = InfluxDBClient(host=IP, port="****", username="****", password="****", ssl=False) +client.get_list_database()
++ Replace host, port, username, and password with actual values.
+ +++ diff --git a/docs/geminidb/umn/nosql_increase_storage.html b/docs/geminidb/umn/nosql_increase_storage.html index 90bb90c9e..f0579eb12 100644 --- a/docs/geminidb/umn/nosql_increase_storage.html +++ b/docs/geminidb/umn/nosql_increase_storage.html @@ -6,7 +6,7 @@+ ++-Usage Notes
Storage space can only be scaled up.
Procedure
- Log in to the GeminiDB console.
- On the Instances page, click the target instance name.
- In the Storage Space area on the Basic Information page, click Scale.
- On the displayed page, specify the new storage capacity and click Next.
Select at least 1 GB each time you scale up the storage, and the storage size must be an integer.
+Procedure
- Log in to the GeminiDB console.
- On the Instances page, click the target instance.
- In the Storage Space area on the Basic Information page, click Scale.
- On the displayed page, specify the new storage capacity and click Next.
Select at least 1 GB each time you scale up the storage, and the storage size must be an integer.
- On the displayed page, confirm the storage space.
- If you need to modify your settings, click Previous to go back to the page where you specify details.
- If you do not need to modify your settings, click Submit to scale up the storage space.
- Check the scale-up result.
- The status of the DB instance in the instance list is Scaling up.
- After the scale up is completed, the DB instance status becomes Available.
- In the Storage Space area on the Basic Information page, check whether the scale up was successful.
-Usage Notes
- The instance is in the Available status.
- Once autoscaling is enabled, an agency will be created and fees will be automatically deducted.
Automatically Scaling Up Storage of a Single Instance
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the Storage Space area, click Auto Scale.Figure 1 Auto Scale-
- Toggle on Auto Scale and specify the parameters below.Figure 2 Configuring autoscaling+
Automatically Scaling Up Storage of a Single Instance
- Log in to the GeminiDB console.
- On the Instances page, click the target instance. The Basic Information page is displayed.
- In the Storage Space area, click Auto Scale.Figure 1 Auto Scale+
- Toggle on Auto Scale and specify the parameters below.Figure 2 Configuring autoscaling
Table 1 Parameter description Parameter
- Click OK.
-Automatically Scaling Up Storage of Multiple Instances In Batches
- Log in to the GeminiDB console.
- Select instances and click Auto Scale.Figure 3 Auto Scale-
- Select an instance, toggle on Auto Scale, and specify the parameters below.Figure 4 Batch Auto Scale+
Automatically Scaling Up Storage of Multiple Instances In Batches
- Log in to the GeminiDB console.
- Select instances and click Auto Scale.Figure 3 Auto Scale+
- Select an instance, toggle on Auto Scale, and specify the parameters below.Figure 4 Batch Auto Scale
- Parameter Template: You can export the parameters of the DB instance to a template for future use.
- Parameter Template: You can export the parameters of the DB instance to a template for future use.
- To submit the change, click OK.
- If you specify an existing directory to export the file, the system exports data to different files in the directory based on the specified range. If no data is exported for a given range, no file is generated.
