tencent cloud

Feedback

Viewing Instance Details

Last updated: 2022-10-09 16:04:38

    Overview

    After purchasing a TencentDB for MongoDB instance, you can quickly view its details in the console, such as the status, capacity usage, primary/secondary nodes in the cluster, and network status. You can also perform Ops and management operations efficiently.

    Prerequisites

    Viewing the Instance List

    1. Log in to the TencentDB for MongoDB console.
    2. In the MongoDB drop-down list on the left sidebar, select Replica Set Instance or Sharded Cluster Instance. The directions for the two types of instances are similar.
    3. Above the instance list on the right, select the region.
    4. In the instance list, find the target instance.
    • In the search box in the top-right corner, you can search for the target instance by instance ID, instance name, private IP, or tag key.
    • If you can't find the target instance in the instance list, select Recycle Bin on the left sidebar to check whether it is isolated there due to overdue payments. For more information, see Recycle Bin.
    1. View the target instance information, such as the status, specification, and storage engine.
      ParameterDescription
      Instance ID/Name
      • Instance ID: The instance's unique ID.
      • Name: Instance name set during instance creation. You can hover over the instance name and click to rename the instance for easier identification and management.
      Monitoring/Status
      • Monitoring: You can click to enter the monitoring panel and view the instance monitoring data. For more information, see Viewing Monitoring Data.
      • Status: Instance status. The normal status is Running. If a task is being executed in the instance, the task name, such as **Changing configuration**, will be displayed here.
      Configure/Network
      • Configure: The specification configuration of each instance node.
      • Replica set: Memory and disk capacity.
      • Sharded cluster instance: Memory and disk capacity * shard quantity.
      • Network: The network information of the instance.
      Version and Engine
      • Database version information. Supported versions include 4.4, 4.2, 4.0, 3.6, and 3.2. v3.2 is no longer purchasable.
      • Storage engine: It is WiredTiger by default.
      Private Network Address The private IPv4 address and port of all primary and secondary mongod nodes in the TencentDB instance. A TencentDB instance can be accessed only over the private network. When using MongoDB Shell for access, you need to configure the private IP and port. For detailed directions, see Connecting to TencentDB for MongoDB Instance.
      Billing Mode Instance billing mode, which is pay-as-you-go. For more information, see Billing Overview.
      Used/Total The used/total memory of the instance. This parameter helps you quickly check the memory utilization of the current instance.
      Oplog/Shard Info You can click View/Adjust to view the capacity reserved for oplog or adjust it based on your business needs. For detailed directions, see Adjusting Oplog Capacity.
      Project Instance project. You can view the information of all instances in this project. You can also move the instance to another project as instructed in Specifying Project for Instance.
      Protocol It is fixed at MongoDB protocol.
      Operation
      • Select Adjust Configuration > Adjust Configuration to adjust the instance's memory and disk capacity as instructed in Adjusting Instance Specification.
      • Select Adjust Configuration > Node Management to manage the mongod and mongos nodes of the instance as instructed in Viewing Node Information.
      • Select More > Security Group to change security group inbound rules.
      • Select More > Restart to restart the instance as instructed in Restarting Instance.
      • For a pay-as-you-go instance, you can select More > Terminate to return it and isolate it into the recycle bin as instructed in Terminating Instance.
      • Select More > Manage to view the instance details.
      • Select More > Edit Tag to edit the instance tag keys and values as instructed in Editing Instance Tag.

    Viewing Instance Details

    In the Instance ID/Name column of the target instance, click the instance ID to enter the Instance Details page.

    SectionParameterDescription
    Basic Info Instance Name Custom instance name.
    Instance ID The instance's unique ID.
    Instance StatusThe instance's current status. The normal status is **Running**.
    RegionInstance region and AZ. You can click Modify AZs to switch to another AZ in the same region. For more information, see Modifying Instance AZ.
    ProjectThe project to which the instance belongs. You can click Switch to Another Project to assign the instance to another project as instructed in Specifying Project for Instance.
    Specs Info Instance TypeYou can set the instance cluster architecture type to **Replica Set** or **Sharded Cluster**. For more information, see System Architecture.
    Configuration TypeIt is fixed at **Ten-Gigabit High IO**.
    Version and EngineThe version and the storage engine of the instance. If the current version is 3.6, you can click Upgrade to v4.0 to upgrade to v4.0. If the current version is 4.0, you can click Upgrade to v4.2 to upgrade to v4.2. For detailed directions, see Version Upgrade.
    Mongod Node SpecificationThe specification configuration information of a single mongod node, including the CPU core quantity, memory, disk capacity, and node quantity. For the detailed specifications supported by replica set and sharded cluster instances, see Product Specifications.
    Mongos Node SpecificationThe specification configuration information of a single mongos node, including the CPU core quantity, memory, and node quantity. For the detailed specifications supported by replica set and sharded cluster instances, see Product Specifications.
    Disk CapacityThe total disk capacity of the instance.
    Configuration Billing ModeInstance billing mode, which is pay-as-you-go.
    Creation TimeInstance creation time.
    Maintenance TimeInstance maintenance time. To ensure the database stability, the backend system performs maintenance operations on the instance during the maintenance time. You can click Modify to adjust the maintenance time as instructed in Setting Instance Maintenance Time. We recommend you set it to a time during off-peak hours.
    Auth-Free AccessYou can view whether auth-free access to databases is enabled. If the status is Not enabled yet, you can click **Enable** to enable this feature as instructed in Accessing Instance Without Authentication.
    TagTags associated with the instance. You can modify them as instructed in Editing Instance Tag.
    Network Configuration NetworkInstance VPC name. You can click Switch Network to switch the VPC and subnet as instructed in Switching Instance Network. If needed, you can also create a VPC as instructed in Creating VPC.
    SubnetAZ-specific subnet in the instance VPC. A VPC allows for subnets in different AZs, which can communicate with each other over the private network by default. After you modify the instance AZ, we recommend you also switch the subnet to reduce the access latency.
    Connection Type The node type for database access.
    • Access Read-Write Primary Node: The database will be accessed on the primary node of the instance. The primary node can be read and written.
    • Only read read-only node: The database will be accessed only on a read-only node. If you didn't configure read-only nodes during instance creation, this parameter won't be displayed.
    • Only read secondary node: The database will be accessed only on a replica node.
    • Only read secondary node and read-only node: The database will be accessed on a secondary node preferentially. If all secondary nodes are abnormal, the database will be accessed on a read-only node.
    Access address (connection string)The URI connection string of each connection type. You can directly copy a string to access the database as instructed in Connecting to TencentDB for MongoDB Instance.

    More Operations

    Renaming an instance

    1. In the instance list, hover over the instance name to be modified and click on the right.
    2. In the instance name input box, enter a new name, which must meet the following requirements:
      • It can contain 1–60 characters.
      • It can contain letters, digits, underscores, and hyphens.
      • A letter, digit, or special symbol is counted as one character.

    Setting fields in the instance list

    1. Click in the top-right corner of the instance list.
    2. On the Display Settings page, select the fields to be displayed.
    3. Click OK, and you can see the set fields in the instance list.

    Exporting the instance list

    You can click in the top-right corner of the instance list to export the entire list.

    API Description
    DescribeDBInstances Queries the list of TencentDB instances
    RenameInstance Renames instance
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support