bytepluscc.mongodb.getInstance

bytepluscc v0.0.27, May 14 26

Viewing docs for bytepluscc v0.0.27
published on Thursday, May 14, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.27
published on Thursday, May 14, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getInstance

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>

def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: pulumi.Input[Optional[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]

func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

fn::invoke:
  function: bytepluscc:mongodb/getInstance:getInstance
  arguments:
    # arguments dictionary

data "bytepluscc_mongodb_getinstance" "name" {
    # arguments
}

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getInstance Result

The following output properties are available:

AllowListIds List<string>: Allowlist ID list. New instances are bound to the specified allowlist.
AutoRenew bool: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
ChargeStatus string: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
ChargeType string: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
ClosedTime string: Scheduled shutdown time (UTC).
ConfigServerNodeSpec string: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
ConfigServerStorageSpaceGb int: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
ConfigServers List<Byteplus.GetInstanceConfigServer>: ConfigServer information list.
ConfigServersId string: ConfigServer ID
CreatedTime string: Instance creation time (UTC).
DbEngine string: Database engine. The value is fixed as MongoDB
DbEngineVersion string: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
DbEngineVersionStr string: Database engine version string
ExpiredTime string: Instance expiration time (UTC).
Id string: Uniquely identifies the resource.
InstanceCount int: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
InstanceId string: Instance ID.
InstanceName string: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
InstanceParameters List<Byteplus.GetInstanceInstanceParameter>: Instance parameter list
InstanceStatus string: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
InstanceType string: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
Mongos List<Byteplus.GetInstanceMongo>: Mongos information list
MongosId string: Mongos ID.
MongosNodeNumber int: Number of Mongos nodes in the sharded cluster. Range: 2~32.
MongosNodeSpec string: Specification code for Mongos nodes in a sharded cluster.
NodeAvailabilityZones List<Byteplus.GetInstanceNodeAvailabilityZone>: Add read-only node information, including the availability zone and quantity of read-only nodes.
NodeNumber int: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
NodeSpec string: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
Nodes List<Byteplus.GetInstanceNode>: Information list for each node in the replica set instance or each node in the sharded cluster shard
Period int: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
PeriodUnit string: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
PrivateEndpoint string: String information for the instance's private network connection address.
ProjectName string: Select the project for the instance. If left blank, the new instance will be added to the default project.
ReadOnlyNodeNumber int: Number of read-only nodes in the instance
ReclaimTime string: Scheduled recycle time for the instance (UTC)
ShardNumber int: Number of shards in the sharded cluster. Range: 2–32.
Shards List<Byteplus.GetInstanceShard>: Shard information list
StorageSpaceGb int: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
StorageType string: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
SubnetId string: Subnet ID.
SuperAccountName string: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
SuperAccountPassword string: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
Tags List<Byteplus.GetInstanceTag>: MongoDB instance tag information
UpdatedTime string: Instance update time (UTC).
VpcId string: Private network ID.
ZoneId string: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

AllowListIds []string: Allowlist ID list. New instances are bound to the specified allowlist.
AutoRenew bool: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
ChargeStatus string: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
ChargeType string: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
ClosedTime string: Scheduled shutdown time (UTC).
ConfigServerNodeSpec string: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
ConfigServerStorageSpaceGb int: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
ConfigServers []GetInstanceConfigServer: ConfigServer information list.
ConfigServersId string: ConfigServer ID
CreatedTime string: Instance creation time (UTC).
DbEngine string: Database engine. The value is fixed as MongoDB
DbEngineVersion string: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
DbEngineVersionStr string: Database engine version string
ExpiredTime string: Instance expiration time (UTC).
Id string: Uniquely identifies the resource.
InstanceCount int: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
InstanceId string: Instance ID.
InstanceName string: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
InstanceParameters []GetInstanceInstanceParameter: Instance parameter list
InstanceStatus string: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
InstanceType string: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
Mongos []GetInstanceMongo: Mongos information list
MongosId string: Mongos ID.
MongosNodeNumber int: Number of Mongos nodes in the sharded cluster. Range: 2~32.
MongosNodeSpec string: Specification code for Mongos nodes in a sharded cluster.
NodeAvailabilityZones []GetInstanceNodeAvailabilityZone: Add read-only node information, including the availability zone and quantity of read-only nodes.
NodeNumber int: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
NodeSpec string: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
Nodes []GetInstanceNode: Information list for each node in the replica set instance or each node in the sharded cluster shard
Period int: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
PeriodUnit string: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
PrivateEndpoint string: String information for the instance's private network connection address.
ProjectName string: Select the project for the instance. If left blank, the new instance will be added to the default project.
ReadOnlyNodeNumber int: Number of read-only nodes in the instance
ReclaimTime string: Scheduled recycle time for the instance (UTC)
ShardNumber int: Number of shards in the sharded cluster. Range: 2–32.
Shards []GetInstanceShard: Shard information list
StorageSpaceGb int: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
StorageType string: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
SubnetId string: Subnet ID.
SuperAccountName string: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
SuperAccountPassword string: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
Tags []GetInstanceTag: MongoDB instance tag information
UpdatedTime string: Instance update time (UTC).
VpcId string: Private network ID.
ZoneId string: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

allow_list_ids list(string): Allowlist ID list. New instances are bound to the specified allowlist.
auto_renew bool: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
charge_status string: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
charge_type string: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
closed_time string: Scheduled shutdown time (UTC).
config_server_node_spec string: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
config_server_storage_space_gb number: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
config_servers list(object): ConfigServer information list.
config_servers_id string: ConfigServer ID
created_time string: Instance creation time (UTC).
db_engine string: Database engine. The value is fixed as MongoDB
db_engine_version string: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
db_engine_version_str string: Database engine version string
expired_time string: Instance expiration time (UTC).
id string: Uniquely identifies the resource.
instance_count number: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
instance_id string: Instance ID.
instance_name string: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
instance_parameters list(object): Instance parameter list
instance_status string: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
instance_type string: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
mongos list(object): Mongos information list
mongos_id string: Mongos ID.
mongos_node_number number: Number of Mongos nodes in the sharded cluster. Range: 2~32.
mongos_node_spec string: Specification code for Mongos nodes in a sharded cluster.
node_availability_zones list(object): Add read-only node information, including the availability zone and quantity of read-only nodes.
node_number number: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
node_spec string: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
nodes list(object): Information list for each node in the replica set instance or each node in the sharded cluster shard
period number: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
period_unit string: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
private_endpoint string: String information for the instance's private network connection address.
project_name string: Select the project for the instance. If left blank, the new instance will be added to the default project.
read_only_node_number number: Number of read-only nodes in the instance
reclaim_time string: Scheduled recycle time for the instance (UTC)
shard_number number: Number of shards in the sharded cluster. Range: 2–32.
shards list(object): Shard information list
storage_space_gb number: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
storage_type string: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
subnet_id string: Subnet ID.
super_account_name string: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
super_account_password string: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
tags list(object): MongoDB instance tag information
updated_time string: Instance update time (UTC).
vpc_id string: Private network ID.
zone_id string: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

allowListIds List<String>: Allowlist ID list. New instances are bound to the specified allowlist.
autoRenew Boolean: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
chargeStatus String: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
chargeType String: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
closedTime String: Scheduled shutdown time (UTC).
configServerNodeSpec String: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
configServerStorageSpaceGb Integer: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
configServers List<GetInstanceConfigServer>: ConfigServer information list.
configServersId String: ConfigServer ID
createdTime String: Instance creation time (UTC).
dbEngine String: Database engine. The value is fixed as MongoDB
dbEngineVersion String: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
dbEngineVersionStr String: Database engine version string
expiredTime String: Instance expiration time (UTC).
id String: Uniquely identifies the resource.
instanceCount Integer: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
instanceId String: Instance ID.
instanceName String: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
instanceParameters List<GetInstanceInstanceParameter>: Instance parameter list
instanceStatus String: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
instanceType String: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
mongos List<GetInstanceMongo>: Mongos information list
mongosId String: Mongos ID.
mongosNodeNumber Integer: Number of Mongos nodes in the sharded cluster. Range: 2~32.
mongosNodeSpec String: Specification code for Mongos nodes in a sharded cluster.
nodeAvailabilityZones List<GetInstanceNodeAvailabilityZone>: Add read-only node information, including the availability zone and quantity of read-only nodes.
nodeNumber Integer: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
nodeSpec String: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
nodes List<GetInstanceNode>: Information list for each node in the replica set instance or each node in the sharded cluster shard
period Integer: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
periodUnit String: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
privateEndpoint String: String information for the instance's private network connection address.
projectName String: Select the project for the instance. If left blank, the new instance will be added to the default project.
readOnlyNodeNumber Integer: Number of read-only nodes in the instance
reclaimTime String: Scheduled recycle time for the instance (UTC)
shardNumber Integer: Number of shards in the sharded cluster. Range: 2–32.
shards List<GetInstanceShard>: Shard information list
storageSpaceGb Integer: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
storageType String: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
subnetId String: Subnet ID.
superAccountName String: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
superAccountPassword String: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
tags List<GetInstanceTag>: MongoDB instance tag information
updatedTime String: Instance update time (UTC).
vpcId String: Private network ID.
zoneId String: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

allowListIds string[]: Allowlist ID list. New instances are bound to the specified allowlist.
autoRenew boolean: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
chargeStatus string: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
chargeType string: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
closedTime string: Scheduled shutdown time (UTC).
configServerNodeSpec string: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
configServerStorageSpaceGb number: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
configServers GetInstanceConfigServer[]: ConfigServer information list.
configServersId string: ConfigServer ID
createdTime string: Instance creation time (UTC).
dbEngine string: Database engine. The value is fixed as MongoDB
dbEngineVersion string: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
dbEngineVersionStr string: Database engine version string
expiredTime string: Instance expiration time (UTC).
id string: Uniquely identifies the resource.
instanceCount number: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
instanceId string: Instance ID.
instanceName string: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
instanceParameters GetInstanceInstanceParameter[]: Instance parameter list
instanceStatus string: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
instanceType string: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
mongos GetInstanceMongo[]: Mongos information list
mongosId string: Mongos ID.
mongosNodeNumber number: Number of Mongos nodes in the sharded cluster. Range: 2~32.
mongosNodeSpec string: Specification code for Mongos nodes in a sharded cluster.
nodeAvailabilityZones GetInstanceNodeAvailabilityZone[]: Add read-only node information, including the availability zone and quantity of read-only nodes.
nodeNumber number: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
nodeSpec string: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
nodes GetInstanceNode[]: Information list for each node in the replica set instance or each node in the sharded cluster shard
period number: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
periodUnit string: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
privateEndpoint string: String information for the instance's private network connection address.
projectName string: Select the project for the instance. If left blank, the new instance will be added to the default project.
readOnlyNodeNumber number: Number of read-only nodes in the instance
reclaimTime string: Scheduled recycle time for the instance (UTC)
shardNumber number: Number of shards in the sharded cluster. Range: 2–32.
shards GetInstanceShard[]: Shard information list
storageSpaceGb number: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
storageType string: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
subnetId string: Subnet ID.
superAccountName string: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
superAccountPassword string: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
tags GetInstanceTag[]: MongoDB instance tag information
updatedTime string: Instance update time (UTC).
vpcId string: Private network ID.
zoneId string: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

allow_list_ids Sequence[str]: Allowlist ID list. New instances are bound to the specified allowlist.
auto_renew bool: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
charge_status str: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
charge_type str: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
closed_time str: Scheduled shutdown time (UTC).
config_server_node_spec str: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
config_server_storage_space_gb int: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
config_servers Sequence[GetInstanceConfigServer]: ConfigServer information list.
config_servers_id str: ConfigServer ID
created_time str: Instance creation time (UTC).
db_engine str: Database engine. The value is fixed as MongoDB
db_engine_version str: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
db_engine_version_str str: Database engine version string
expired_time str: Instance expiration time (UTC).
id str: Uniquely identifies the resource.
instance_count int: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
instance_id str: Instance ID.
instance_name str: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
instance_parameters Sequence[GetInstanceInstanceParameter]: Instance parameter list
instance_status str: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
instance_type str: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
mongos Sequence[GetInstanceMongo]: Mongos information list
mongos_id str: Mongos ID.
mongos_node_number int: Number of Mongos nodes in the sharded cluster. Range: 2~32.
mongos_node_spec str: Specification code for Mongos nodes in a sharded cluster.
node_availability_zones Sequence[GetInstanceNodeAvailabilityZone]: Add read-only node information, including the availability zone and quantity of read-only nodes.
node_number int: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
node_spec str: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
nodes Sequence[GetInstanceNode]: Information list for each node in the replica set instance or each node in the sharded cluster shard
period int: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
period_unit str: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
private_endpoint str: String information for the instance's private network connection address.
project_name str: Select the project for the instance. If left blank, the new instance will be added to the default project.
read_only_node_number int: Number of read-only nodes in the instance
reclaim_time str: Scheduled recycle time for the instance (UTC)
shard_number int: Number of shards in the sharded cluster. Range: 2–32.
shards Sequence[GetInstanceShard]: Shard information list
storage_space_gb int: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
storage_type str: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
subnet_id str: Subnet ID.
super_account_name str: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
super_account_password str: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
tags Sequence[GetInstanceTag]: MongoDB instance tag information
updated_time str: Instance update time (UTC).
vpc_id str: Private network ID.
zone_id str: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

allowListIds List<String>: Allowlist ID list. New instances are bound to the specified allowlist.
autoRenew Boolean: Enable auto-renewal. Options: false (default): auto-renewal disabled. true: auto-renewal enabled.
chargeStatus String: Instance billing status. Valid values: Normal: normal. WaitingPaid: waiting for payment. ChangingPayType: changing billing type. Renewing: renewing. Overdue: overdue. Owing: owing. Unsubscribing: unsubscribing.
chargeType String: Instance billing type. Options: PostPaid (default): pay-as-you-go (also called postpaid). Prepaid: subscription (also called prepaid).
closedTime String: Scheduled shutdown time (UTC).
configServerNodeSpec String: ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
configServerStorageSpaceGb Number: ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
configServers List<Property Map>: ConfigServer information list.
configServersId String: ConfigServer ID
createdTime String: Instance creation time (UTC).
dbEngine String: Database engine. The value is fixed as MongoDB
dbEngineVersion String: Database engine version. Options: MongoDB40 (default): MongoDB 4.0. MongoDB42: MongoDB 4.2. MongoDB44: MongoDB 4.4. MongoDB50: MongoDB 5.0. MongoDB60: MongoDB 6.0. MongoDB70: MongoDB 7.0.
dbEngineVersionStr String: Database engine version string
expiredTime String: Instance expiration time (UTC).
id String: Uniquely identifies the resource.
instanceCount Number: Number of instances to create. Must be a positive integer greater than or equal to 1. Default is 1.
instanceId String: Instance ID.
instanceName String: Instance name. The name must meet the following requirements: Cannot start with a digit or hyphen (-). Can only contain Chinese characters, letters, digits, underscores (_), and hyphens (-). Length must be 2–64 characters.
instanceParameters List<Property Map>: Instance parameter list
instanceStatus String: Instance status. Creating: Creating. Running: Running. Allowlist maintenance: AllowListMaintaining. Scaling: Scaling. Restarting: Restarting. Network maintaining: NetworkMaintaining. Restoring: Restoring. Upgrading: Upgrading. Unavailable: Unavailable. Closing: Closing. Deleting: Deleting. Closed: Closed. SSL updating: SSLUpdating. Switch mastering: SwitchMastering. Role changing: RoleChanging. Migrating: Migrating.
instanceType String: MongoDB instance type. Valid values: ReplicaSet (default): replica set. ShardedCluster: sharded cluster.
mongos List<Property Map>: Mongos information list
mongosId String: Mongos ID.
mongosNodeNumber Number: Number of Mongos nodes in the sharded cluster. Range: 2~32.
mongosNodeSpec String: Specification code for Mongos nodes in a sharded cluster.
nodeAvailabilityZones List<Property Map>: Add read-only node information, including the availability zone and quantity of read-only nodes.
nodeNumber Number: Node count. When the instance type is ReplicaSet, this parameter indicates the number of compute nodes in the replica set instance. When the instance type is ShardedCluster, it indicates the number of nodes in each shard.
nodeSpec String: Instance specification code. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this parameter specifies the compute node specification for the replica set instance. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this parameter specifies the specification for Shard nodes.
nodes List<Property Map>: Information list for each node in the replica set instance or each node in the sharded cluster shard
period Number: Subscription instance purchase duration. When PeriodUnit is Year, Period can be 1–3. When PeriodUnit is Month, Period can be 1–9.
periodUnit String: Specify whether the subscription instance is yearly or monthly. Options: Year: yearly. Month: monthly.
privateEndpoint String: String information for the instance's private network connection address.
projectName String: Select the project for the instance. If left blank, the new instance will be added to the default project.
readOnlyNodeNumber Number: Number of read-only nodes in the instance
reclaimTime String: Scheduled recycle time for the instance (UTC)
shardNumber Number: Number of shards in the sharded cluster. Range: 2–32.
shards List<Property Map>: Shard information list
storageSpaceGb Number: Total storage space for replica set instances, or storage space for a single Shard in a sharded cluster. Unit: GiB, step size: 10.
storageType String: Instance storage type. Currently, only local SSD disks (LocalSSD) are supported.
subnetId String: Subnet ID.
superAccountName String: Database account name. Currently, only the super administrator account can be set when creating an instance. The account name is fixed as root.
superAccountPassword String: Password for the root account. The password must meet the following requirements: Only uppercase and lowercase letters, digits, and the following special characters _#!@$%^&*()+=-. Length: 8–32 characters. Must contain at least three of the following character types: uppercase letters, lowercase letters, digits, or special characters. Weak passwords that are easily cracked (such as Admin@123) are not allowed.
tags List<Property Map>: MongoDB instance tag information
updatedTime String: Instance update time (UTC).
vpcId String: Private network ID.
zoneId String: The ID of the availability zone where the instance is located. If you want to deploy a new instance across multiple availability zones, you can provide three availability zone IDs, separated by English commas (,).

Supporting Types

GetInstanceConfigServer

ConfigServerNodeId string: ConfigServer node ID
NodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
NodeStatus string: Node status.
TotalMemoryGb double: Total memory. Unit: GiB.
TotalvCpu double: Total cores.
UsedMemoryGb double: Used memory. Unit: GiB.
UsedvCpu double: Used cores.
ZoneId string: Availability zone ID of the current node.

ConfigServerNodeId string: ConfigServer node ID
NodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
NodeStatus string: Node status.
TotalMemoryGb float64: Total memory. Unit: GiB.
TotalvCpu float64: Total cores.
UsedMemoryGb float64: Used memory. Unit: GiB.
UsedvCpu float64: Used cores.
ZoneId string: Availability zone ID of the current node.

config_server_node_id string: ConfigServer node ID
node_role string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
node_status string: Node status.
total_memory_gb number: Total memory. Unit: GiB.
totalv_cpu number: Total cores.
used_memory_gb number: Used memory. Unit: GiB.
usedv_cpu number: Used cores.
zone_id string: Availability zone ID of the current node.

configServerNodeId String: ConfigServer node ID
nodeRole String: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
nodeStatus String: Node status.
totalMemoryGb Double: Total memory. Unit: GiB.
totalvCpu Double: Total cores.
usedMemoryGb Double: Used memory. Unit: GiB.
usedvCpu Double: Used cores.
zoneId String: Availability zone ID of the current node.

configServerNodeId string: ConfigServer node ID
nodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
nodeStatus string: Node status.
totalMemoryGb number: Total memory. Unit: GiB.
totalvCpu number: Total cores.
usedMemoryGb number: Used memory. Unit: GiB.
usedvCpu number: Used cores.
zoneId string: Availability zone ID of the current node.

config_server_node_id str: ConfigServer node ID
node_role str: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
node_status str: Node status.
total_memory_gb float: Total memory. Unit: GiB.
totalv_cpu float: Total cores.
used_memory_gb float: Used memory. Unit: GiB.
usedv_cpu float: Used cores.
zone_id str: Availability zone ID of the current node.

configServerNodeId String: ConfigServer node ID
nodeRole String: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node.
nodeStatus String: Node status.
totalMemoryGb Number: Total memory. Unit: GiB.
totalvCpu Number: Total cores.
usedMemoryGb Number: Used memory. Unit: GiB.
usedvCpu Number: Used cores.
zoneId String: Availability zone ID of the current node.

GetInstanceInstanceParameter

CheckingCode string: Parameter validation rule
ForceModify bool: Whether to force modification
ForceRestart bool: Requires instance restart to take effect after modification
ParameterDefaultValue string: Parameter default value
ParameterDescription string: Parameter description
ParameterName string: Parameter name
ParameterRole string: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
ParameterType string: Parameter type. Optional values: String, Integer, Boolean, List, Float
ParameterValue string: Parameter value

CheckingCode string: Parameter validation rule
ForceModify bool: Whether to force modification
ForceRestart bool: Requires instance restart to take effect after modification
ParameterDefaultValue string: Parameter default value
ParameterDescription string: Parameter description
ParameterName string: Parameter name
ParameterRole string: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
ParameterType string: Parameter type. Optional values: String, Integer, Boolean, List, Float
ParameterValue string: Parameter value

checking_code string: Parameter validation rule
force_modify bool: Whether to force modification
force_restart bool: Requires instance restart to take effect after modification
parameter_default_value string: Parameter default value
parameter_description string: Parameter description
parameter_name string: Parameter name
parameter_role string: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
parameter_type string: Parameter type. Optional values: String, Integer, Boolean, List, Float
parameter_value string: Parameter value

checkingCode String: Parameter validation rule
forceModify Boolean: Whether to force modification
forceRestart Boolean: Requires instance restart to take effect after modification
parameterDefaultValue String: Parameter default value
parameterDescription String: Parameter description
parameterName String: Parameter name
parameterRole String: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
parameterType String: Parameter type. Optional values: String, Integer, Boolean, List, Float
parameterValue String: Parameter value

checkingCode string: Parameter validation rule
forceModify boolean: Whether to force modification
forceRestart boolean: Requires instance restart to take effect after modification
parameterDefaultValue string: Parameter default value
parameterDescription string: Parameter description
parameterName string: Parameter name
parameterRole string: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
parameterType string: Parameter type. Optional values: String, Integer, Boolean, List, Float
parameterValue string: Parameter value

checking_code str: Parameter validation rule
force_modify bool: Whether to force modification
force_restart bool: Requires instance restart to take effect after modification
parameter_default_value str: Parameter default value
parameter_description str: Parameter description
parameter_name str: Parameter name
parameter_role str: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
parameter_type str: Parameter type. Optional values: String, Integer, Boolean, List, Float
parameter_value str: Parameter value

checkingCode String: Parameter validation rule
forceModify Boolean: Whether to force modification
forceRestart Boolean: Requires instance restart to take effect after modification
parameterDefaultValue String: Parameter default value
parameterDescription String: Parameter description
parameterName String: Parameter name
parameterRole String: Parameter role. Optional values: Node, Shard, ConfigServer, Mongos
parameterType String: Parameter type. Optional values: String, Integer, Boolean, List, Float
parameterValue String: Parameter value

GetInstanceMongo

MongosNodeId string: Mongos node ID
NodeSpec string: Node specification.
NodeStatus string: Node status.
TotalMemoryGb double: Total memory. Unit: GiB.
TotalvCpu double: Total cores.
UsedMemoryGb double: Used memory. Unit: GiB.
UsedvCpu double: Used cores.
ZoneId string: Availability zone ID of the current node.

MongosNodeId string: Mongos node ID
NodeSpec string: Node specification.
NodeStatus string: Node status.
TotalMemoryGb float64: Total memory. Unit: GiB.
TotalvCpu float64: Total cores.
UsedMemoryGb float64: Used memory. Unit: GiB.
UsedvCpu float64: Used cores.
ZoneId string: Availability zone ID of the current node.

mongos_node_id string: Mongos node ID
node_spec string: Node specification.
node_status string: Node status.
total_memory_gb number: Total memory. Unit: GiB.
totalv_cpu number: Total cores.
used_memory_gb number: Used memory. Unit: GiB.
usedv_cpu number: Used cores.
zone_id string: Availability zone ID of the current node.

mongosNodeId String: Mongos node ID
nodeSpec String: Node specification.
nodeStatus String: Node status.
totalMemoryGb Double: Total memory. Unit: GiB.
totalvCpu Double: Total cores.
usedMemoryGb Double: Used memory. Unit: GiB.
usedvCpu Double: Used cores.
zoneId String: Availability zone ID of the current node.

mongosNodeId string: Mongos node ID
nodeSpec string: Node specification.
nodeStatus string: Node status.
totalMemoryGb number: Total memory. Unit: GiB.
totalvCpu number: Total cores.
usedMemoryGb number: Used memory. Unit: GiB.
usedvCpu number: Used cores.
zoneId string: Availability zone ID of the current node.

mongos_node_id str: Mongos node ID
node_spec str: Node specification.
node_status str: Node status.
total_memory_gb float: Total memory. Unit: GiB.
totalv_cpu float: Total cores.
used_memory_gb float: Used memory. Unit: GiB.
usedv_cpu float: Used cores.
zone_id str: Availability zone ID of the current node.

mongosNodeId String: Mongos node ID
nodeSpec String: Node specification.
nodeStatus String: Node status.
totalMemoryGb Number: Total memory. Unit: GiB.
totalvCpu Number: Total cores.
usedMemoryGb Number: Used memory. Unit: GiB.
usedvCpu Number: Used cores.
zoneId String: Availability zone ID of the current node.

GetInstanceNode

NodeDelayTime int: Node latency. Unit: seconds.
NodeId string: Node ID.
NodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
NodeSpec string: Node specification.
NodeStatus string: Node status.
TotalMemoryGb double: Total memory. Unit: GiB.
TotalStorageGb double: Total storage space for this node. Unit: GiB.
TotalvCpu double: Total cores.
UsedMemoryGb double: Used memory. Unit: GiB.
UsedStorageGb double: Storage space used by this node. Unit: GiB.
UsedvCpu double: Used cores.
ZoneId string: Availability zone ID of the current node.

NodeDelayTime int: Node latency. Unit: seconds.
NodeId string: Node ID.
NodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
NodeSpec string: Node specification.
NodeStatus string: Node status.
TotalMemoryGb float64: Total memory. Unit: GiB.
TotalStorageGb float64: Total storage space for this node. Unit: GiB.
TotalvCpu float64: Total cores.
UsedMemoryGb float64: Used memory. Unit: GiB.
UsedStorageGb float64: Storage space used by this node. Unit: GiB.
UsedvCpu float64: Used cores.
ZoneId string: Availability zone ID of the current node.

node_delay_time number: Node latency. Unit: seconds.
node_id string: Node ID.
node_role string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
node_spec string: Node specification.
node_status string: Node status.
total_memory_gb number: Total memory. Unit: GiB.
total_storage_gb number: Total storage space for this node. Unit: GiB.
totalv_cpu number: Total cores.
used_memory_gb number: Used memory. Unit: GiB.
used_storage_gb number: Storage space used by this node. Unit: GiB.
usedv_cpu number: Used cores.
zone_id string: Availability zone ID of the current node.

nodeDelayTime Integer: Node latency. Unit: seconds.
nodeId String: Node ID.
nodeRole String: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
nodeSpec String: Node specification.
nodeStatus String: Node status.
totalMemoryGb Double: Total memory. Unit: GiB.
totalStorageGb Double: Total storage space for this node. Unit: GiB.
totalvCpu Double: Total cores.
usedMemoryGb Double: Used memory. Unit: GiB.
usedStorageGb Double: Storage space used by this node. Unit: GiB.
usedvCpu Double: Used cores.
zoneId String: Availability zone ID of the current node.

nodeDelayTime number: Node latency. Unit: seconds.
nodeId string: Node ID.
nodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
nodeSpec string: Node specification.
nodeStatus string: Node status.
totalMemoryGb number: Total memory. Unit: GiB.
totalStorageGb number: Total storage space for this node. Unit: GiB.
totalvCpu number: Total cores.
usedMemoryGb number: Used memory. Unit: GiB.
usedStorageGb number: Storage space used by this node. Unit: GiB.
usedvCpu number: Used cores.
zoneId string: Availability zone ID of the current node.

node_delay_time int: Node latency. Unit: seconds.
node_id str: Node ID.
node_role str: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
node_spec str: Node specification.
node_status str: Node status.
total_memory_gb float: Total memory. Unit: GiB.
total_storage_gb float: Total storage space for this node. Unit: GiB.
totalv_cpu float: Total cores.
used_memory_gb float: Used memory. Unit: GiB.
used_storage_gb float: Storage space used by this node. Unit: GiB.
usedv_cpu float: Used cores.
zone_id str: Availability zone ID of the current node.

nodeDelayTime Number: Node latency. Unit: seconds.
nodeId String: Node ID.
nodeRole String: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
nodeSpec String: Node specification.
nodeStatus String: Node status.
totalMemoryGb Number: Total memory. Unit: GiB.
totalStorageGb Number: Total storage space for this node. Unit: GiB.
totalvCpu Number: Total cores.
usedMemoryGb Number: Used memory. Unit: GiB.
usedStorageGb Number: Storage space used by this node. Unit: GiB.
usedvCpu Number: Used cores.
zoneId String: Availability zone ID of the current node.

GetInstanceNodeAvailabilityZone

NodeNumber int: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
ZoneId string: Availability zone of the read-only node.

NodeNumber int: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
ZoneId string: Availability zone of the read-only node.

node_number number: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
zone_id string: Availability zone of the read-only node.

nodeNumber Integer: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
zoneId String: Availability zone of the read-only node.

nodeNumber number: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
zoneId string: Availability zone of the read-only node.

node_number int: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
zone_id str: Availability zone of the read-only node.

nodeNumber Number: Number of read-only nodes to add in the current availability zone. Currently, only replica set instances and Shard nodes in sharded cluster instances support adding read-only nodes. When the instance type is ReplicaSet (InstanceType is ReplicaSet), this value indicates the total number of read-only nodes in a single replica set instance. Each replica set instance supports up to 5 read-only nodes. When the instance type is ShardedCluster (InstanceType is ShardedCluster), this value indicates the number of read-only nodes per Shard node. Each Shard node supports up to 5 read-only nodes.
zoneId String: Availability zone of the read-only node.

GetInstanceShard

Nodes List<Byteplus.GetInstanceShardNode>: List of node information in each Shard.
ShardId string: Shard node ID.

Nodes []GetInstanceShardNode: List of node information in each Shard.
ShardId string: Shard node ID.

nodes list(object): List of node information in each Shard.
shard_id string: Shard node ID.

nodes List<GetInstanceShardNode>: List of node information in each Shard.
shardId String: Shard node ID.

nodes GetInstanceShardNode[]: List of node information in each Shard.
shardId string: Shard node ID.

nodes Sequence[GetInstanceShardNode]: List of node information in each Shard.
shard_id str: Shard node ID.

nodes List<Property Map>: List of node information in each Shard.
shardId String: Shard node ID.

GetInstanceShardNode

NodeDelayTime int: Node latency. Unit: seconds.
NodeId string: Node ID.
NodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
NodeSpec string: Node specification.
NodeStatus string: Node status.
TotalMemoryGb double: Total memory. Unit: GiB.
TotalStorageGb double: Total storage space for this node. Unit: GiB.
TotalvCpu double: Total cores.
UsedMemoryGb double: Used memory. Unit: GiB.
UsedStorageGb double: Storage space used by this node. Unit: GiB.
UsedvCpu double: Used cores.
ZoneId string: Availability zone ID of the current node.

NodeDelayTime int: Node latency. Unit: seconds.
NodeId string: Node ID.
NodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
NodeSpec string: Node specification.
NodeStatus string: Node status.
TotalMemoryGb float64: Total memory. Unit: GiB.
TotalStorageGb float64: Total storage space for this node. Unit: GiB.
TotalvCpu float64: Total cores.
UsedMemoryGb float64: Used memory. Unit: GiB.
UsedStorageGb float64: Storage space used by this node. Unit: GiB.
UsedvCpu float64: Used cores.
ZoneId string: Availability zone ID of the current node.

node_delay_time number: Node latency. Unit: seconds.
node_id string: Node ID.
node_role string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
node_spec string: Node specification.
node_status string: Node status.
total_memory_gb number: Total memory. Unit: GiB.
total_storage_gb number: Total storage space for this node. Unit: GiB.
totalv_cpu number: Total cores.
used_memory_gb number: Used memory. Unit: GiB.
used_storage_gb number: Storage space used by this node. Unit: GiB.
usedv_cpu number: Used cores.
zone_id string: Availability zone ID of the current node.

nodeDelayTime Integer: Node latency. Unit: seconds.
nodeId String: Node ID.
nodeRole String: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
nodeSpec String: Node specification.
nodeStatus String: Node status.
totalMemoryGb Double: Total memory. Unit: GiB.
totalStorageGb Double: Total storage space for this node. Unit: GiB.
totalvCpu Double: Total cores.
usedMemoryGb Double: Used memory. Unit: GiB.
usedStorageGb Double: Storage space used by this node. Unit: GiB.
usedvCpu Double: Used cores.
zoneId String: Availability zone ID of the current node.

nodeDelayTime number: Node latency. Unit: seconds.
nodeId string: Node ID.
nodeRole string: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
nodeSpec string: Node specification.
nodeStatus string: Node status.
totalMemoryGb number: Total memory. Unit: GiB.
totalStorageGb number: Total storage space for this node. Unit: GiB.
totalvCpu number: Total cores.
usedMemoryGb number: Used memory. Unit: GiB.
usedStorageGb number: Storage space used by this node. Unit: GiB.
usedvCpu number: Used cores.
zoneId string: Availability zone ID of the current node.

node_delay_time int: Node latency. Unit: seconds.
node_id str: Node ID.
node_role str: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
node_spec str: Node specification.
node_status str: Node status.
total_memory_gb float: Total memory. Unit: GiB.
total_storage_gb float: Total storage space for this node. Unit: GiB.
totalv_cpu float: Total cores.
used_memory_gb float: Used memory. Unit: GiB.
used_storage_gb float: Storage space used by this node. Unit: GiB.
usedv_cpu float: Used cores.
zone_id str: Availability zone ID of the current node.

nodeDelayTime Number: Node latency. Unit: seconds.
nodeId String: Node ID.
nodeRole String: Node role. Options: Primary: primary node. Secondary: secondary node. Hidden: hidden node. ReadOnly: read-only node.
nodeSpec String: Node specification.
nodeStatus String: Node status.
totalMemoryGb Number: Total memory. Unit: GiB.
totalStorageGb Number: Total storage space for this node. Unit: GiB.
totalvCpu Number: Total cores.
usedMemoryGb Number: Used memory. Unit: GiB.
usedStorageGb Number: Storage space used by this node. Unit: GiB.
usedvCpu Number: Used cores.
zoneId String: Availability zone ID of the current node.

GetInstanceTag

Key string: Tag key
Value string: Tag value.

Key string: Tag key
Value string: Tag value.

key string: Tag key
value string: Tag value.

key String: Tag key
value String: Tag value.

key string: Tag key
value string: Tag value.

key str: Tag key
value str: Tag value.

key String: Tag key
value String: Tag value.

Package Details

Repository: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.27
published on Thursday, May 14, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.mongodb.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceConfigServer

GetInstanceInstanceParameter

GetInstanceMongo

GetInstanceNode

GetInstanceNodeAvailabilityZone

GetInstanceShard

GetInstanceShardNode

GetInstanceTag

Package Details

On this page

On this page