volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
Data Source schema for Volcengine::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: volcenginecc: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 - 白名单 ID 列表。新建实例会被绑定到指定白名单。
- Auto
Renew bool - 是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
- Charge
Status string - 实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
- Charge
Type string - 实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
- Closed
Time string - 计划关停时间(UTC)。
- Config
Server stringNode Spec - 分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
- Config
Server intStorage Space Gb - 分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
- Config
Servers List<Volcengine.Get Instance Config Server> - ConfigServers 的信息列表。
- Config
Servers stringId - ConfigServer 的 ID。
- Created
Time string - 实例创建时间(UTC)。
- Db
Engine string - 数据库引擎。取值固定为 MongoDB
- Db
Engine stringVersion - 数据库引擎版本,取值范围如下:MongoDB40(默认):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 - 数据库引擎版本的字符串。
- Expired
Time string - 实例到期时间(UTC)。
- Id string
- Uniquely identifies the resource.
- Instance
Count int - 需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
- Instance
Id string - 实例 ID。
- Instance
Name string - 实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
- Instance
Status string - 实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
- Instance
Type string - MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
- Mongos
List<Volcengine.
Get Instance Mongo> - Mongos 的信息列表。
- Mongos
Id string - Mongos 的 ID。
- Mongos
Node intNumber - 分片集群中 Mongos 节点的数量。取值范围:2~32。
- Mongos
Node stringSpec - 分片集群中 Mongos 节点的规格码。
- Node
Availability List<Volcengine.Zones Get Instance Node Availability Zone> - 添加只读节点信息,包括只读节点所在的可用区和数量。
- Node
Number int - 节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
- Node
Spec string - 实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
- Nodes
List<Volcengine.
Get Instance Node> - 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。
- Period int
- 包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
- Period
Unit string - 指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
- Private
Endpoint string - 实例私网连接地址的字符串信息。
- Project
Name string - 选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
- Read
Only intNode Number - 实例的只读节点数量。
- Reclaim
Time string - 实例的计划回收时间(UTC)。
- int
- 分片集群中 Shard 分片的数量。取值范围:2~32。
-
List<Volcengine.
Get Instance Shard> - Shards 的信息列表。
- Storage
Space intGb - 副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
- Storage
Type string - 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
- Subnet
Id string - 子网 ID。
- Super
Account stringName - 数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
- Super
Account stringPassword - root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
-
List<Volcengine.
Get Instance Tag> - MongoDB实例的标签信息
- Updated
Time string - 实例的更新时间(UTC)。
- Vpc
Id string - 私有网络 ID。
- Zone
Id string - 实例所在可用区的 ID。
- Allow
List []stringIds - 白名单 ID 列表。新建实例会被绑定到指定白名单。
- Auto
Renew bool - 是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
- Charge
Status string - 实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
- Charge
Type string - 实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
- Closed
Time string - 计划关停时间(UTC)。
- Config
Server stringNode Spec - 分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
- Config
Server intStorage Space Gb - 分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
- Config
Servers []GetInstance Config Server - ConfigServers 的信息列表。
- Config
Servers stringId - ConfigServer 的 ID。
- Created
Time string - 实例创建时间(UTC)。
- Db
Engine string - 数据库引擎。取值固定为 MongoDB
- Db
Engine stringVersion - 数据库引擎版本,取值范围如下:MongoDB40(默认):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 - 数据库引擎版本的字符串。
- Expired
Time string - 实例到期时间(UTC)。
- Id string
- Uniquely identifies the resource.
- Instance
Count int - 需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
- Instance
Id string - 实例 ID。
- Instance
Name string - 实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
- Instance
Status string - 实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
- Instance
Type string - MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
- Mongos
[]Get
Instance Mongo - Mongos 的信息列表。
- Mongos
Id string - Mongos 的 ID。
- Mongos
Node intNumber - 分片集群中 Mongos 节点的数量。取值范围:2~32。
- Mongos
Node stringSpec - 分片集群中 Mongos 节点的规格码。
- Node
Availability []GetZones Instance Node Availability Zone - 添加只读节点信息,包括只读节点所在的可用区和数量。
- Node
Number int - 节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
- Node
Spec string - 实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
- Nodes
[]Get
Instance Node - 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。
- Period int
- 包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
- Period
Unit string - 指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
- Private
Endpoint string - 实例私网连接地址的字符串信息。
- Project
Name string - 选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
- Read
Only intNode Number - 实例的只读节点数量。
- Reclaim
Time string - 实例的计划回收时间(UTC)。
- int
- 分片集群中 Shard 分片的数量。取值范围:2~32。
-
[]Get
Instance Shard - Shards 的信息列表。
- Storage
Space intGb - 副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
- Storage
Type string - 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
- Subnet
Id string - 子网 ID。
- Super
Account stringName - 数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
- Super
Account stringPassword - root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
-
[]Get
Instance Tag - MongoDB实例的标签信息
- Updated
Time string - 实例的更新时间(UTC)。
- Vpc
Id string - 私有网络 ID。
- Zone
Id string - 实例所在可用区的 ID。
- allow
List List<String>Ids - 白名单 ID 列表。新建实例会被绑定到指定白名单。
- auto
Renew Boolean - 是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
- charge
Status String - 实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
- charge
Type String - 实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
- closed
Time String - 计划关停时间(UTC)。
- config
Server StringNode Spec - 分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
- config
Server IntegerStorage Space Gb - 分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
- config
Servers List<GetInstance Config Server> - ConfigServers 的信息列表。
- config
Servers StringId - ConfigServer 的 ID。
- created
Time String - 实例创建时间(UTC)。
- db
Engine String - 数据库引擎。取值固定为 MongoDB
- db
Engine StringVersion - 数据库引擎版本,取值范围如下:MongoDB40(默认):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 - 数据库引擎版本的字符串。
- expired
Time String - 实例到期时间(UTC)。
- id String
- Uniquely identifies the resource.
- instance
Count Integer - 需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
- instance
Id String - 实例 ID。
- instance
Name String - 实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
- instance
Status String - 实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
- instance
Type String - MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
- mongos
List<Get
Instance Mongo> - Mongos 的信息列表。
- mongos
Id String - Mongos 的 ID。
- mongos
Node IntegerNumber - 分片集群中 Mongos 节点的数量。取值范围:2~32。
- mongos
Node StringSpec - 分片集群中 Mongos 节点的规格码。
- node
Availability List<GetZones Instance Node Availability Zone> - 添加只读节点信息,包括只读节点所在的可用区和数量。
- node
Number Integer - 节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
- node
Spec String - 实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
- nodes
List<Get
Instance Node> - 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。
- period Integer
- 包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
- period
Unit String - 指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
- private
Endpoint String - 实例私网连接地址的字符串信息。
- project
Name String - 选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
- read
Only IntegerNode Number - 实例的只读节点数量。
- reclaim
Time String - 实例的计划回收时间(UTC)。
- Integer
- 分片集群中 Shard 分片的数量。取值范围:2~32。
-
List<Get
Instance Shard> - Shards 的信息列表。
- storage
Space IntegerGb - 副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
- storage
Type String - 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
- subnet
Id String - 子网 ID。
- super
Account StringName - 数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
- super
Account StringPassword - root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
-
List<Get
Instance Tag> - MongoDB实例的标签信息
- updated
Time String - 实例的更新时间(UTC)。
- vpc
Id String - 私有网络 ID。
- zone
Id String - 实例所在可用区的 ID。
- allow
List string[]Ids - 白名单 ID 列表。新建实例会被绑定到指定白名单。
- auto
Renew boolean - 是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
- charge
Status string - 实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
- charge
Type string - 实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
- closed
Time string - 计划关停时间(UTC)。
- config
Server stringNode Spec - 分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
- config
Server numberStorage Space Gb - 分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
- config
Servers GetInstance Config Server[] - ConfigServers 的信息列表。
- config
Servers stringId - ConfigServer 的 ID。
- created
Time string - 实例创建时间(UTC)。
- db
Engine string - 数据库引擎。取值固定为 MongoDB
- db
Engine stringVersion - 数据库引擎版本,取值范围如下:MongoDB40(默认):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 - 数据库引擎版本的字符串。
- expired
Time string - 实例到期时间(UTC)。
- id string
- Uniquely identifies the resource.
- instance
Count number - 需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
- instance
Id string - 实例 ID。
- instance
Name string - 实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
- instance
Status string - 实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
- instance
Type string - MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
- mongos
Get
Instance Mongo[] - Mongos 的信息列表。
- mongos
Id string - Mongos 的 ID。
- mongos
Node numberNumber - 分片集群中 Mongos 节点的数量。取值范围:2~32。
- mongos
Node stringSpec - 分片集群中 Mongos 节点的规格码。
- node
Availability GetZones Instance Node Availability Zone[] - 添加只读节点信息,包括只读节点所在的可用区和数量。
- node
Number number - 节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
- node
Spec string - 实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
- nodes
Get
Instance Node[] - 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。
- period number
- 包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
- period
Unit string - 指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
- private
Endpoint string - 实例私网连接地址的字符串信息。
- project
Name string - 选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
- read
Only numberNode Number - 实例的只读节点数量。
- reclaim
Time string - 实例的计划回收时间(UTC)。
- number
- 分片集群中 Shard 分片的数量。取值范围:2~32。
-
Get
Instance Shard[] - Shards 的信息列表。
- storage
Space numberGb - 副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
- storage
Type string - 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
- subnet
Id string - 子网 ID。
- super
Account stringName - 数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
- super
Account stringPassword - root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
-
Get
Instance Tag[] - MongoDB实例的标签信息
- updated
Time string - 实例的更新时间(UTC)。
- vpc
Id string - 私有网络 ID。
- zone
Id string - 实例所在可用区的 ID。
- allow_
list_ Sequence[str]ids - 白名单 ID 列表。新建实例会被绑定到指定白名单。
- auto_
renew bool - 是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
- charge_
status str - 实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
- charge_
type str - 实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
- closed_
time str - 计划关停时间(UTC)。
- config_
server_ strnode_ spec - 分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
- config_
server_ intstorage_ space_ gb - 分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
- config_
servers Sequence[GetInstance Config Server] - ConfigServers 的信息列表。
- config_
servers_ strid - ConfigServer 的 ID。
- created_
time str - 实例创建时间(UTC)。
- db_
engine str - 数据库引擎。取值固定为 MongoDB
- db_
engine_ strversion - 数据库引擎版本,取值范围如下:MongoDB40(默认):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 - 数据库引擎版本的字符串。
- expired_
time str - 实例到期时间(UTC)。
- id str
- Uniquely identifies the resource.
- instance_
count int - 需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
- instance_
id str - 实例 ID。
- instance_
name str - 实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
- instance_
status str - 实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
- instance_
type str - MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
- mongos
Sequence[Get
Instance Mongo] - Mongos 的信息列表。
- mongos_
id str - Mongos 的 ID。
- mongos_
node_ intnumber - 分片集群中 Mongos 节点的数量。取值范围:2~32。
- mongos_
node_ strspec - 分片集群中 Mongos 节点的规格码。
- node_
availability_ Sequence[Getzones Instance Node Availability Zone] - 添加只读节点信息,包括只读节点所在的可用区和数量。
- node_
number int - 节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
- node_
spec str - 实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
- nodes
Sequence[Get
Instance Node] - 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。
- period int
- 包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
- period_
unit str - 指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
- private_
endpoint str - 实例私网连接地址的字符串信息。
- project_
name str - 选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
- read_
only_ intnode_ number - 实例的只读节点数量。
- reclaim_
time str - 实例的计划回收时间(UTC)。
- int
- 分片集群中 Shard 分片的数量。取值范围:2~32。
-
Sequence[Get
Instance Shard] - Shards 的信息列表。
- storage_
space_ intgb - 副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
- storage_
type str - 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
- subnet_
id str - 子网 ID。
- super_
account_ strname - 数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
- super_
account_ strpassword - root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
-
Sequence[Get
Instance Tag] - MongoDB实例的标签信息
- updated_
time str - 实例的更新时间(UTC)。
- vpc_
id str - 私有网络 ID。
- zone_
id str - 实例所在可用区的 ID。
- allow
List List<String>Ids - 白名单 ID 列表。新建实例会被绑定到指定白名单。
- auto
Renew Boolean - 是否开启自动续费,取值范围如下:false(默认):不开启自动续费。true:开启自动续费。
- charge
Status String - 实例计费状态,取值范围如下:Normal:正常。WaitingPaid:等待支付。ChangingPayType:计费变更中。Renewing:续费中。Overdue:已到期。Owing:欠费中。Unsubscribing:退订中。
- charge
Type String - 实例计费类型,取值范围如下:PostPaid(默认):按量计费(也称后付费)。Prepaid:包年包月(也称预付费)。
- closed
Time String - 计划关停时间(UTC)。
- config
Server StringNode Spec - 分片集群中 ConfigServer 节点的规格码。默认值为 mongo.config.1c2g。
- config
Server NumberStorage Space Gb - 分片集群中 ConfigServer 的存储空间,单位:GiB。步长为 10,默认值:20。
- config
Servers List<Property Map> - ConfigServers 的信息列表。
- config
Servers StringId - ConfigServer 的 ID。
- created
Time String - 实例创建时间(UTC)。
- db
Engine String - 数据库引擎。取值固定为 MongoDB
- db
Engine StringVersion - 数据库引擎版本,取值范围如下:MongoDB40(默认):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 - 数据库引擎版本的字符串。
- expired
Time String - 实例到期时间(UTC)。
- id String
- Uniquely identifies the resource.
- instance
Count Number - 需要创建的实例数量。取值为大于等于 1 的正整数,默认值为1。
- instance
Id String - 实例 ID。
- instance
Name String - 实例名称。名称需同时满足如下要求:不能以数字、中划线(-)开头。只能包含中文、字母、数字、下划线(_)和中划线(-)。长度需为 2~64 个字符。
- instance
Status String - 实例状态。创建中:Creating。运行中:Running。白名单维护中:AllowListMaintaining。变更配置中:Scaling。重启中:Restarting。网络维护中:NetworkMaintaining。恢复中:Restoring。升级版本中:Upgrading。不可用:Unavailable。关停中:Closing。删除中:Deleting。已关停:Closed。SSL SSL变更中:SSLUpdating。主节点切换中:SwitchMastering。角色切换中:RoleChanging。迁移中:Migrating。
- instance
Type String - MongoDB 的实例类型,取值范围如下:ReplicaSet(默认):副本集。ShardedCluster:分片集群 。
- mongos List<Property Map>
- Mongos 的信息列表。
- mongos
Id String - Mongos 的 ID。
- mongos
Node NumberNumber - 分片集群中 Mongos 节点的数量。取值范围:2~32。
- mongos
Node StringSpec - 分片集群中 Mongos 节点的规格码。
- node
Availability List<Property Map>Zones - 添加只读节点信息,包括只读节点所在的可用区和数量。
- node
Number Number - 节点数量,其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点数量。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示每个 Shard 分片中的节点数量。
- node
Spec String - 实例的规格码。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该参数表示副本集实例的计算节点规格。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该参数表示 Shard 节点的规格。
- nodes List<Property Map>
- 副本集实例中各节点或分片集群 Shard 分片中各节点的信息列表。
- period Number
- 包年包月实例的购买时长,其中:当 PeriodUnit 为 Year 时,Period 取值为 1~3。当 PeriodUnit 为 Month 时,Period 取值为 1~9。
- period
Unit String - 指定包年包月实例为包年或者包月类型。取值如下:Year:包年。Month:包月。
- private
Endpoint String - 实例私网连接地址的字符串信息。
- project
Name String - 选择实例所属的项目。若该参数留空,新建实例会默认加入 default 项目。
- read
Only NumberNode Number - 实例的只读节点数量。
- reclaim
Time String - 实例的计划回收时间(UTC)。
- Number
- 分片集群中 Shard 分片的数量。取值范围:2~32。
- List<Property Map>
- Shards 的信息列表。
- storage
Space NumberGb - 副本集实例的总存储空间,或分片集群中单个 Shard 分片的存储空间,单位:GiB,步长为 10。
- storage
Type String - 实例的存储类型。当前仅支持本地 SSD 盘(即 LocalSSD)存储。
- subnet
Id String - 子网 ID。
- super
Account StringName - 数据库账号名称。当前仅支持在创建实例时设置超级管理员账号,账号名称固定为 root。
- super
Account StringPassword - root 账号的密码。密码需同时满足如下条件:只能为大小写字母、数字及以下特殊字符 _#!@$%^&*()+=-。长度为 8~32 个字符。至少包含大写字母、小写字母、数字或特殊字符中的任意三种。不允许使用极易被破解的弱密码(如 Admin@123)。
- List<Property Map>
- MongoDB实例的标签信息
- updated
Time String - 实例的更新时间(UTC)。
- vpc
Id String - 私有网络 ID。
- zone
Id String - 实例所在可用区的 ID。
Supporting Types
GetInstanceConfigServer
- Config
Server stringNode Id - ConfigServer 的节点 ID。
- Node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
- Node
Status string - 节点状态。
- Total
Memory doubleGb - 总内存。单位:GiB。
- Totalv
Cpu double - 总核数。
- Used
Memory doubleGb - 已用内存。单位:GiB。
- Usedv
Cpu double - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- Config
Server stringNode Id - ConfigServer 的节点 ID。
- Node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
- Node
Status string - 节点状态。
- Total
Memory float64Gb - 总内存。单位:GiB。
- Totalv
Cpu float64 - 总核数。
- Used
Memory float64Gb - 已用内存。单位:GiB。
- Usedv
Cpu float64 - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- config
Server StringNode Id - ConfigServer 的节点 ID。
- node
Role String - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
- node
Status String - 节点状态。
- total
Memory DoubleGb - 总内存。单位:GiB。
- totalv
Cpu Double - 总核数。
- used
Memory DoubleGb - 已用内存。单位:GiB。
- usedv
Cpu Double - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
- config
Server stringNode Id - ConfigServer 的节点 ID。
- node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
- node
Status string - 节点状态。
- total
Memory numberGb - 总内存。单位:GiB。
- totalv
Cpu number - 总核数。
- used
Memory numberGb - 已用内存。单位:GiB。
- usedv
Cpu number - 已用核数。
- zone
Id string - 当前节点所属的可用区 ID。
- config_
server_ strnode_ id - ConfigServer 的节点 ID。
- node_
role str - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
- node_
status str - 节点状态。
- total_
memory_ floatgb - 总内存。单位:GiB。
- totalv_
cpu float - 总核数。
- used_
memory_ floatgb - 已用内存。单位:GiB。
- usedv_
cpu float - 已用核数。
- zone_
id str - 当前节点所属的可用区 ID。
- config
Server StringNode Id - ConfigServer 的节点 ID。
- node
Role String - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。
- node
Status String - 节点状态。
- total
Memory NumberGb - 总内存。单位:GiB。
- totalv
Cpu Number - 总核数。
- used
Memory NumberGb - 已用内存。单位:GiB。
- usedv
Cpu Number - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
GetInstanceMongo
- Mongos
Node stringId - Mongos 的节点 ID。
- Node
Spec string - 节点规格。
- Node
Status string - 节点状态。
- Total
Memory doubleGb - 总内存。单位:GiB。
- Totalv
Cpu double - 总核数。
- Used
Memory doubleGb - 已用内存。单位:GiB。
- Usedv
Cpu double - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- Mongos
Node stringId - Mongos 的节点 ID。
- Node
Spec string - 节点规格。
- Node
Status string - 节点状态。
- Total
Memory float64Gb - 总内存。单位:GiB。
- Totalv
Cpu float64 - 总核数。
- Used
Memory float64Gb - 已用内存。单位:GiB。
- Usedv
Cpu float64 - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- mongos
Node StringId - Mongos 的节点 ID。
- node
Spec String - 节点规格。
- node
Status String - 节点状态。
- total
Memory DoubleGb - 总内存。单位:GiB。
- totalv
Cpu Double - 总核数。
- used
Memory DoubleGb - 已用内存。单位:GiB。
- usedv
Cpu Double - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
- mongos
Node stringId - Mongos 的节点 ID。
- node
Spec string - 节点规格。
- node
Status string - 节点状态。
- total
Memory numberGb - 总内存。单位:GiB。
- totalv
Cpu number - 总核数。
- used
Memory numberGb - 已用内存。单位:GiB。
- usedv
Cpu number - 已用核数。
- zone
Id string - 当前节点所属的可用区 ID。
- mongos_
node_ strid - Mongos 的节点 ID。
- node_
spec str - 节点规格。
- node_
status str - 节点状态。
- total_
memory_ floatgb - 总内存。单位:GiB。
- totalv_
cpu float - 总核数。
- used_
memory_ floatgb - 已用内存。单位:GiB。
- usedv_
cpu float - 已用核数。
- zone_
id str - 当前节点所属的可用区 ID。
- mongos
Node StringId - Mongos 的节点 ID。
- node
Spec String - 节点规格。
- node
Status String - 节点状态。
- total
Memory NumberGb - 总内存。单位:GiB。
- totalv
Cpu Number - 总核数。
- used
Memory NumberGb - 已用内存。单位:GiB。
- usedv
Cpu Number - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
GetInstanceNode
- Node
Delay intTime - 节点延迟时间。单位:秒。
- Node
Id string - 节点 ID。
- Node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- Node
Spec string - 节点规格。
- Node
Status string - 节点状态。
- Total
Memory doubleGb - 总内存。单位:GiB。
- Total
Storage doubleGb - 该节点的总存储空间。单位:GiB。
- Totalv
Cpu double - 总核数。
- Used
Memory doubleGb - 已用内存。单位:GiB。
- Used
Storage doubleGb - 该节点已用的存储空间。单位:GiB。
- Usedv
Cpu double - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- Node
Delay intTime - 节点延迟时间。单位:秒。
- Node
Id string - 节点 ID。
- Node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- Node
Spec string - 节点规格。
- Node
Status string - 节点状态。
- Total
Memory float64Gb - 总内存。单位:GiB。
- Total
Storage float64Gb - 该节点的总存储空间。单位:GiB。
- Totalv
Cpu float64 - 总核数。
- Used
Memory float64Gb - 已用内存。单位:GiB。
- Used
Storage float64Gb - 该节点已用的存储空间。单位:GiB。
- Usedv
Cpu float64 - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- node
Delay IntegerTime - 节点延迟时间。单位:秒。
- node
Id String - 节点 ID。
- node
Role String - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node
Spec String - 节点规格。
- node
Status String - 节点状态。
- total
Memory DoubleGb - 总内存。单位:GiB。
- total
Storage DoubleGb - 该节点的总存储空间。单位:GiB。
- totalv
Cpu Double - 总核数。
- used
Memory DoubleGb - 已用内存。单位:GiB。
- used
Storage DoubleGb - 该节点已用的存储空间。单位:GiB。
- usedv
Cpu Double - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
- node
Delay numberTime - 节点延迟时间。单位:秒。
- node
Id string - 节点 ID。
- node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node
Spec string - 节点规格。
- node
Status string - 节点状态。
- total
Memory numberGb - 总内存。单位:GiB。
- total
Storage numberGb - 该节点的总存储空间。单位:GiB。
- totalv
Cpu number - 总核数。
- used
Memory numberGb - 已用内存。单位:GiB。
- used
Storage numberGb - 该节点已用的存储空间。单位:GiB。
- usedv
Cpu number - 已用核数。
- zone
Id string - 当前节点所属的可用区 ID。
- node_
delay_ inttime - 节点延迟时间。单位:秒。
- node_
id str - 节点 ID。
- node_
role str - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node_
spec str - 节点规格。
- node_
status str - 节点状态。
- total_
memory_ floatgb - 总内存。单位:GiB。
- total_
storage_ floatgb - 该节点的总存储空间。单位:GiB。
- totalv_
cpu float - 总核数。
- used_
memory_ floatgb - 已用内存。单位:GiB。
- used_
storage_ floatgb - 该节点已用的存储空间。单位:GiB。
- usedv_
cpu float - 已用核数。
- zone_
id str - 当前节点所属的可用区 ID。
- node
Delay NumberTime - 节点延迟时间。单位:秒。
- node
Id String - 节点 ID。
- node
Role String - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node
Spec String - 节点规格。
- node
Status String - 节点状态。
- total
Memory NumberGb - 总内存。单位:GiB。
- total
Storage NumberGb - 该节点的总存储空间。单位:GiB。
- totalv
Cpu Number - 总核数。
- used
Memory NumberGb - 已用内存。单位:GiB。
- used
Storage NumberGb - 该节点已用的存储空间。单位:GiB。
- usedv
Cpu Number - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
GetInstanceNodeAvailabilityZone
- Node
Number int - 当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
- Zone
Id string - 只读节点所在的可用区。
- Node
Number int - 当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
- Zone
Id string - 只读节点所在的可用区。
- node
Number Integer - 当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
- zone
Id String - 只读节点所在的可用区。
- node
Number number - 当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
- zone
Id string - 只读节点所在的可用区。
- node_
number int - 当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
- zone_
id str - 只读节点所在的可用区。
- node
Number Number - 当前可用区中需要添加的只读节点数量。当前仅副本集实例和分片集群实例中 Shard 分片支持添加只读节点。其中:当实例类型为副本集(即 InstanceType 取值为 ReplicaSet)时,该值表示单个副本集实例中的只读节点总数量。每个副本集实例最多支持添加 5 个只读节点。当实例类型为分片集群(即 InstanceType 取值为 ShardedCluster)时,该值表示每个 Shard 分片中的只读节点数量。每个 Shard 分片最多添加 5 个只读节点。
- zone
Id String - 只读节点所在的可用区。
GetInstanceShard
- Nodes
List<Volcengine.
Get Instance Shard Node> - Shard 分片中各节点的信息列表。
- string
- Shard 节点的 ID。
- Nodes
[]Get
Instance Shard Node - Shard 分片中各节点的信息列表。
- string
- Shard 节点的 ID。
- nodes
List<Get
Instance Shard Node> - Shard 分片中各节点的信息列表。
- String
- Shard 节点的 ID。
- nodes
Get
Instance Shard Node[] - Shard 分片中各节点的信息列表。
- string
- Shard 节点的 ID。
- nodes
Sequence[Get
Instance Shard Node] - Shard 分片中各节点的信息列表。
- str
- Shard 节点的 ID。
- nodes List<Property Map>
- Shard 分片中各节点的信息列表。
- String
- Shard 节点的 ID。
GetInstanceShardNode
- Node
Delay intTime - 节点延迟时间。单位:秒。
- Node
Id string - 节点 ID。
- Node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- Node
Spec string - 节点规格。
- Node
Status string - 节点状态。
- Total
Memory doubleGb - 总内存。单位:GiB。
- Total
Storage doubleGb - 该节点的总存储空间。单位:GiB。
- Totalv
Cpu double - 总核数。
- Used
Memory doubleGb - 已用内存。单位:GiB。
- Used
Storage doubleGb - 该节点已用的存储空间。单位:GiB。
- Usedv
Cpu double - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- Node
Delay intTime - 节点延迟时间。单位:秒。
- Node
Id string - 节点 ID。
- Node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- Node
Spec string - 节点规格。
- Node
Status string - 节点状态。
- Total
Memory float64Gb - 总内存。单位:GiB。
- Total
Storage float64Gb - 该节点的总存储空间。单位:GiB。
- Totalv
Cpu float64 - 总核数。
- Used
Memory float64Gb - 已用内存。单位:GiB。
- Used
Storage float64Gb - 该节点已用的存储空间。单位:GiB。
- Usedv
Cpu float64 - 已用核数。
- Zone
Id string - 当前节点所属的可用区 ID。
- node
Delay IntegerTime - 节点延迟时间。单位:秒。
- node
Id String - 节点 ID。
- node
Role String - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node
Spec String - 节点规格。
- node
Status String - 节点状态。
- total
Memory DoubleGb - 总内存。单位:GiB。
- total
Storage DoubleGb - 该节点的总存储空间。单位:GiB。
- totalv
Cpu Double - 总核数。
- used
Memory DoubleGb - 已用内存。单位:GiB。
- used
Storage DoubleGb - 该节点已用的存储空间。单位:GiB。
- usedv
Cpu Double - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
- node
Delay numberTime - 节点延迟时间。单位:秒。
- node
Id string - 节点 ID。
- node
Role string - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node
Spec string - 节点规格。
- node
Status string - 节点状态。
- total
Memory numberGb - 总内存。单位:GiB。
- total
Storage numberGb - 该节点的总存储空间。单位:GiB。
- totalv
Cpu number - 总核数。
- used
Memory numberGb - 已用内存。单位:GiB。
- used
Storage numberGb - 该节点已用的存储空间。单位:GiB。
- usedv
Cpu number - 已用核数。
- zone
Id string - 当前节点所属的可用区 ID。
- node_
delay_ inttime - 节点延迟时间。单位:秒。
- node_
id str - 节点 ID。
- node_
role str - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node_
spec str - 节点规格。
- node_
status str - 节点状态。
- total_
memory_ floatgb - 总内存。单位:GiB。
- total_
storage_ floatgb - 该节点的总存储空间。单位:GiB。
- totalv_
cpu float - 总核数。
- used_
memory_ floatgb - 已用内存。单位:GiB。
- used_
storage_ floatgb - 该节点已用的存储空间。单位:GiB。
- usedv_
cpu float - 已用核数。
- zone_
id str - 当前节点所属的可用区 ID。
- node
Delay NumberTime - 节点延迟时间。单位:秒。
- node
Id String - 节点 ID。
- node
Role String - 节点角色,取值范围如下:Primary:主节点。Secondary:从节点。Hidden:隐藏节点。ReadOnly:只读节点。
- node
Spec String - 节点规格。
- node
Status String - 节点状态。
- total
Memory NumberGb - 总内存。单位:GiB。
- total
Storage NumberGb - 该节点的总存储空间。单位:GiB。
- totalv
Cpu Number - 总核数。
- used
Memory NumberGb - 已用内存。单位:GiB。
- used
Storage NumberGb - 该节点已用的存储空间。单位:GiB。
- usedv
Cpu Number - 已用核数。
- zone
Id String - 当前节点所属的可用区 ID。
GetInstanceTag
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
