volcenginecc.rocketmq.getInstance

volcenginecc v0.0.24, Mar 9 26

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

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:rocketmq/getInstance:getInstance
  arguments:
    # arguments dictionary

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 str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getInstance Result

The following output properties are available:

AccountId string: 实例所属的账号 ID。
AllowListIds List<string>: 实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。
ApplyPrivateDnsToPublic bool: 是否已开启私网域名支持公网解析功能。true：已开启false：已关闭
AutoScaleQueue bool: 实例规格更改时，是否自动创建队列。
AvailableQueueNumber int: 剩余可创建的分区数量。
ChargeDetail Volcengine.GetInstanceChargeDetail: 实例的计费方式等计费信息。
ComputeSpec string: 实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
ConnectionInfos List<Volcengine.GetInstanceConnectionInfo>: 实例的连接信息。
CreateTime string: 实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
EipId string: EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网IP（EIP），费用由EIP收取。
EnableSsl bool: 是否使用 SSL 加密。
FileReservedTime int: 消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。
Id string: Uniquely identifies the resource.
InstanceDescription string: 实例的简单描述。长度范围为 1~128 个字符。
InstanceId string: 实例 ID。
InstanceName string: 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
InstanceStatus string: 实例状态。
IpVersionType string: IP 版本，可选直为 IPv4 或者 DualStack。
NetworkTypes string: 实例网络类型，固定为 PrivateNetwork。
ProductInfo Volcengine.GetInstanceProductInfo: 产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
ProjectName string: 当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。
RegionId string: 实例所在的地域 ID。
SslMode string: 实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
StorageSpace int: 实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
SubnetId string: 实例所在的 VPC 子网 ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
Tags List<Volcengine.GetInstanceTag>: 云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签概述。
UsedGroupNumber int: 当前实例已经创建的消费组（Group）个数。
UsedQueueNumber int: 实例已经使用的队列数。
UsedStorageSpace int: 实例已用储空间。单位为 GiB。
UsedTopicNumber int: 当前实例已创建的 Topic 个数。
Version string: 支持的 RocketMQ 版本。当前支持的版本包括：4.8：兼容 RocketMQ 4.x 版本系列。5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
VpcId string: 实例所在的私有网络（VPC） ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
ZoneId string: 实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

AccountId string: 实例所属的账号 ID。
AllowListIds []string: 实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。
ApplyPrivateDnsToPublic bool: 是否已开启私网域名支持公网解析功能。true：已开启false：已关闭
AutoScaleQueue bool: 实例规格更改时，是否自动创建队列。
AvailableQueueNumber int: 剩余可创建的分区数量。
ChargeDetail GetInstanceChargeDetail: 实例的计费方式等计费信息。
ComputeSpec string: 实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
ConnectionInfos []GetInstanceConnectionInfo: 实例的连接信息。
CreateTime string: 实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
EipId string: EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网IP（EIP），费用由EIP收取。
EnableSsl bool: 是否使用 SSL 加密。
FileReservedTime int: 消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。
Id string: Uniquely identifies the resource.
InstanceDescription string: 实例的简单描述。长度范围为 1~128 个字符。
InstanceId string: 实例 ID。
InstanceName string: 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
InstanceStatus string: 实例状态。
IpVersionType string: IP 版本，可选直为 IPv4 或者 DualStack。
NetworkTypes string: 实例网络类型，固定为 PrivateNetwork。
ProductInfo GetInstanceProductInfo: 产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
ProjectName string: 当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。
RegionId string: 实例所在的地域 ID。
SslMode string: 实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
StorageSpace int: 实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
SubnetId string: 实例所在的 VPC 子网 ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
Tags []GetInstanceTag: 云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签概述。
UsedGroupNumber int: 当前实例已经创建的消费组（Group）个数。
UsedQueueNumber int: 实例已经使用的队列数。
UsedStorageSpace int: 实例已用储空间。单位为 GiB。
UsedTopicNumber int: 当前实例已创建的 Topic 个数。
Version string: 支持的 RocketMQ 版本。当前支持的版本包括：4.8：兼容 RocketMQ 4.x 版本系列。5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
VpcId string: 实例所在的私有网络（VPC） ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
ZoneId string: 实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

accountId String: 实例所属的账号 ID。
allowListIds List<String>: 实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。
applyPrivateDnsToPublic Boolean: 是否已开启私网域名支持公网解析功能。true：已开启false：已关闭
autoScaleQueue Boolean: 实例规格更改时，是否自动创建队列。
availableQueueNumber Integer: 剩余可创建的分区数量。
chargeDetail GetInstanceChargeDetail: 实例的计费方式等计费信息。
computeSpec String: 实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
connectionInfos List<GetInstanceConnectionInfo>: 实例的连接信息。
createTime String: 实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
eipId String: EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网IP（EIP），费用由EIP收取。
enableSsl Boolean: 是否使用 SSL 加密。
fileReservedTime Integer: 消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。
id String: Uniquely identifies the resource.
instanceDescription String: 实例的简单描述。长度范围为 1~128 个字符。
instanceId String: 实例 ID。
instanceName String: 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
instanceStatus String: 实例状态。
ipVersionType String: IP 版本，可选直为 IPv4 或者 DualStack。
networkTypes String: 实例网络类型，固定为 PrivateNetwork。
productInfo GetInstanceProductInfo: 产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
projectName String: 当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。
regionId String: 实例所在的地域 ID。
sslMode String: 实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
storageSpace Integer: 实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
subnetId String: 实例所在的 VPC 子网 ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
tags List<GetInstanceTag>: 云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签概述。
usedGroupNumber Integer: 当前实例已经创建的消费组（Group）个数。
usedQueueNumber Integer: 实例已经使用的队列数。
usedStorageSpace Integer: 实例已用储空间。单位为 GiB。
usedTopicNumber Integer: 当前实例已创建的 Topic 个数。
version String: 支持的 RocketMQ 版本。当前支持的版本包括：4.8：兼容 RocketMQ 4.x 版本系列。5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
vpcId String: 实例所在的私有网络（VPC） ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
zoneId String: 实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

accountId string: 实例所属的账号 ID。
allowListIds string[]: 实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。
applyPrivateDnsToPublic boolean: 是否已开启私网域名支持公网解析功能。true：已开启false：已关闭
autoScaleQueue boolean: 实例规格更改时，是否自动创建队列。
availableQueueNumber number: 剩余可创建的分区数量。
chargeDetail GetInstanceChargeDetail: 实例的计费方式等计费信息。
computeSpec string: 实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
connectionInfos GetInstanceConnectionInfo[]: 实例的连接信息。
createTime string: 实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
eipId string: EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网IP（EIP），费用由EIP收取。
enableSsl boolean: 是否使用 SSL 加密。
fileReservedTime number: 消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。
id string: Uniquely identifies the resource.
instanceDescription string: 实例的简单描述。长度范围为 1~128 个字符。
instanceId string: 实例 ID。
instanceName string: 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
instanceStatus string: 实例状态。
ipVersionType string: IP 版本，可选直为 IPv4 或者 DualStack。
networkTypes string: 实例网络类型，固定为 PrivateNetwork。
productInfo GetInstanceProductInfo: 产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
projectName string: 当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。
regionId string: 实例所在的地域 ID。
sslMode string: 实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
storageSpace number: 实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
subnetId string: 实例所在的 VPC 子网 ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
tags GetInstanceTag[]: 云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签概述。
usedGroupNumber number: 当前实例已经创建的消费组（Group）个数。
usedQueueNumber number: 实例已经使用的队列数。
usedStorageSpace number: 实例已用储空间。单位为 GiB。
usedTopicNumber number: 当前实例已创建的 Topic 个数。
version string: 支持的 RocketMQ 版本。当前支持的版本包括：4.8：兼容 RocketMQ 4.x 版本系列。5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
vpcId string: 实例所在的私有网络（VPC） ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
zoneId string: 实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

account_id str: 实例所属的账号 ID。
allow_list_ids Sequence[str]: 实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。
apply_private_dns_to_public bool: 是否已开启私网域名支持公网解析功能。true：已开启false：已关闭
auto_scale_queue bool: 实例规格更改时，是否自动创建队列。
available_queue_number int: 剩余可创建的分区数量。
charge_detail GetInstanceChargeDetail: 实例的计费方式等计费信息。
compute_spec str: 实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
connection_infos Sequence[GetInstanceConnectionInfo]: 实例的连接信息。
create_time str: 实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
eip_id str: EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网IP（EIP），费用由EIP收取。
enable_ssl bool: 是否使用 SSL 加密。
file_reserved_time int: 消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。
id str: Uniquely identifies the resource.
instance_description str: 实例的简单描述。长度范围为 1~128 个字符。
instance_id str: 实例 ID。
instance_name str: 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
instance_status str: 实例状态。
ip_version_type str: IP 版本，可选直为 IPv4 或者 DualStack。
network_types str: 实例网络类型，固定为 PrivateNetwork。
product_info GetInstanceProductInfo: 产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
project_name str: 当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。
region_id str: 实例所在的地域 ID。
ssl_mode str: 实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
storage_space int: 实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
subnet_id str: 实例所在的 VPC 子网 ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
tags Sequence[GetInstanceTag]: 云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签概述。
used_group_number int: 当前实例已经创建的消费组（Group）个数。
used_queue_number int: 实例已经使用的队列数。
used_storage_space int: 实例已用储空间。单位为 GiB。
used_topic_number int: 当前实例已创建的 Topic 个数。
version str: 支持的 RocketMQ 版本。当前支持的版本包括：4.8：兼容 RocketMQ 4.x 版本系列。5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
vpc_id str: 实例所在的私有网络（VPC） ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
zone_id str: 实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

accountId String: 实例所属的账号 ID。
allowListIds List<String>: 实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单，表示禁止所有 IP 地址访问该实例。
applyPrivateDnsToPublic Boolean: 是否已开启私网域名支持公网解析功能。true：已开启false：已关闭
autoScaleQueue Boolean: 实例规格更改时，是否自动创建队列。
availableQueueNumber Number: 剩余可创建的分区数量。
chargeDetail Property Map: 实例的计费方式等计费信息。
computeSpec String: 实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
connectionInfos List<Property Map>: 实例的连接信息。
createTime String: 实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
eipId String: EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源，包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后，公网地址将绑定您的弹性公网IP（EIP），费用由EIP收取。
enableSsl Boolean: 是否使用 SSL 加密。
fileReservedTime Number: 消息在消息队列 RocketMQ版服务端的保留时长，超过保留时长的消息将被过期清理。单位为小时，取值范围为 1~72 小时。
id String: Uniquely identifies the resource.
instanceDescription String: 实例的简单描述。长度范围为 1~128 个字符。
instanceId String: 实例 ID。
instanceName String: 实例的名称。需满足以下要求：只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。如果创建实例时未指定名称，则默认将实例 ID 作为实例名称。
instanceStatus String: 实例状态。
ipVersionType String: IP 版本，可选直为 IPv4 或者 DualStack。
networkTypes String: 实例网络类型，固定为 PrivateNetwork。
productInfo Property Map: 产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
projectName String: 当前创建的实例所属的 IAM 项目。若未设置，则会将新实例绑定到名为 default 的 IAM 项目中。
regionId String: 实例所在的地域 ID。
sslMode String: 实例的公网连接策略，仅在开启公网访问时需要设置。支持设置为：enforcing：通过公网访问实例时，必须经由 SSL 认证。SSL 认证可实现数据的加密传输，相较于普通公网访问方式具备更高的安全性，但性能会有所下降。permissive：通过公网访问实例时，可以选择是否经由 SSL 认证。创建实例后，公网访问为开启状态时，不能修改 SSL 连接策略。如需修改，需要为实例关闭并重新开启公网访问，在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
storageSpace Number: 实例的存储空间。单位为 GiB，必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
subnetId String: 实例所在的 VPC 子网 ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
tags List<Property Map>: 云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。详细说明请参考标签概述。
usedGroupNumber Number: 当前实例已经创建的消费组（Group）个数。
usedQueueNumber Number: 实例已经使用的队列数。
usedStorageSpace Number: 实例已用储空间。单位为 GiB。
usedTopicNumber Number: 当前实例已创建的 Topic 个数。
version String: 支持的 RocketMQ 版本。当前支持的版本包括：4.8：兼容 RocketMQ 4.x 版本系列。5.x：兼容 RocketMQ 5.x 版本系列。目前 5.x 版本处于加白阶段，如需使用请联系技术支持申请开白。
vpcId String: 实例所在的私有网络（VPC） ID。实例创建完成后，不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络（VPC）的 DescribeVpcs 接口查询可用的VPC和子网列表。
zoneId String: 实例所在的可用区 ID。消息队列 RocketMQ版实例支持跨 AZ 部署，查看指定可用区下提供哪些计算规格时，可以指定多个可用区。多个可用区 ID 之间以逗号（,）间隔。您可以调用 DescribeAvailabilityZones 查询当前提供服务的可用区列表。

Supporting Types

GetInstanceChargeDetail

AutoRenew bool: 包年包月实例到期后是否自动续费。true：自动续费。false：不自动续费。到期后需要手动续费，否则实例将被关停。
ChargeExpireTime string: 包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。
ChargeStartTime string: 实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
ChargeStatus string: 实例的计费状态。包括：Normal：正常Overdue：按量计费欠费Expired：包年包月到期
ChargeType string: 实例的计费类型。支持的类型包括：PostPaid ：按量付费PrePaid：包年包月
OverdueReclaimTime string: 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
OverdueTime string: 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
Period int: 包年包月类型实例的购买时长。PeriodUnit 指定为 Monthly 时，取值范围为 1~9。PeriodUnit 指定为 Yearly 时，取值范围为 1~3。仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
PeriodUnit string: 包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：Monthly：（默认）包月Yearly：包年

AutoRenew bool: 包年包月实例到期后是否自动续费。true：自动续费。false：不自动续费。到期后需要手动续费，否则实例将被关停。
ChargeExpireTime string: 包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。
ChargeStartTime string: 实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
ChargeStatus string: 实例的计费状态。包括：Normal：正常Overdue：按量计费欠费Expired：包年包月到期
ChargeType string: 实例的计费类型。支持的类型包括：PostPaid ：按量付费PrePaid：包年包月
OverdueReclaimTime string: 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
OverdueTime string: 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
Period int: 包年包月类型实例的购买时长。PeriodUnit 指定为 Monthly 时，取值范围为 1~9。PeriodUnit 指定为 Yearly 时，取值范围为 1~3。仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
PeriodUnit string: 包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：Monthly：（默认）包月Yearly：包年

autoRenew Boolean: 包年包月实例到期后是否自动续费。true：自动续费。false：不自动续费。到期后需要手动续费，否则实例将被关停。
chargeExpireTime String: 包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。
chargeStartTime String: 实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
chargeStatus String: 实例的计费状态。包括：Normal：正常Overdue：按量计费欠费Expired：包年包月到期
chargeType String: 实例的计费类型。支持的类型包括：PostPaid ：按量付费PrePaid：包年包月
overdueReclaimTime String: 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
overdueTime String: 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
period Integer: 包年包月类型实例的购买时长。PeriodUnit 指定为 Monthly 时，取值范围为 1~9。PeriodUnit 指定为 Yearly 时，取值范围为 1~3。仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
periodUnit String: 包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：Monthly：（默认）包月Yearly：包年

autoRenew boolean: 包年包月实例到期后是否自动续费。true：自动续费。false：不自动续费。到期后需要手动续费，否则实例将被关停。
chargeExpireTime string: 包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。
chargeStartTime string: 实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
chargeStatus string: 实例的计费状态。包括：Normal：正常Overdue：按量计费欠费Expired：包年包月到期
chargeType string: 实例的计费类型。支持的类型包括：PostPaid ：按量付费PrePaid：包年包月
overdueReclaimTime string: 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
overdueTime string: 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
period number: 包年包月类型实例的购买时长。PeriodUnit 指定为 Monthly 时，取值范围为 1~9。PeriodUnit 指定为 Yearly 时，取值范围为 1~3。仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
periodUnit string: 包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：Monthly：（默认）包月Yearly：包年

auto_renew bool: 包年包月实例到期后是否自动续费。true：自动续费。false：不自动续费。到期后需要手动续费，否则实例将被关停。
charge_expire_time str: 包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。
charge_start_time str: 实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
charge_status str: 实例的计费状态。包括：Normal：正常Overdue：按量计费欠费Expired：包年包月到期
charge_type str: 实例的计费类型。支持的类型包括：PostPaid ：按量付费PrePaid：包年包月
overdue_reclaim_time str: 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
overdue_time str: 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
period int: 包年包月类型实例的购买时长。PeriodUnit 指定为 Monthly 时，取值范围为 1~9。PeriodUnit 指定为 Yearly 时，取值范围为 1~3。仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
period_unit str: 包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：Monthly：（默认）包月Yearly：包年

autoRenew Boolean: 包年包月实例到期后是否自动续费。true：自动续费。false：不自动续费。到期后需要手动续费，否则实例将被关停。
chargeExpireTime String: 包年包月实例的到期时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。按量付费实例此字段默认显示为 1970-01-01T00:00:00Z。
chargeStartTime String: 实例的开始计费时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
chargeStatus String: 实例的计费状态。包括：Normal：正常Overdue：按量计费欠费Expired：包年包月到期
chargeType String: 实例的计费类型。支持的类型包括：PostPaid ：按量付费PrePaid：包年包月
overdueReclaimTime String: 实例欠费关停后的预计释放时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
overdueTime String: 实例的欠费关停时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
period Number: 包年包月类型实例的购买时长。PeriodUnit 指定为 Monthly 时，取值范围为 1~9。PeriodUnit 指定为 Yearly 时，取值范围为 1~3。仅包年包月类型的实例需要指定，即 ChargeType 指定为 PrePaid 时必选。
periodUnit String: 包年包月类型实例的生命周期单位，即指定以月或以年为单位购买。其中：Monthly：（默认）包月Yearly：包年

GetInstanceConnectionInfo

EndpointAddressIp string: 实例的接入点 IP 地址。
EndpointType string: 实例的接入点类型。
InternalEndpoint string: 实例的私网接入点地址。
NetworkType string: 实例的接入点类型。
PublicEndpoint string: 实例的公网接入点地址。

EndpointAddressIp string: 实例的接入点 IP 地址。
EndpointType string: 实例的接入点类型。
InternalEndpoint string: 实例的私网接入点地址。
NetworkType string: 实例的接入点类型。
PublicEndpoint string: 实例的公网接入点地址。

endpointAddressIp String: 实例的接入点 IP 地址。
endpointType String: 实例的接入点类型。
internalEndpoint String: 实例的私网接入点地址。
networkType String: 实例的接入点类型。
publicEndpoint String: 实例的公网接入点地址。

endpointAddressIp string: 实例的接入点 IP 地址。
endpointType string: 实例的接入点类型。
internalEndpoint string: 实例的私网接入点地址。
networkType string: 实例的接入点类型。
publicEndpoint string: 实例的公网接入点地址。

endpoint_address_ip str: 实例的接入点 IP 地址。
endpoint_type str: 实例的接入点类型。
internal_endpoint str: 实例的私网接入点地址。
network_type str: 实例的接入点类型。
public_endpoint str: 实例的公网接入点地址。

endpointAddressIp String: 实例的接入点 IP 地址。
endpointType String: 实例的接入点类型。
internalEndpoint String: 实例的私网接入点地址。
networkType String: 实例的接入点类型。
publicEndpoint String: 实例的公网接入点地址。

GetInstanceProductInfo

SendReceiveRatio int: 修改读写限流比例，默认读写比例各占 50%。假设设置为 40，表示发送的 TPS 比列为 40%，订阅比列为 60%。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。

SendReceiveRatio int: 修改读写限流比例，默认读写比例各占 50%。假设设置为 40，表示发送的 TPS 比列为 40%，订阅比列为 60%。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。

sendReceiveRatio Integer: 修改读写限流比例，默认读写比例各占 50%。假设设置为 40，表示发送的 TPS 比列为 40%，订阅比列为 60%。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。

sendReceiveRatio number: 修改读写限流比例，默认读写比例各占 50%。假设设置为 40，表示发送的 TPS 比列为 40%，订阅比列为 60%。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。

send_receive_ratio int: 修改读写限流比例，默认读写比例各占 50%。假设设置为 40，表示发送的 TPS 比列为 40%，订阅比列为 60%。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。

sendReceiveRatio Number: 修改读写限流比例，默认读写比例各占 50%。假设设置为 40，表示发送的 TPS 比列为 40%，订阅比列为 60%。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。

GetInstanceTag

Key string: 标签键。
Value string: 标签值。

Key string: 标签键。
Value string: 标签值。

key String: 标签键。
value String: 标签值。

key string: 标签键。
value string: 标签值。

key str: 标签键。
value str: 标签值。

key String: 标签键。
value String: 标签值。

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

Viewing docs for volcenginecc v0.0.24
published on Monday, Mar 9, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

volcenginecc.rocketmq.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceChargeDetail

GetInstanceConnectionInfo

GetInstanceProductInfo

GetInstanceTag

Package Details

On this page

On this page