Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
Data Source schema for Byteplus::MongoDB::Instance
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: Optional[pulumi.Input[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 dictionaryThe 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 str
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
getInstance Result
The following output properties are available:
- Allow
List List<string>Ids - 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 stringNode Spec - ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
- Config
Server intStorage Space Gb - ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
- Config
Servers List<Byteplus.Get Instance Config Server> - ConfigServer information list.
- Config
Servers stringId - ConfigServer ID
- Created
Time string - Instance creation time (UTC).
- Db
Engine string - Database engine. The value is fixed as MongoDB
- Db
Engine stringVersion - 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 stringVersion Str - Database engine version string
- Expired
Time string - Instance expiration time (UTC).
- Id string
- 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 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
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<Byteplus.
Get Instance Mongo> - Mongos information list
- Mongos
Id string - Mongos ID.
- Mongos
Node intNumber - Number of Mongos nodes in the sharded cluster. Range: 2~32.
- Mongos
Node stringSpec - Specification code for Mongos nodes in a sharded cluster.
- Node
Availability List<Byteplus.Zones Get Instance Node Availability Zone> - 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 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.
Get Instance Node> - 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 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 intNode Number - Number of read-only nodes in the instance
- Reclaim
Time string - Scheduled recycle time for the instance (UTC)
- int
- Number of shards in the sharded cluster. Range: 2–32.
-
List<Byteplus.
Get Instance Shard> - Shard information list
- Storage
Space intGb - 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 stringName - 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 stringPassword - 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.
-
List<Byteplus.
Get Instance Tag> - MongoDB instance tag information
- Updated
Time string - Instance update time (UTC).
- Vpc
Id string - Private network ID.
- Zone
Id string - Availability zone ID where the instance is located.
- Allow
List []stringIds - 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 stringNode Spec - ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
- Config
Server intStorage Space Gb - ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
- Config
Servers []GetInstance Config Server - ConfigServer information list.
- Config
Servers stringId - ConfigServer ID
- Created
Time string - Instance creation time (UTC).
- Db
Engine string - Database engine. The value is fixed as MongoDB
- Db
Engine stringVersion - 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 stringVersion Str - Database engine version string
- Expired
Time string - Instance expiration time (UTC).
- Id string
- 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 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
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
[]Get
Instance Mongo - Mongos information list
- Mongos
Id string - Mongos ID.
- Mongos
Node intNumber - Number of Mongos nodes in the sharded cluster. Range: 2~32.
- Mongos
Node stringSpec - Specification code for Mongos nodes in a sharded cluster.
- Node
Availability []GetZones Instance Node Availability Zone - 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 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
[]Get
Instance Node - 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 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 intNode Number - Number of read-only nodes in the instance
- Reclaim
Time string - Scheduled recycle time for the instance (UTC)
- int
- Number of shards in the sharded cluster. Range: 2–32.
-
[]Get
Instance Shard - Shard information list
- Storage
Space intGb - 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 stringName - 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 stringPassword - 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.
-
[]Get
Instance Tag - MongoDB instance tag information
- Updated
Time string - Instance update time (UTC).
- Vpc
Id string - Private network ID.
- Zone
Id string - Availability zone ID where the instance is located.
- allow
List List<String>Ids - Allowlist ID list. New instances are bound to the specified allowlist.
- auto
Renew Boolean - 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 StringNode Spec - ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
- config
Server IntegerStorage Space Gb - ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
- config
Servers List<GetInstance Config Server> - ConfigServer information list.
- config
Servers StringId - ConfigServer ID
- created
Time String - Instance creation time (UTC).
- db
Engine String - Database engine. The value is fixed as MongoDB
- db
Engine StringVersion - 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 StringVersion Str - Database engine version string
- expired
Time String - Instance expiration time (UTC).
- id String
- Uniquely identifies the resource.
- instance
Count Integer - 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
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<Get
Instance Mongo> - Mongos information list
- mongos
Id String - Mongos ID.
- mongos
Node IntegerNumber - Number of Mongos nodes in the sharded cluster. Range: 2~32.
- mongos
Node StringSpec - Specification code for Mongos nodes in a sharded cluster.
- node
Availability List<GetZones Instance Node Availability Zone> - Add read-only node information, including the availability zone and quantity of read-only nodes.
- node
Number 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.
- 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<Get
Instance Node> - 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.
- 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 IntegerNode Number - Number of read-only nodes in the instance
- reclaim
Time String - Scheduled recycle time for the instance (UTC)
- Integer
- Number of shards in the sharded cluster. Range: 2–32.
-
List<Get
Instance Shard> - Shard information list
- storage
Space IntegerGb - 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 StringName - 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 StringPassword - 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.
-
List<Get
Instance Tag> - MongoDB instance tag information
- updated
Time String - Instance update time (UTC).
- vpc
Id String - Private network ID.
- zone
Id String - Availability zone ID where the instance is located.
- allow
List string[]Ids - Allowlist ID list. New instances are bound to the specified allowlist.
- auto
Renew boolean - 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 stringNode Spec - ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
- config
Server numberStorage Space Gb - ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
- config
Servers GetInstance Config Server[] - ConfigServer information list.
- config
Servers stringId - ConfigServer ID
- created
Time string - Instance creation time (UTC).
- db
Engine string - Database engine. The value is fixed as MongoDB
- db
Engine stringVersion - 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 stringVersion Str - 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
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
Get
Instance Mongo[] - Mongos information list
- mongos
Id string - Mongos ID.
- mongos
Node numberNumber - Number of Mongos nodes in the sharded cluster. Range: 2~32.
- mongos
Node stringSpec - Specification code for Mongos nodes in a sharded cluster.
- node
Availability GetZones Instance Node Availability Zone[] - 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
Get
Instance Node[] - 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 numberNode Number - Number of read-only nodes in the instance
- reclaim
Time string - Scheduled recycle time for the instance (UTC)
- number
- Number of shards in the sharded cluster. Range: 2–32.
-
Get
Instance Shard[] - Shard information list
- storage
Space numberGb - 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 stringName - 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 stringPassword - 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.
-
Get
Instance Tag[] - MongoDB instance tag information
- updated
Time string - Instance update time (UTC).
- vpc
Id string - Private network ID.
- zone
Id string - Availability zone ID where the instance is located.
- allow_
list_ Sequence[str]ids - 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_ strnode_ spec - ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
- config_
server_ intstorage_ space_ gb - ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
- config_
servers Sequence[GetInstance Config Server] - ConfigServer information list.
- config_
servers_ strid - ConfigServer ID
- created_
time str - Instance creation time (UTC).
- db_
engine str - Database engine. The value is fixed as MongoDB
- db_
engine_ strversion - 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_ strversion_ 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_
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[Get
Instance Mongo] - Mongos information list
- mongos_
id str - Mongos ID.
- mongos_
node_ intnumber - Number of Mongos nodes in the sharded cluster. Range: 2~32.
- mongos_
node_ strspec - Specification code for Mongos nodes in a sharded cluster.
- node_
availability_ Sequence[Getzones Instance Node Availability Zone] - 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[Get
Instance Node] - 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_ intnode_ number - Number of read-only nodes in the instance
- reclaim_
time str - Scheduled recycle time for the instance (UTC)
- int
- Number of shards in the sharded cluster. Range: 2–32.
-
Sequence[Get
Instance Shard] - Shard information list
- storage_
space_ intgb - 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_ strname - 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_ strpassword - 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.
-
Sequence[Get
Instance Tag] - MongoDB instance tag information
- updated_
time str - Instance update time (UTC).
- vpc_
id str - Private network ID.
- zone_
id str - Availability zone ID where the instance is located.
- allow
List List<String>Ids - Allowlist ID list. New instances are bound to the specified allowlist.
- auto
Renew Boolean - 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 StringNode Spec - ConfigServer node specification code in the sharded cluster. Default: mongo.config.1c2g.
- config
Server NumberStorage Space Gb - ConfigServer storage space in the sharded cluster, unit: GiB. Step size: 10. Default: 20.
- config
Servers List<Property Map> - ConfigServer information list.
- config
Servers StringId - ConfigServer ID
- created
Time String - Instance creation time (UTC).
- db
Engine String - Database engine. The value is fixed as MongoDB
- db
Engine StringVersion - 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 StringVersion Str - 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
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<Property Map>
- Mongos information list
- mongos
Id String - Mongos ID.
- mongos
Node NumberNumber - Number of Mongos nodes in the sharded cluster. Range: 2~32.
- mongos
Node StringSpec - Specification code for Mongos nodes in a sharded cluster.
- node
Availability List<Property Map>Zones - 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<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.
- 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 NumberNode Number - Number of read-only nodes in the instance
- reclaim
Time String - Scheduled recycle time for the instance (UTC)
- Number
- Number of shards in the sharded cluster. Range: 2–32.
- List<Property Map>
- Shard information list
- storage
Space NumberGb - 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 StringName - 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 StringPassword - 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.
- List<Property Map>
- MongoDB instance tag information
- updated
Time String - Instance update time (UTC).
- vpc
Id String - Private network ID.
- zone
Id String - Availability zone ID where the instance is located.
Supporting Types
GetInstanceConfigServer
- Config
Server stringNode Id - 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 doubleGb - Total memory. Unit: GiB.
- Totalv
Cpu double - Total cores.
- Used
Memory doubleGb - Used memory. Unit: GiB.
- Usedv
Cpu double - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- Config
Server stringNode Id - 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 float64Gb - Total memory. Unit: GiB.
- Totalv
Cpu float64 - Total cores.
- Used
Memory float64Gb - Used memory. Unit: GiB.
- Usedv
Cpu float64 - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- config
Server StringNode Id - 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 DoubleGb - Total memory. Unit: GiB.
- totalv
Cpu Double - Total cores.
- used
Memory DoubleGb - Used memory. Unit: GiB.
- usedv
Cpu Double - Used cores.
- zone
Id String - Availability zone ID of the current node.
- config
Server stringNode Id - 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 numberGb - Total memory. Unit: GiB.
- totalv
Cpu number - Total cores.
- used
Memory numberGb - Used memory. Unit: GiB.
- usedv
Cpu number - Used cores.
- zone
Id string - Availability zone ID of the current node.
- config_
server_ strnode_ id - 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_ floatgb - Total memory. Unit: GiB.
- totalv_
cpu float - Total cores.
- used_
memory_ floatgb - Used memory. Unit: GiB.
- usedv_
cpu float - Used cores.
- zone_
id str - Availability zone ID of the current node.
- config
Server StringNode Id - 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 NumberGb - Total memory. Unit: GiB.
- totalv
Cpu Number - Total cores.
- used
Memory NumberGb - Used memory. Unit: GiB.
- usedv
Cpu Number - Used cores.
- zone
Id String - Availability zone ID of the current node.
GetInstanceMongo
- Mongos
Node stringId - Mongos node ID
- Node
Spec string - Node specification.
- Node
Status string - Node status.
- Total
Memory doubleGb - Total memory. Unit: GiB.
- Totalv
Cpu double - Total cores.
- Used
Memory doubleGb - Used memory. Unit: GiB.
- Usedv
Cpu double - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- Mongos
Node stringId - Mongos node ID
- Node
Spec string - Node specification.
- Node
Status string - Node status.
- Total
Memory float64Gb - Total memory. Unit: GiB.
- Totalv
Cpu float64 - Total cores.
- Used
Memory float64Gb - Used memory. Unit: GiB.
- Usedv
Cpu float64 - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- mongos
Node StringId - Mongos node ID
- node
Spec String - Node specification.
- node
Status String - Node status.
- total
Memory DoubleGb - Total memory. Unit: GiB.
- totalv
Cpu Double - Total cores.
- used
Memory DoubleGb - Used memory. Unit: GiB.
- usedv
Cpu Double - Used cores.
- zone
Id String - Availability zone ID of the current node.
- mongos
Node stringId - Mongos node ID
- node
Spec string - Node specification.
- node
Status string - Node status.
- total
Memory numberGb - Total memory. Unit: GiB.
- totalv
Cpu number - Total cores.
- used
Memory numberGb - Used memory. Unit: GiB.
- usedv
Cpu number - Used cores.
- zone
Id string - Availability zone ID of the current node.
- mongos_
node_ strid - Mongos node ID
- node_
spec str - Node specification.
- node_
status str - Node status.
- total_
memory_ floatgb - Total memory. Unit: GiB.
- totalv_
cpu float - Total cores.
- used_
memory_ floatgb - Used memory. Unit: GiB.
- usedv_
cpu float - Used cores.
- zone_
id str - Availability zone ID of the current node.
- mongos
Node StringId - Mongos node ID
- node
Spec String - Node specification.
- node
Status String - Node status.
- total
Memory NumberGb - Total memory. Unit: GiB.
- totalv
Cpu Number - Total cores.
- used
Memory NumberGb - Used memory. Unit: GiB.
- usedv
Cpu Number - Used cores.
- zone
Id String - Availability zone ID of the current node.
GetInstanceNode
- Node
Delay intTime - 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 doubleGb - Total memory. Unit: GiB.
- Total
Storage doubleGb - Total storage space for this node. Unit: GiB.
- Totalv
Cpu double - Total cores.
- Used
Memory doubleGb - Used memory. Unit: GiB.
- Used
Storage doubleGb - Storage space used by this node. Unit: GiB.
- Usedv
Cpu double - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- Node
Delay intTime - 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 float64Gb - Total memory. Unit: GiB.
- Total
Storage float64Gb - Total storage space for this node. Unit: GiB.
- Totalv
Cpu float64 - Total cores.
- Used
Memory float64Gb - Used memory. Unit: GiB.
- Used
Storage float64Gb - Storage space used by this node. Unit: GiB.
- Usedv
Cpu float64 - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- node
Delay IntegerTime - 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 DoubleGb - Total memory. Unit: GiB.
- total
Storage DoubleGb - Total storage space for this node. Unit: GiB.
- totalv
Cpu Double - Total cores.
- used
Memory DoubleGb - Used memory. Unit: GiB.
- used
Storage DoubleGb - Storage space used by this node. Unit: GiB.
- usedv
Cpu Double - Used cores.
- zone
Id String - Availability zone ID of the current node.
- node
Delay numberTime - 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 numberGb - Total memory. Unit: GiB.
- total
Storage numberGb - Total storage space for this node. Unit: GiB.
- totalv
Cpu number - Total cores.
- used
Memory numberGb - Used memory. Unit: GiB.
- used
Storage numberGb - Storage space used by this node. Unit: GiB.
- usedv
Cpu number - Used cores.
- zone
Id string - Availability zone ID of the current node.
- node_
delay_ inttime - 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_ floatgb - Total memory. Unit: GiB.
- total_
storage_ floatgb - Total storage space for this node. Unit: GiB.
- totalv_
cpu float - Total cores.
- used_
memory_ floatgb - Used memory. Unit: GiB.
- used_
storage_ floatgb - Storage space used by this node. Unit: GiB.
- usedv_
cpu float - Used cores.
- zone_
id str - Availability zone ID of the current node.
- node
Delay NumberTime - 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 NumberGb - Total memory. Unit: GiB.
- total
Storage NumberGb - Total storage space for this node. Unit: GiB.
- totalv
Cpu Number - Total cores.
- used
Memory NumberGb - Used memory. Unit: GiB.
- used
Storage NumberGb - Storage space used by this node. Unit: GiB.
- usedv
Cpu Number - Used cores.
- zone
Id String - Availability zone ID of the current node.
GetInstanceNodeAvailabilityZone
- 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 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 string - Availability zone of the read-only node.
- node
Number 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.
- zone
Id 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.
- 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.
- 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.
GetInstanceShard
- Nodes
List<Byteplus.
Get Instance Shard Node> - List of node information in each Shard.
- string
- Shard node ID.
- Nodes
[]Get
Instance Shard Node - List of node information in each Shard.
- string
- Shard node ID.
- nodes
List<Get
Instance Shard Node> - List of node information in each Shard.
- String
- Shard node ID.
- nodes
Get
Instance Shard Node[] - List of node information in each Shard.
- string
- Shard node ID.
- nodes
Sequence[Get
Instance Shard Node] - List of node information in each Shard.
- str
- Shard node ID.
- nodes List<Property Map>
- List of node information in each Shard.
- String
- Shard node ID.
GetInstanceShardNode
- Node
Delay intTime - 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 doubleGb - Total memory. Unit: GiB.
- Total
Storage doubleGb - Total storage space for this node. Unit: GiB.
- Totalv
Cpu double - Total cores.
- Used
Memory doubleGb - Used memory. Unit: GiB.
- Used
Storage doubleGb - Storage space used by this node. Unit: GiB.
- Usedv
Cpu double - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- Node
Delay intTime - 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 float64Gb - Total memory. Unit: GiB.
- Total
Storage float64Gb - Total storage space for this node. Unit: GiB.
- Totalv
Cpu float64 - Total cores.
- Used
Memory float64Gb - Used memory. Unit: GiB.
- Used
Storage float64Gb - Storage space used by this node. Unit: GiB.
- Usedv
Cpu float64 - Used cores.
- Zone
Id string - Availability zone ID of the current node.
- node
Delay IntegerTime - 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 DoubleGb - Total memory. Unit: GiB.
- total
Storage DoubleGb - Total storage space for this node. Unit: GiB.
- totalv
Cpu Double - Total cores.
- used
Memory DoubleGb - Used memory. Unit: GiB.
- used
Storage DoubleGb - Storage space used by this node. Unit: GiB.
- usedv
Cpu Double - Used cores.
- zone
Id String - Availability zone ID of the current node.
- node
Delay numberTime - 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 numberGb - Total memory. Unit: GiB.
- total
Storage numberGb - Total storage space for this node. Unit: GiB.
- totalv
Cpu number - Total cores.
- used
Memory numberGb - Used memory. Unit: GiB.
- used
Storage numberGb - Storage space used by this node. Unit: GiB.
- usedv
Cpu number - Used cores.
- zone
Id string - Availability zone ID of the current node.
- node_
delay_ inttime - 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_ floatgb - Total memory. Unit: GiB.
- total_
storage_ floatgb - Total storage space for this node. Unit: GiB.
- totalv_
cpu float - Total cores.
- used_
memory_ floatgb - Used memory. Unit: GiB.
- used_
storage_ floatgb - Storage space used by this node. Unit: GiB.
- usedv_
cpu float - Used cores.
- zone_
id str - Availability zone ID of the current node.
- node
Delay NumberTime - 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 NumberGb - Total memory. Unit: GiB.
- total
Storage NumberGb - Total storage space for this node. Unit: GiB.
- totalv
Cpu Number - Total cores.
- used
Memory NumberGb - Used memory. Unit: GiB.
- used
Storage NumberGb - Storage space used by this node. Unit: GiB.
- usedv
Cpu Number - Used cores.
- zone
Id String - Availability zone ID of the current node.
GetInstanceTag
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
published on Thursday, Apr 2, 2026 by Byteplus
