bytepluscc.rabbitmq.getInstance

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Using getInstance

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

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

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

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

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

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

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

fn::invoke:
  function: bytepluscc:rabbitmq/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。
ApplyPrivateDnsToPublic bool: 是否已开启公网解析功能。true：已开启, false：已关闭
ArchType string: 实例的类型，即集群版或单机版。
ChargeDetail Byteplus.GetInstanceChargeDetail: 实例的计费方式等计费信息。
ComputeSpec string: RabbitMQ实例的计算规格。
CreatedTime string: 实例的创建时间。
EipId string: EIP的ID。
Endpoints List<Byteplus.GetInstanceEndpoint>: 实例的连接信息。
Id string: Uniquely identifies the resource.
InstanceDescription string: 实例的简单描述。
InstanceId string: RabbitMQ 实例 ID。
InstanceName string: RabbitMQ 实例名称。
InstanceStatus string: 实例状态。
IsEncrypted bool: 是否开启了云盘加密。
ProjectName string: 实例所属的IAM项目。
StorageSpace int: 实例总存储空间。单位为 GiB。
SubnetId string: VPC的子网ID。
Tags List<Byteplus.GetInstanceTag>: 实例绑定的标签。
UsedStorageSpace int: 实例已用存储空间。单位为 GiB。
UserName string: RabbitMQ WebUI管理员账号名。
UserPassword string: RabbitMQ WebUI管理员密码。
Version string: 支持的 RabbitMQ 版本。当前支持的版本包括：3.8.18：RabbitMQ 3.8.18 版本。
VpcId string: 私有网络（VPC）ID。
ZoneDescription string: 可用区的描述信息。
ZoneId string: 实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

AccountId string: 创建实例的主账号ID。
ApplyPrivateDnsToPublic bool: 是否已开启公网解析功能。true：已开启, false：已关闭
ArchType string: 实例的类型，即集群版或单机版。
ChargeDetail GetInstanceChargeDetail: 实例的计费方式等计费信息。
ComputeSpec string: RabbitMQ实例的计算规格。
CreatedTime string: 实例的创建时间。
EipId string: EIP的ID。
Endpoints []GetInstanceEndpoint: 实例的连接信息。
Id string: Uniquely identifies the resource.
InstanceDescription string: 实例的简单描述。
InstanceId string: RabbitMQ 实例 ID。
InstanceName string: RabbitMQ 实例名称。
InstanceStatus string: 实例状态。
IsEncrypted bool: 是否开启了云盘加密。
ProjectName string: 实例所属的IAM项目。
StorageSpace int: 实例总存储空间。单位为 GiB。
SubnetId string: VPC的子网ID。
Tags []GetInstanceTag: 实例绑定的标签。
UsedStorageSpace int: 实例已用存储空间。单位为 GiB。
UserName string: RabbitMQ WebUI管理员账号名。
UserPassword string: RabbitMQ WebUI管理员密码。
Version string: 支持的 RabbitMQ 版本。当前支持的版本包括：3.8.18：RabbitMQ 3.8.18 版本。
VpcId string: 私有网络（VPC）ID。
ZoneDescription string: 可用区的描述信息。
ZoneId string: 实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

accountId String: 创建实例的主账号ID。
applyPrivateDnsToPublic Boolean: 是否已开启公网解析功能。true：已开启, false：已关闭
archType String: 实例的类型，即集群版或单机版。
chargeDetail GetInstanceChargeDetail: 实例的计费方式等计费信息。
computeSpec String: RabbitMQ实例的计算规格。
createdTime String: 实例的创建时间。
eipId String: EIP的ID。
endpoints List<GetInstanceEndpoint>: 实例的连接信息。
id String: Uniquely identifies the resource.
instanceDescription String: 实例的简单描述。
instanceId String: RabbitMQ 实例 ID。
instanceName String: RabbitMQ 实例名称。
instanceStatus String: 实例状态。
isEncrypted Boolean: 是否开启了云盘加密。
projectName String: 实例所属的IAM项目。
storageSpace Integer: 实例总存储空间。单位为 GiB。
subnetId String: VPC的子网ID。
tags List<GetInstanceTag>: 实例绑定的标签。
usedStorageSpace Integer: 实例已用存储空间。单位为 GiB。
userName String: RabbitMQ WebUI管理员账号名。
userPassword String: RabbitMQ WebUI管理员密码。
version String: 支持的 RabbitMQ 版本。当前支持的版本包括：3.8.18：RabbitMQ 3.8.18 版本。
vpcId String: 私有网络（VPC）ID。
zoneDescription String: 可用区的描述信息。
zoneId String: 实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

accountId string: 创建实例的主账号ID。
applyPrivateDnsToPublic boolean: 是否已开启公网解析功能。true：已开启, false：已关闭
archType string: 实例的类型，即集群版或单机版。
chargeDetail GetInstanceChargeDetail: 实例的计费方式等计费信息。
computeSpec string: RabbitMQ实例的计算规格。
createdTime string: 实例的创建时间。
eipId string: EIP的ID。
endpoints GetInstanceEndpoint[]: 实例的连接信息。
id string: Uniquely identifies the resource.
instanceDescription string: 实例的简单描述。
instanceId string: RabbitMQ 实例 ID。
instanceName string: RabbitMQ 实例名称。
instanceStatus string: 实例状态。
isEncrypted boolean: 是否开启了云盘加密。
projectName string: 实例所属的IAM项目。
storageSpace number: 实例总存储空间。单位为 GiB。
subnetId string: VPC的子网ID。
tags GetInstanceTag[]: 实例绑定的标签。
usedStorageSpace number: 实例已用存储空间。单位为 GiB。
userName string: RabbitMQ WebUI管理员账号名。
userPassword string: RabbitMQ WebUI管理员密码。
version string: 支持的 RabbitMQ 版本。当前支持的版本包括：3.8.18：RabbitMQ 3.8.18 版本。
vpcId string: 私有网络（VPC）ID。
zoneDescription string: 可用区的描述信息。
zoneId string: 实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

account_id str: 创建实例的主账号ID。
apply_private_dns_to_public bool: 是否已开启公网解析功能。true：已开启, false：已关闭
arch_type str: 实例的类型，即集群版或单机版。
charge_detail GetInstanceChargeDetail: 实例的计费方式等计费信息。
compute_spec str: RabbitMQ实例的计算规格。
created_time str: 实例的创建时间。
eip_id str: EIP的ID。
endpoints Sequence[GetInstanceEndpoint]: 实例的连接信息。
id str: Uniquely identifies the resource.
instance_description str: 实例的简单描述。
instance_id str: RabbitMQ 实例 ID。
instance_name str: RabbitMQ 实例名称。
instance_status str: 实例状态。
is_encrypted bool: 是否开启了云盘加密。
project_name str: 实例所属的IAM项目。
storage_space int: 实例总存储空间。单位为 GiB。
subnet_id str: VPC的子网ID。
tags Sequence[GetInstanceTag]: 实例绑定的标签。
used_storage_space int: 实例已用存储空间。单位为 GiB。
user_name str: RabbitMQ WebUI管理员账号名。
user_password str: RabbitMQ WebUI管理员密码。
version str: 支持的 RabbitMQ 版本。当前支持的版本包括：3.8.18：RabbitMQ 3.8.18 版本。
vpc_id str: 私有网络（VPC）ID。
zone_description str: 可用区的描述信息。
zone_id str: 实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

accountId String: 创建实例的主账号ID。
applyPrivateDnsToPublic Boolean: 是否已开启公网解析功能。true：已开启, false：已关闭
archType String: 实例的类型，即集群版或单机版。
chargeDetail Property Map: 实例的计费方式等计费信息。
computeSpec String: RabbitMQ实例的计算规格。
createdTime String: 实例的创建时间。
eipId String: EIP的ID。
endpoints List<Property Map>: 实例的连接信息。
id String: Uniquely identifies the resource.
instanceDescription String: 实例的简单描述。
instanceId String: RabbitMQ 实例 ID。
instanceName String: RabbitMQ 实例名称。
instanceStatus String: 实例状态。
isEncrypted Boolean: 是否开启了云盘加密。
projectName String: 实例所属的IAM项目。
storageSpace Number: 实例总存储空间。单位为 GiB。
subnetId String: VPC的子网ID。
tags List<Property Map>: 实例绑定的标签。
usedStorageSpace Number: 实例已用存储空间。单位为 GiB。
userName String: RabbitMQ WebUI管理员账号名。
userPassword String: RabbitMQ WebUI管理员密码。
version String: 支持的 RabbitMQ 版本。当前支持的版本包括：3.8.18：RabbitMQ 3.8.18 版本。
vpcId String: 私有网络（VPC）ID。
zoneDescription String: 可用区的描述信息。
zoneId String: 实例所在的可用区 ID。对于跨 AZ 的高可用实例，此处会返回多个可用区 ID。

Supporting Types

GetInstanceChargeDetail

AutoRenew bool: 包年包月实例到期后是否自动续费。
ChargeEndTime string: 实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
ChargeExpireTime string: 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
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 指定为 Month 时，取值范围为 1~9。PeriodUnit 指定为 Year 时，取值范围为 1~3。
PeriodUnit string: 购买时长的单位，取值如下：MONTHLY：按月购买。YEARLY：按年购买。

AutoRenew bool: 包年包月实例到期后是否自动续费。
ChargeEndTime string: 实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
ChargeExpireTime string: 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
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 指定为 Month 时，取值范围为 1~9。PeriodUnit 指定为 Year 时，取值范围为 1~3。
PeriodUnit string: 购买时长的单位，取值如下：MONTHLY：按月购买。YEARLY：按年购买。

autoRenew Boolean: 包年包月实例到期后是否自动续费。
chargeEndTime String: 实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
chargeExpireTime String: 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
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 指定为 Month 时，取值范围为 1~9。PeriodUnit 指定为 Year 时，取值范围为 1~3。
periodUnit String: 购买时长的单位，取值如下：MONTHLY：按月购买。YEARLY：按年购买。

autoRenew boolean: 包年包月实例到期后是否自动续费。
chargeEndTime string: 实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
chargeExpireTime string: 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
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 指定为 Month 时，取值范围为 1~9。PeriodUnit 指定为 Year 时，取值范围为 1~3。
periodUnit string: 购买时长的单位，取值如下：MONTHLY：按月购买。YEARLY：按年购买。

auto_renew bool: 包年包月实例到期后是否自动续费。
charge_end_time str: 实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
charge_expire_time str: 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
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 指定为 Month 时，取值范围为 1~9。PeriodUnit 指定为 Year 时，取值范围为 1~3。
period_unit str: 购买时长的单位，取值如下：MONTHLY：按月购买。YEARLY：按年购买。

autoRenew Boolean: 包年包月实例到期后是否自动续费。
chargeEndTime String: 实例的结束计费时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
chargeExpireTime String: 包年包月实例的到期时间。时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
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 指定为 Month 时，取值范围为 1~9。PeriodUnit 指定为 Year 时，取值范围为 1~3。
periodUnit String: 购买时长的单位，取值如下：MONTHLY：按月购买。YEARLY：按年购买。

GetInstanceEndpoint

EndpointType string: 实例的接入点类型。RabbitMQ实例提供的接入点类型包括：WEB：Web UI 接入点，AMQP091：AMQP 接入点，MQTT：MQTT接入点，WEB_MQTT：WEB ，MQTT 接入点，STOMP：STOMP 接入点。
InternalEndpoint string: 实例的私网访问域名。
InternalIpEndpoint string: 公共服务区 IP 接入点。
NetworkType string: 接入点的网络类型。PrivateNetwork 表示私有网络 VPC。
PublicEndpoint string: 实例公网访问域名。仅在开启公网访问之后显示。

EndpointType string: 实例的接入点类型。RabbitMQ实例提供的接入点类型包括：WEB：Web UI 接入点，AMQP091：AMQP 接入点，MQTT：MQTT接入点，WEB_MQTT：WEB ，MQTT 接入点，STOMP：STOMP 接入点。
InternalEndpoint string: 实例的私网访问域名。
InternalIpEndpoint string: 公共服务区 IP 接入点。
NetworkType string: 接入点的网络类型。PrivateNetwork 表示私有网络 VPC。
PublicEndpoint string: 实例公网访问域名。仅在开启公网访问之后显示。

endpointType String: 实例的接入点类型。RabbitMQ实例提供的接入点类型包括：WEB：Web UI 接入点，AMQP091：AMQP 接入点，MQTT：MQTT接入点，WEB_MQTT：WEB ，MQTT 接入点，STOMP：STOMP 接入点。
internalEndpoint String: 实例的私网访问域名。
internalIpEndpoint String: 公共服务区 IP 接入点。
networkType String: 接入点的网络类型。PrivateNetwork 表示私有网络 VPC。
publicEndpoint String: 实例公网访问域名。仅在开启公网访问之后显示。

endpointType string: 实例的接入点类型。RabbitMQ实例提供的接入点类型包括：WEB：Web UI 接入点，AMQP091：AMQP 接入点，MQTT：MQTT接入点，WEB_MQTT：WEB ，MQTT 接入点，STOMP：STOMP 接入点。
internalEndpoint string: 实例的私网访问域名。
internalIpEndpoint string: 公共服务区 IP 接入点。
networkType string: 接入点的网络类型。PrivateNetwork 表示私有网络 VPC。
publicEndpoint string: 实例公网访问域名。仅在开启公网访问之后显示。

endpoint_type str: 实例的接入点类型。RabbitMQ实例提供的接入点类型包括：WEB：Web UI 接入点，AMQP091：AMQP 接入点，MQTT：MQTT接入点，WEB_MQTT：WEB ，MQTT 接入点，STOMP：STOMP 接入点。
internal_endpoint str: 实例的私网访问域名。
internal_ip_endpoint str: 公共服务区 IP 接入点。
network_type str: 接入点的网络类型。PrivateNetwork 表示私有网络 VPC。
public_endpoint str: 实例公网访问域名。仅在开启公网访问之后显示。

endpointType String: 实例的接入点类型。RabbitMQ实例提供的接入点类型包括：WEB：Web UI 接入点，AMQP091：AMQP 接入点，MQTT：MQTT接入点，WEB_MQTT：WEB ，MQTT 接入点，STOMP：STOMP 接入点。
internalEndpoint String: 实例的私网访问域名。
internalIpEndpoint String: 公共服务区 IP 接入点。
networkType String: 接入点的网络类型。PrivateNetwork 表示私有网络 VPC。
publicEndpoint String: 实例公网访问域名。仅在开启公网访问之后显示。

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: bytepluscc byteplus-sdk/pulumi-bytepluscc
License: MPL-2.0
Notes: This Pulumi package is based on the bytepluscc Terraform Provider.

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

bytepluscc.rabbitmq.getInstance

On this page

On this page

Using getInstance

getInstance Result

Supporting Types

GetInstanceChargeDetail

GetInstanceEndpoint

GetInstanceTag

Package Details

On this page

On this page