volcenginecc.rocketmq.getInstance

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 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: Account ID to which the instance belongs.
AllowListIds List<string>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
ApplyPrivateDnsToPublic bool: Whether private network domain name supports public resolution. true: enabled false: disabled
AutoScaleQueue bool: Whether to automatically create queues when the instance specification changes.
AvailableQueueNumber int: Remaining number of partitions that can be created.
ChargeDetail Volcengine.GetInstanceChargeDetail: Billing method and related billing information for the instance.
ComputeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
ConnectionInfos List<Volcengine.GetInstanceConnectionInfo>: Instance connection information.
CreateTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
EipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
EnableSsl bool: Whether to use SSL encryption.
FileReservedTime int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
Id string: Uniquely identifies the resource.
InstanceDescription string: Brief description of the instance. Length range: 1–128 characters.
InstanceId string: Instance ID.
InstanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
InstanceStatus string: Instance status.
IpVersionType string: IP version. Options are IPv4 or DualStack.
NetworkTypes string: Instance network type, fixed as PrivateNetwork.
ProductInfo Volcengine.GetInstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
ProjectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
RegionId string: Region ID where the instance is located.
SslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
StorageSpace int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
SubnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
Tags List<Volcengine.GetInstanceTag>: Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.
UsedGroupNumber int: Number of consumer groups (Group) currently created for the instance.
UsedQueueNumber int: Number of queues already used by the instance.
UsedStorageSpace int: Used storage space for the instance, in GiB.
UsedTopicNumber int: Number of topics created in the current instance.
Version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
VpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
ZoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

AccountId string: Account ID to which the instance belongs.
AllowListIds []string: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
ApplyPrivateDnsToPublic bool: Whether private network domain name supports public resolution. true: enabled false: disabled
AutoScaleQueue bool: Whether to automatically create queues when the instance specification changes.
AvailableQueueNumber int: Remaining number of partitions that can be created.
ChargeDetail GetInstanceChargeDetail: Billing method and related billing information for the instance.
ComputeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
ConnectionInfos []GetInstanceConnectionInfo: Instance connection information.
CreateTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
EipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
EnableSsl bool: Whether to use SSL encryption.
FileReservedTime int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
Id string: Uniquely identifies the resource.
InstanceDescription string: Brief description of the instance. Length range: 1–128 characters.
InstanceId string: Instance ID.
InstanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
InstanceStatus string: Instance status.
IpVersionType string: IP version. Options are IPv4 or DualStack.
NetworkTypes string: Instance network type, fixed as PrivateNetwork.
ProductInfo GetInstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
ProjectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
RegionId string: Region ID where the instance is located.
SslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
StorageSpace int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
SubnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
Tags []GetInstanceTag: Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.
UsedGroupNumber int: Number of consumer groups (Group) currently created for the instance.
UsedQueueNumber int: Number of queues already used by the instance.
UsedStorageSpace int: Used storage space for the instance, in GiB.
UsedTopicNumber int: Number of topics created in the current instance.
Version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
VpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
ZoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

accountId String: Account ID to which the instance belongs.
allowListIds List<String>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
applyPrivateDnsToPublic Boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
autoScaleQueue Boolean: Whether to automatically create queues when the instance specification changes.
availableQueueNumber Integer: Remaining number of partitions that can be created.
chargeDetail GetInstanceChargeDetail: Billing method and related billing information for the instance.
computeSpec String: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connectionInfos List<GetInstanceConnectionInfo>: Instance connection information.
createTime String: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eipId String: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl Boolean: Whether to use SSL encryption.
fileReservedTime Integer: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
id String: Uniquely identifies the resource.
instanceDescription String: Brief description of the instance. Length range: 1–128 characters.
instanceId String: Instance ID.
instanceName String: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instanceStatus String: Instance status.
ipVersionType String: IP version. Options are IPv4 or DualStack.
networkTypes String: Instance network type, fixed as PrivateNetwork.
productInfo GetInstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName String: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
regionId String: Region ID where the instance is located.
sslMode String: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storageSpace Integer: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId String: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags List<GetInstanceTag>: Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.
usedGroupNumber Integer: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber Integer: Number of queues already used by the instance.
usedStorageSpace Integer: Used storage space for the instance, in GiB.
usedTopicNumber Integer: Number of topics created in the current instance.
version String: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId String: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId String: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

accountId string: Account ID to which the instance belongs.
allowListIds string[]: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
applyPrivateDnsToPublic boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
autoScaleQueue boolean: Whether to automatically create queues when the instance specification changes.
availableQueueNumber number: Remaining number of partitions that can be created.
chargeDetail GetInstanceChargeDetail: Billing method and related billing information for the instance.
computeSpec string: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connectionInfos GetInstanceConnectionInfo[]: Instance connection information.
createTime string: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eipId string: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl boolean: Whether to use SSL encryption.
fileReservedTime number: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
id string: Uniquely identifies the resource.
instanceDescription string: Brief description of the instance. Length range: 1–128 characters.
instanceId string: Instance ID.
instanceName string: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instanceStatus string: Instance status.
ipVersionType string: IP version. Options are IPv4 or DualStack.
networkTypes string: Instance network type, fixed as PrivateNetwork.
productInfo GetInstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName string: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
regionId string: Region ID where the instance is located.
sslMode string: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storageSpace number: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId string: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags GetInstanceTag[]: Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.
usedGroupNumber number: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber number: Number of queues already used by the instance.
usedStorageSpace number: Used storage space for the instance, in GiB.
usedTopicNumber number: Number of topics created in the current instance.
version string: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId string: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId string: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

account_id str: Account ID to which the instance belongs.
allow_list_ids Sequence[str]: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
apply_private_dns_to_public bool: Whether private network domain name supports public resolution. true: enabled false: disabled
auto_scale_queue bool: Whether to automatically create queues when the instance specification changes.
available_queue_number int: Remaining number of partitions that can be created.
charge_detail GetInstanceChargeDetail: Billing method and related billing information for the instance.
compute_spec str: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connection_infos Sequence[GetInstanceConnectionInfo]: Instance connection information.
create_time str: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eip_id str: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enable_ssl bool: Whether to use SSL encryption.
file_reserved_time int: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
id str: Uniquely identifies the resource.
instance_description str: Brief description of the instance. Length range: 1–128 characters.
instance_id str: Instance ID.
instance_name str: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instance_status str: Instance status.
ip_version_type str: IP version. Options are IPv4 or DualStack.
network_types str: Instance network type, fixed as PrivateNetwork.
product_info GetInstanceProductInfo: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
project_name str: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
region_id str: Region ID where the instance is located.
ssl_mode str: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storage_space int: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnet_id str: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags Sequence[GetInstanceTag]: Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.
used_group_number int: Number of consumer groups (Group) currently created for the instance.
used_queue_number int: Number of queues already used by the instance.
used_storage_space int: Used storage space for the instance, in GiB.
used_topic_number int: Number of topics created in the current instance.
version str: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpc_id str: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zone_id str: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

accountId String: Account ID to which the instance belongs.
allowListIds List<String>: List of allowlist IDs bound to the instance. After binding an allowlist, only IP addresses and address ranges configured in the allowlist can access this instance. If no allowlist is bound to the instance, all IP addresses are denied access to the instance.
applyPrivateDnsToPublic Boolean: Whether private network domain name supports public resolution. true: enabled false: disabled
autoScaleQueue Boolean: Whether to automatically create queues when the instance specification changes.
availableQueueNumber Number: Remaining number of partitions that can be created.
chargeDetail Property Map: Billing method and related billing information for the instance.
computeSpec String: Instance compute specification. You can view the currently available compute specifications in the product specifications list.
connectionInfos List<Property Map>: Instance connection information.
createTime String: Instance creation time. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
eipId String: EIP ID. Specifying EipId enables public access for the instance. EIP provides independent public IP resources, including public IP addresses and outbound bandwidth services. After enabling public access by specifying this parameter, the public address will be bound to your Elastic IP (EIP), and fees will be charged for the EIP resource.
enableSsl Boolean: Whether to use SSL encryption.
fileReservedTime Number: Message retention period on the RocketMQ Message Queue server. Messages exceeding the retention period will be expired and cleaned up. Unit: hours. Value range: 1–72 hours.
id String: Uniquely identifies the resource.
instanceDescription String: Brief description of the instance. Length range: 1–128 characters.
instanceId String: Instance ID.
instanceName String: Instance name. Must meet the following requirements: can only contain Chinese characters, letters, numbers, underscores (_), and hyphens (-); cannot start with a number or hyphen (-); length must be 1–128 characters. If no name is specified when creating the instance, the instance ID will be used as the default name.
instanceStatus String: Instance status.
ipVersionType String: IP version. Options are IPv4 or DualStack.
networkTypes String: Instance network type, fixed as PrivateNetwork.
productInfo Property Map: Product configuration information. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.
projectName String: The IAM project to which the newly created instance belongs. If not set, the new instance will be bound to the IAM project named 'default'.
regionId String: Region ID where the instance is located.
sslMode String: The instance's public network connection policy only needs to be set when public access is enabled. Supported settings are: enforcing: When accessing the instance via the public network, SSL authentication is required. SSL authentication enables encrypted data transmission, offering higher security compared to standard public access, but may reduce performance. permissive: When accessing the instance via the public network, SSL authentication is optional. After the instance is created and public access is enabled, the SSL connection policy cannot be modified. To change it, you must disable and re-enable public access for the instance, and set the SSL connection policy again when re-enabling. For details, see Setting Public Access and SSL Authentication Policy.
storageSpace Number: Instance storage space, measured in GiB and must be specified in multiples of 100. The value range depends on the currently selected compute specification.
subnetId String: VPC subnet ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
tags List<Property Map>: Cloud resource tags. You can categorize instances by tags for easier search and resource aggregation. For details, see Tag Overview.
usedGroupNumber Number: Number of consumer groups (Group) currently created for the instance.
usedQueueNumber Number: Number of queues already used by the instance.
usedStorageSpace Number: Used storage space for the instance, in GiB.
usedTopicNumber Number: Number of topics created in the current instance.
version String: Supported RocketMQ versions. Currently supported versions include: 4.8: compatible with RocketMQ 4.x series. 5.x: compatible with RocketMQ 5.x series. The 5.x version is currently available by whitelist application. To use it, contact technical support to apply for access.
vpcId String: VPC ID where the instance resides. After the instance is created, the associated VPC and subnet cannot be modified. Please operate carefully when creating the instance. You can call the DescribeVpcs API of the VPC to query the available VPC and subnet list.
zoneId String: Availability zone ID where the instance is located. RocketMQ Message Queue instances support cross-AZ deployment. When viewing available compute specifications in a specified availability zone, you can specify multiple zones. Separate multiple availability zone IDs with commas (,). You can call DescribeAvailabilityZones to query the list of currently available zones.

Supporting Types

GetInstanceChargeDetail

AutoRenew bool: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
ChargeExpireTime string: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
ChargeStartTime string: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
ChargeStatus string: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
ChargeType string: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
OverdueReclaimTime string: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
OverdueTime string: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
Period int: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
PeriodUnit string: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

AutoRenew bool: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
ChargeExpireTime string: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
ChargeStartTime string: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
ChargeStatus string: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
ChargeType string: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
OverdueReclaimTime string: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
OverdueTime string: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
Period int: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
PeriodUnit string: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

autoRenew Boolean: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
chargeExpireTime String: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
chargeStartTime String: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
chargeStatus String: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
chargeType String: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdueReclaimTime String: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdueTime String: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period Integer: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
periodUnit String: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

autoRenew boolean: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
chargeExpireTime string: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
chargeStartTime string: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
chargeStatus string: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
chargeType string: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdueReclaimTime string: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdueTime string: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period number: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
periodUnit string: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

auto_renew bool: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
charge_expire_time str: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
charge_start_time str: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
charge_status str: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
charge_type str: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdue_reclaim_time str: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdue_time str: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period int: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
period_unit str: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

autoRenew Boolean: Whether the subscription instance is automatically renewed upon expiration. true: automatically renewed. false: not automatically renewed. Manual renewal is required after expiration; otherwise, the instance will be shut down.
chargeExpireTime String: Expiration time for yearly/monthly subscription instances. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'. For pay-as-you-go instances, this field defaults to 1970-01-01T00:00:00Z.
chargeStartTime String: Billing start time for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
chargeStatus String: Instance billing status. Includes: Normal: normal Overdue: pay-as-you-go overdue Expired: subscription expired
chargeType String: Billing type for the instance. Supported types include: PostPaid: pay-as-you-go; PrePaid: yearly/monthly subscription
overdueReclaimTime String: Estimated release time after the instance is suspended due to overdue payment. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
overdueTime String: Suspension time due to overdue payment for the instance. The time format is YYYY-MM-DD'T'HH:MM:SS'Z'.
period Number: Purchase duration for subscription instances. When PeriodUnit is set to Monthly, the value range is 1–9. When PeriodUnit is set to Yearly, the value range is 1–3. Only required for subscription instances, that is, when ChargeType is set to PrePaid.
periodUnit String: Lifecycle unit for subscription-based instances, specifying whether to purchase by month or by year. Monthly: (default) monthly subscription Yearly: annual subscription

GetInstanceConnectionInfo

EndpointAddressIp string: Instance endpoint IP address.
EndpointType string: Instance access point type.
InternalEndpoint string: Private network endpoint address for the instance.
NetworkType string: Instance access point type.
PublicEndpoint string: Public access point address of the instance.

EndpointAddressIp string: Instance endpoint IP address.
EndpointType string: Instance access point type.
InternalEndpoint string: Private network endpoint address for the instance.
NetworkType string: Instance access point type.
PublicEndpoint string: Public access point address of the instance.

endpointAddressIp String: Instance endpoint IP address.
endpointType String: Instance access point type.
internalEndpoint String: Private network endpoint address for the instance.
networkType String: Instance access point type.
publicEndpoint String: Public access point address of the instance.

endpointAddressIp string: Instance endpoint IP address.
endpointType string: Instance access point type.
internalEndpoint string: Private network endpoint address for the instance.
networkType string: Instance access point type.
publicEndpoint string: Public access point address of the instance.

endpoint_address_ip str: Instance endpoint IP address.
endpoint_type str: Instance access point type.
internal_endpoint str: Private network endpoint address for the instance.
network_type str: Instance access point type.
public_endpoint str: Public access point address of the instance.

endpointAddressIp String: Instance endpoint IP address.
endpointType String: Instance access point type.
internalEndpoint String: Private network endpoint address for the instance.
networkType String: Instance access point type.
publicEndpoint String: Public access point address of the instance.

GetInstanceProductInfo

SendReceiveRatio int: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

SendReceiveRatio int: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

sendReceiveRatio Integer: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

sendReceiveRatio number: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

send_receive_ratio int: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

sendReceiveRatio Number: Edit the read/write throttling ratio. The default read/write ratio is 50% each. For example, if set to 40, the sending TPS ratio is 40% and the subscription ratio is 60%. Note: Only RocketMQ 5.x instances support adjusting the TPS ratio for the instance.

GetInstanceTag

Key string: Tag key.
Value string: Tag value.

Key string: Tag key.
Value string: Tag value.

key String: Tag key.
value String: Tag value.

key string: Tag key.
value string: Tag value.

key str: Tag key.
value str: Tag value.

key String: Tag key.
value String: Tag value.

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.32
published on Thursday, Apr 23, 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