1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. rocketmq
  5. Instance
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
volcenginecc logo
volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine

    消息队列 RocketMQ版是基于 Apache RocketMQ 构建的分布式消息中间件服务,完全兼容开源 RocketMQ 的各个组件与概念,同时具备低延迟、弹性高可靠、高吞吐等特性优势,业务代码无需改造,帮助用户快速迁移上云。

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      rocketMQInstanceDemo:
        type: volcenginecc:rocketmq:Instance
        name: RocketMQInstanceDemo
        properties:
          allowListIds:
            - acl-5380876c62044b658c3c7da4xxxx
            - acl-3e998a9ef43e48eda1d07e2exxxx
          ipVersionType: IPv4
          enableSsl: true
          tags:
            - key: env
              value: test
          version: 5.x
          zoneId: cn-beijing-a,cn-beijing-c,cn-beijing-d
          computeSpec: rocketmq.x2.2k
          storageSpace: 300
          vpcId: vpc-1a1vgeo93ycxxxxxxxjnuw
          subnetId: subnet-ij9s4h4xxxxxxx95wx4p
          fileReservedTime: 72
          instanceName: RocketMQInstanceDemo
          chargeDetail:
            charge_type: PostPaid
          sslMode: permissive
          networkTypes: PrivateNetwork
          projectName: default
          instanceDescription: RocketMQInstanceDemo description
          eipId: eip-bt6jb362txxxxx2zbpbo
    

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 subnet_id: Optional[str] = None,
                 network_types: Optional[str] = None,
                 charge_detail: Optional[InstanceChargeDetailArgs] = None,
                 compute_spec: Optional[str] = None,
                 zone_id: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 file_reserved_time: Optional[int] = None,
                 version: Optional[str] = None,
                 storage_space: Optional[int] = None,
                 auto_scale_queue: Optional[bool] = None,
                 project_name: Optional[str] = None,
                 product_info: Optional[InstanceProductInfoArgs] = None,
                 instance_name: Optional[str] = None,
                 ssl_mode: Optional[str] = None,
                 ip_version_type: Optional[str] = None,
                 allow_list_ids: Optional[Sequence[str]] = None,
                 tags: Optional[Sequence[InstanceTagArgs]] = None,
                 instance_description: Optional[str] = None,
                 enable_ssl: Optional[bool] = None,
                 eip_id: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: volcenginecc:rocketmq:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromRocketmqinstance = new Volcenginecc.Rocketmq.Instance("exampleinstanceResourceResourceFromRocketmqinstance", new()
    {
        SubnetId = "string",
        NetworkTypes = "string",
        ChargeDetail = new Volcenginecc.Rocketmq.Inputs.InstanceChargeDetailArgs
        {
            AutoRenew = false,
            ChargeExpireTime = "string",
            ChargeStartTime = "string",
            ChargeStatus = "string",
            ChargeType = "string",
            OverdueReclaimTime = "string",
            OverdueTime = "string",
            Period = 0,
            PeriodUnit = "string",
        },
        ComputeSpec = "string",
        ZoneId = "string",
        VpcId = "string",
        FileReservedTime = 0,
        Version = "string",
        StorageSpace = 0,
        AutoScaleQueue = false,
        ProjectName = "string",
        ProductInfo = new Volcenginecc.Rocketmq.Inputs.InstanceProductInfoArgs
        {
            SendReceiveRatio = 0,
        },
        InstanceName = "string",
        SslMode = "string",
        IpVersionType = "string",
        AllowListIds = new[]
        {
            "string",
        },
        Tags = new[]
        {
            new Volcenginecc.Rocketmq.Inputs.InstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        InstanceDescription = "string",
        EnableSsl = false,
        EipId = "string",
    });
    
    example, err := rocketmq.NewInstance(ctx, "exampleinstanceResourceResourceFromRocketmqinstance", &rocketmq.InstanceArgs{
    	SubnetId:     pulumi.String("string"),
    	NetworkTypes: pulumi.String("string"),
    	ChargeDetail: &rocketmq.InstanceChargeDetailArgs{
    		AutoRenew:          pulumi.Bool(false),
    		ChargeExpireTime:   pulumi.String("string"),
    		ChargeStartTime:    pulumi.String("string"),
    		ChargeStatus:       pulumi.String("string"),
    		ChargeType:         pulumi.String("string"),
    		OverdueReclaimTime: pulumi.String("string"),
    		OverdueTime:        pulumi.String("string"),
    		Period:             pulumi.Int(0),
    		PeriodUnit:         pulumi.String("string"),
    	},
    	ComputeSpec:      pulumi.String("string"),
    	ZoneId:           pulumi.String("string"),
    	VpcId:            pulumi.String("string"),
    	FileReservedTime: pulumi.Int(0),
    	Version:          pulumi.String("string"),
    	StorageSpace:     pulumi.Int(0),
    	AutoScaleQueue:   pulumi.Bool(false),
    	ProjectName:      pulumi.String("string"),
    	ProductInfo: &rocketmq.InstanceProductInfoArgs{
    		SendReceiveRatio: pulumi.Int(0),
    	},
    	InstanceName:  pulumi.String("string"),
    	SslMode:       pulumi.String("string"),
    	IpVersionType: pulumi.String("string"),
    	AllowListIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: rocketmq.InstanceTagArray{
    		&rocketmq.InstanceTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	InstanceDescription: pulumi.String("string"),
    	EnableSsl:           pulumi.Bool(false),
    	EipId:               pulumi.String("string"),
    })
    
    var exampleinstanceResourceResourceFromRocketmqinstance = new com.volcengine.volcenginecc.rocketmq.Instance("exampleinstanceResourceResourceFromRocketmqinstance", com.volcengine.volcenginecc.rocketmq.InstanceArgs.builder()
        .subnetId("string")
        .networkTypes("string")
        .chargeDetail(InstanceChargeDetailArgs.builder()
            .autoRenew(false)
            .chargeExpireTime("string")
            .chargeStartTime("string")
            .chargeStatus("string")
            .chargeType("string")
            .overdueReclaimTime("string")
            .overdueTime("string")
            .period(0)
            .periodUnit("string")
            .build())
        .computeSpec("string")
        .zoneId("string")
        .vpcId("string")
        .fileReservedTime(0)
        .version("string")
        .storageSpace(0)
        .autoScaleQueue(false)
        .projectName("string")
        .productInfo(InstanceProductInfoArgs.builder()
            .sendReceiveRatio(0)
            .build())
        .instanceName("string")
        .sslMode("string")
        .ipVersionType("string")
        .allowListIds("string")
        .tags(InstanceTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .instanceDescription("string")
        .enableSsl(false)
        .eipId("string")
        .build());
    
    exampleinstance_resource_resource_from_rocketmqinstance = volcenginecc.rocketmq.Instance("exampleinstanceResourceResourceFromRocketmqinstance",
        subnet_id="string",
        network_types="string",
        charge_detail={
            "auto_renew": False,
            "charge_expire_time": "string",
            "charge_start_time": "string",
            "charge_status": "string",
            "charge_type": "string",
            "overdue_reclaim_time": "string",
            "overdue_time": "string",
            "period": 0,
            "period_unit": "string",
        },
        compute_spec="string",
        zone_id="string",
        vpc_id="string",
        file_reserved_time=0,
        version="string",
        storage_space=0,
        auto_scale_queue=False,
        project_name="string",
        product_info={
            "send_receive_ratio": 0,
        },
        instance_name="string",
        ssl_mode="string",
        ip_version_type="string",
        allow_list_ids=["string"],
        tags=[{
            "key": "string",
            "value": "string",
        }],
        instance_description="string",
        enable_ssl=False,
        eip_id="string")
    
    const exampleinstanceResourceResourceFromRocketmqinstance = new volcenginecc.rocketmq.Instance("exampleinstanceResourceResourceFromRocketmqinstance", {
        subnetId: "string",
        networkTypes: "string",
        chargeDetail: {
            autoRenew: false,
            chargeExpireTime: "string",
            chargeStartTime: "string",
            chargeStatus: "string",
            chargeType: "string",
            overdueReclaimTime: "string",
            overdueTime: "string",
            period: 0,
            periodUnit: "string",
        },
        computeSpec: "string",
        zoneId: "string",
        vpcId: "string",
        fileReservedTime: 0,
        version: "string",
        storageSpace: 0,
        autoScaleQueue: false,
        projectName: "string",
        productInfo: {
            sendReceiveRatio: 0,
        },
        instanceName: "string",
        sslMode: "string",
        ipVersionType: "string",
        allowListIds: ["string"],
        tags: [{
            key: "string",
            value: "string",
        }],
        instanceDescription: "string",
        enableSsl: false,
        eipId: "string",
    });
    
    type: volcenginecc:rocketmq:Instance
    properties:
        allowListIds:
            - string
        autoScaleQueue: false
        chargeDetail:
            autoRenew: false
            chargeExpireTime: string
            chargeStartTime: string
            chargeStatus: string
            chargeType: string
            overdueReclaimTime: string
            overdueTime: string
            period: 0
            periodUnit: string
        computeSpec: string
        eipId: string
        enableSsl: false
        fileReservedTime: 0
        instanceDescription: string
        instanceName: string
        ipVersionType: string
        networkTypes: string
        productInfo:
            sendReceiveRatio: 0
        projectName: string
        sslMode: string
        storageSpace: 0
        subnetId: string
        tags:
            - key: string
              value: string
        version: string
        vpcId: string
        zoneId: string
    

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Instance resource accepts the following input properties:

    ChargeDetail Volcengine.InstanceChargeDetail
    实例的计费方式等计费信息。
    ComputeSpec string
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    FileReservedTime int
    消息在消息队列 RocketMQ版服务端的保留时长,超过保留时长的消息将被过期清理。单位为小时,取值范围为 1~72 小时。
    NetworkTypes string
    实例网络类型,固定为 PrivateNetwork。
    StorageSpace int
    实例的存储空间。单位为 GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
    SubnetId string
    实例所在的 VPC 子网 ID。实例创建完成后,不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络(VPC)的 DescribeVpcs 接口查询可用的VPC和子网列表。
    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 查询当前提供服务的可用区列表。
    AllowListIds List<string>
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    AutoScaleQueue bool
    实例规格更改时,是否自动创建队列。
    EipId string
    EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后,公网地址将绑定您的弹性公网IP(EIP),费用由EIP收取。
    EnableSsl bool
    是否使用 SSL 加密。
    InstanceDescription string
    实例的简单描述。长度范围为 1~128 个字符。
    InstanceName string
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    IpVersionType string
    IP 版本, 可选直为 IPv4 或者 DualStack。
    ProductInfo Volcengine.InstanceProductInfo
    产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
    ProjectName string
    当前创建的实例所属的 IAM 项目。若未设置,则会将新实例绑定到名为 default 的 IAM 项目中。
    SslMode string
    实例的公网连接策略,仅在开启公网访问时需要设置。支持设置为:enforcing:通过公网访问实例时,必须经由 SSL 认证。SSL 认证可实现数据的加密传输,相较于普通公网访问方式具备更高的安全性,但性能会有所下降。permissive:通过公网访问实例时,可以选择是否经由 SSL 认证。创建实例后,公网访问为开启状态时,不能修改 SSL 连接策略。如需修改,需要为实例关闭并重新开启公网访问,在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
    Tags List<Volcengine.InstanceTag>
    ChargeDetail InstanceChargeDetailArgs
    实例的计费方式等计费信息。
    ComputeSpec string
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    FileReservedTime int
    消息在消息队列 RocketMQ版服务端的保留时长,超过保留时长的消息将被过期清理。单位为小时,取值范围为 1~72 小时。
    NetworkTypes string
    实例网络类型,固定为 PrivateNetwork。
    StorageSpace int
    实例的存储空间。单位为 GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
    SubnetId string
    实例所在的 VPC 子网 ID。实例创建完成后,不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络(VPC)的 DescribeVpcs 接口查询可用的VPC和子网列表。
    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 查询当前提供服务的可用区列表。
    AllowListIds []string
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    AutoScaleQueue bool
    实例规格更改时,是否自动创建队列。
    EipId string
    EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后,公网地址将绑定您的弹性公网IP(EIP),费用由EIP收取。
    EnableSsl bool
    是否使用 SSL 加密。
    InstanceDescription string
    实例的简单描述。长度范围为 1~128 个字符。
    InstanceName string
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    IpVersionType string
    IP 版本, 可选直为 IPv4 或者 DualStack。
    ProductInfo InstanceProductInfoArgs
    产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
    ProjectName string
    当前创建的实例所属的 IAM 项目。若未设置,则会将新实例绑定到名为 default 的 IAM 项目中。
    SslMode string
    实例的公网连接策略,仅在开启公网访问时需要设置。支持设置为:enforcing:通过公网访问实例时,必须经由 SSL 认证。SSL 认证可实现数据的加密传输,相较于普通公网访问方式具备更高的安全性,但性能会有所下降。permissive:通过公网访问实例时,可以选择是否经由 SSL 认证。创建实例后,公网访问为开启状态时,不能修改 SSL 连接策略。如需修改,需要为实例关闭并重新开启公网访问,在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
    Tags []InstanceTagArgs
    chargeDetail InstanceChargeDetail
    实例的计费方式等计费信息。
    computeSpec String
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    fileReservedTime Integer
    消息在消息队列 RocketMQ版服务端的保留时长,超过保留时长的消息将被过期清理。单位为小时,取值范围为 1~72 小时。
    networkTypes String
    实例网络类型,固定为 PrivateNetwork。
    storageSpace Integer
    实例的存储空间。单位为 GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
    subnetId String
    实例所在的 VPC 子网 ID。实例创建完成后,不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络(VPC)的 DescribeVpcs 接口查询可用的VPC和子网列表。
    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 查询当前提供服务的可用区列表。
    allowListIds List<String>
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    autoScaleQueue Boolean
    实例规格更改时,是否自动创建队列。
    eipId String
    EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后,公网地址将绑定您的弹性公网IP(EIP),费用由EIP收取。
    enableSsl Boolean
    是否使用 SSL 加密。
    instanceDescription String
    实例的简单描述。长度范围为 1~128 个字符。
    instanceName String
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    ipVersionType String
    IP 版本, 可选直为 IPv4 或者 DualStack。
    productInfo InstanceProductInfo
    产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
    projectName String
    当前创建的实例所属的 IAM 项目。若未设置,则会将新实例绑定到名为 default 的 IAM 项目中。
    sslMode String
    实例的公网连接策略,仅在开启公网访问时需要设置。支持设置为:enforcing:通过公网访问实例时,必须经由 SSL 认证。SSL 认证可实现数据的加密传输,相较于普通公网访问方式具备更高的安全性,但性能会有所下降。permissive:通过公网访问实例时,可以选择是否经由 SSL 认证。创建实例后,公网访问为开启状态时,不能修改 SSL 连接策略。如需修改,需要为实例关闭并重新开启公网访问,在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
    tags List<InstanceTag>
    chargeDetail InstanceChargeDetail
    实例的计费方式等计费信息。
    computeSpec string
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    fileReservedTime number
    消息在消息队列 RocketMQ版服务端的保留时长,超过保留时长的消息将被过期清理。单位为小时,取值范围为 1~72 小时。
    networkTypes string
    实例网络类型,固定为 PrivateNetwork。
    storageSpace number
    实例的存储空间。单位为 GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
    subnetId string
    实例所在的 VPC 子网 ID。实例创建完成后,不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络(VPC)的 DescribeVpcs 接口查询可用的VPC和子网列表。
    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 查询当前提供服务的可用区列表。
    allowListIds string[]
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    autoScaleQueue boolean
    实例规格更改时,是否自动创建队列。
    eipId string
    EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后,公网地址将绑定您的弹性公网IP(EIP),费用由EIP收取。
    enableSsl boolean
    是否使用 SSL 加密。
    instanceDescription string
    实例的简单描述。长度范围为 1~128 个字符。
    instanceName string
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    ipVersionType string
    IP 版本, 可选直为 IPv4 或者 DualStack。
    productInfo InstanceProductInfo
    产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
    projectName string
    当前创建的实例所属的 IAM 项目。若未设置,则会将新实例绑定到名为 default 的 IAM 项目中。
    sslMode string
    实例的公网连接策略,仅在开启公网访问时需要设置。支持设置为:enforcing:通过公网访问实例时,必须经由 SSL 认证。SSL 认证可实现数据的加密传输,相较于普通公网访问方式具备更高的安全性,但性能会有所下降。permissive:通过公网访问实例时,可以选择是否经由 SSL 认证。创建实例后,公网访问为开启状态时,不能修改 SSL 连接策略。如需修改,需要为实例关闭并重新开启公网访问,在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
    tags InstanceTag[]
    charge_detail InstanceChargeDetailArgs
    实例的计费方式等计费信息。
    compute_spec str
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    file_reserved_time int
    消息在消息队列 RocketMQ版服务端的保留时长,超过保留时长的消息将被过期清理。单位为小时,取值范围为 1~72 小时。
    network_types str
    实例网络类型,固定为 PrivateNetwork。
    storage_space int
    实例的存储空间。单位为 GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
    subnet_id str
    实例所在的 VPC 子网 ID。实例创建完成后,不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络(VPC)的 DescribeVpcs 接口查询可用的VPC和子网列表。
    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 查询当前提供服务的可用区列表。
    allow_list_ids Sequence[str]
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    auto_scale_queue bool
    实例规格更改时,是否自动创建队列。
    eip_id str
    EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后,公网地址将绑定您的弹性公网IP(EIP),费用由EIP收取。
    enable_ssl bool
    是否使用 SSL 加密。
    instance_description str
    实例的简单描述。长度范围为 1~128 个字符。
    instance_name str
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    ip_version_type str
    IP 版本, 可选直为 IPv4 或者 DualStack。
    product_info InstanceProductInfoArgs
    产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
    project_name str
    当前创建的实例所属的 IAM 项目。若未设置,则会将新实例绑定到名为 default 的 IAM 项目中。
    ssl_mode str
    实例的公网连接策略,仅在开启公网访问时需要设置。支持设置为:enforcing:通过公网访问实例时,必须经由 SSL 认证。SSL 认证可实现数据的加密传输,相较于普通公网访问方式具备更高的安全性,但性能会有所下降。permissive:通过公网访问实例时,可以选择是否经由 SSL 认证。创建实例后,公网访问为开启状态时,不能修改 SSL 连接策略。如需修改,需要为实例关闭并重新开启公网访问,在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
    tags Sequence[InstanceTagArgs]
    chargeDetail Property Map
    实例的计费方式等计费信息。
    computeSpec String
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    fileReservedTime Number
    消息在消息队列 RocketMQ版服务端的保留时长,超过保留时长的消息将被过期清理。单位为小时,取值范围为 1~72 小时。
    networkTypes String
    实例网络类型,固定为 PrivateNetwork。
    storageSpace Number
    实例的存储空间。单位为 GiB,必须指定为 100 的倍数。取值范围取决于当前指定的计算规格。
    subnetId String
    实例所在的 VPC 子网 ID。实例创建完成后,不可修改对应的私有网络和子网。创建实例时请谨慎操作。您可以调用私有网络(VPC)的 DescribeVpcs 接口查询可用的VPC和子网列表。
    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 查询当前提供服务的可用区列表。
    allowListIds List<String>
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    autoScaleQueue Boolean
    实例规格更改时,是否自动创建队列。
    eipId String
    EIP 的 ID。指定 EipId 表示开启实例的公网访问。EIP 提供独立的公网 IP 资源,包括公网 IP 地址与公网出口带宽服务。指定此参数开启公网访问后,公网地址将绑定您的弹性公网IP(EIP),费用由EIP收取。
    enableSsl Boolean
    是否使用 SSL 加密。
    instanceDescription String
    实例的简单描述。长度范围为 1~128 个字符。
    instanceName String
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    ipVersionType String
    IP 版本, 可选直为 IPv4 或者 DualStack。
    productInfo Property Map
    产品配置信息。说明仅 RocketMQ 5.x 版本实例支持调整实例的 TPS 占比。
    projectName String
    当前创建的实例所属的 IAM 项目。若未设置,则会将新实例绑定到名为 default 的 IAM 项目中。
    sslMode String
    实例的公网连接策略,仅在开启公网访问时需要设置。支持设置为:enforcing:通过公网访问实例时,必须经由 SSL 认证。SSL 认证可实现数据的加密传输,相较于普通公网访问方式具备更高的安全性,但性能会有所下降。permissive:通过公网访问实例时,可以选择是否经由 SSL 认证。创建实例后,公网访问为开启状态时,不能修改 SSL 连接策略。如需修改,需要为实例关闭并重新开启公网访问,在重新开启时再次设置 SSL 连接策略。详细说明请参考设置公网访问与 SSL 认证策略。
    tags List<Property Map>

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    AccountId string
    实例所属的账号 ID。
    ApplyPrivateDnsToPublic bool
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    AvailableQueueNumber int
    剩余可创建的分区数量。
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    CreateTime string
    实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例 ID。
    InstanceStatus string
    实例状态。
    RegionId string
    实例所在的地域 ID。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedQueueNumber int
    实例已经使用的队列数。
    UsedStorageSpace int
    实例已用储空间。单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    AccountId string
    实例所属的账号 ID。
    ApplyPrivateDnsToPublic bool
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    AvailableQueueNumber int
    剩余可创建的分区数量。
    ConnectionInfos []InstanceConnectionInfo
    CreateTime string
    实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    实例 ID。
    InstanceStatus string
    实例状态。
    RegionId string
    实例所在的地域 ID。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedQueueNumber int
    实例已经使用的队列数。
    UsedStorageSpace int
    实例已用储空间。单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    accountId String
    实例所属的账号 ID。
    applyPrivateDnsToPublic Boolean
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    availableQueueNumber Integer
    剩余可创建的分区数量。
    connectionInfos List<InstanceConnectionInfo>
    createTime String
    实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例 ID。
    instanceStatus String
    实例状态。
    regionId String
    实例所在的地域 ID。
    usedGroupNumber Integer
    当前实例已经创建的消费组(Group)个数。
    usedQueueNumber Integer
    实例已经使用的队列数。
    usedStorageSpace Integer
    实例已用储空间。单位为 GiB。
    usedTopicNumber Integer
    当前实例已创建的 Topic 个数。
    accountId string
    实例所属的账号 ID。
    applyPrivateDnsToPublic boolean
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    availableQueueNumber number
    剩余可创建的分区数量。
    connectionInfos InstanceConnectionInfo[]
    createTime string
    实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    实例 ID。
    instanceStatus string
    实例状态。
    regionId string
    实例所在的地域 ID。
    usedGroupNumber number
    当前实例已经创建的消费组(Group)个数。
    usedQueueNumber number
    实例已经使用的队列数。
    usedStorageSpace number
    实例已用储空间。单位为 GiB。
    usedTopicNumber number
    当前实例已创建的 Topic 个数。
    account_id str
    实例所属的账号 ID。
    apply_private_dns_to_public bool
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    available_queue_number int
    剩余可创建的分区数量。
    connection_infos Sequence[InstanceConnectionInfo]
    create_time str
    实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    实例 ID。
    instance_status str
    实例状态。
    region_id str
    实例所在的地域 ID。
    used_group_number int
    当前实例已经创建的消费组(Group)个数。
    used_queue_number int
    实例已经使用的队列数。
    used_storage_space int
    实例已用储空间。单位为 GiB。
    used_topic_number int
    当前实例已创建的 Topic 个数。
    accountId String
    实例所属的账号 ID。
    applyPrivateDnsToPublic Boolean
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    availableQueueNumber Number
    剩余可创建的分区数量。
    connectionInfos List<Property Map>
    createTime String
    实例的创建时间。时间显示格式为YYYY-MM-DD'T'HH:MM:SS'Z'。
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    实例 ID。
    instanceStatus String
    实例状态。
    regionId String
    实例所在的地域 ID。
    usedGroupNumber Number
    当前实例已经创建的消费组(Group)个数。
    usedQueueNumber Number
    实例已经使用的队列数。
    usedStorageSpace Number
    实例已用储空间。单位为 GiB。
    usedTopicNumber Number
    当前实例已创建的 Topic 个数。

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            allow_list_ids: Optional[Sequence[str]] = None,
            apply_private_dns_to_public: Optional[bool] = None,
            auto_scale_queue: Optional[bool] = None,
            available_queue_number: Optional[int] = None,
            charge_detail: Optional[InstanceChargeDetailArgs] = None,
            compute_spec: Optional[str] = None,
            connection_infos: Optional[Sequence[InstanceConnectionInfoArgs]] = None,
            create_time: Optional[str] = None,
            eip_id: Optional[str] = None,
            enable_ssl: Optional[bool] = None,
            file_reserved_time: Optional[int] = None,
            instance_description: Optional[str] = None,
            instance_id: Optional[str] = None,
            instance_name: Optional[str] = None,
            instance_status: Optional[str] = None,
            ip_version_type: Optional[str] = None,
            network_types: Optional[str] = None,
            product_info: Optional[InstanceProductInfoArgs] = None,
            project_name: Optional[str] = None,
            region_id: Optional[str] = None,
            ssl_mode: Optional[str] = None,
            storage_space: Optional[int] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Sequence[InstanceTagArgs]] = None,
            used_group_number: Optional[int] = None,
            used_queue_number: Optional[int] = None,
            used_storage_space: Optional[int] = None,
            used_topic_number: Optional[int] = None,
            version: Optional[str] = None,
            vpc_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rocketmq:Instance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    实例所属的账号 ID。
    AllowListIds List<string>
    实例绑定的白名单 ID 列表。绑定白名单后,仅配置在白名单中的 IP 地址与地址段才能访问此实例。如果实例未绑定任何白名单,表示禁止所有 IP 地址访问该实例。
    ApplyPrivateDnsToPublic bool
    是否已开启私网域名支持公网解析功能。true:已开启false:已关闭
    AutoScaleQueue bool
    实例规格更改时,是否自动创建队列。
    AvailableQueueNumber int
    剩余可创建的分区数量。
    ChargeDetail Volcengine.InstanceChargeDetail
    实例的计费方式等计费信息。
    ComputeSpec string
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    ConnectionInfos List<Volcengine.InstanceConnectionInfo>
    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 小时。
    InstanceDescription string
    实例的简单描述。长度范围为 1~128 个字符。
    InstanceId string
    实例 ID。
    InstanceName string
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    InstanceStatus string
    实例状态。
    IpVersionType string
    IP 版本, 可选直为 IPv4 或者 DualStack。
    NetworkTypes string
    实例网络类型,固定为 PrivateNetwork。
    ProductInfo Volcengine.InstanceProductInfo
    产品配置信息。说明仅 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.InstanceTag>
    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 InstanceChargeDetailArgs
    实例的计费方式等计费信息。
    ComputeSpec string
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    ConnectionInfos []InstanceConnectionInfoArgs
    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 小时。
    InstanceDescription string
    实例的简单描述。长度范围为 1~128 个字符。
    InstanceId string
    实例 ID。
    InstanceName string
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    InstanceStatus string
    实例状态。
    IpVersionType string
    IP 版本, 可选直为 IPv4 或者 DualStack。
    NetworkTypes string
    实例网络类型,固定为 PrivateNetwork。
    ProductInfo InstanceProductInfoArgs
    产品配置信息。说明仅 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 []InstanceTagArgs
    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 InstanceChargeDetail
    实例的计费方式等计费信息。
    computeSpec String
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    connectionInfos List<InstanceConnectionInfo>
    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 小时。
    instanceDescription String
    实例的简单描述。长度范围为 1~128 个字符。
    instanceId String
    实例 ID。
    instanceName String
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    instanceStatus String
    实例状态。
    ipVersionType String
    IP 版本, 可选直为 IPv4 或者 DualStack。
    networkTypes String
    实例网络类型,固定为 PrivateNetwork。
    productInfo InstanceProductInfo
    产品配置信息。说明仅 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<InstanceTag>
    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 InstanceChargeDetail
    实例的计费方式等计费信息。
    computeSpec string
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    connectionInfos InstanceConnectionInfo[]
    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 小时。
    instanceDescription string
    实例的简单描述。长度范围为 1~128 个字符。
    instanceId string
    实例 ID。
    instanceName string
    实例的名称。 需满足以下要求:只能包含中文、字母、数字、下划线(_)和连字符(-)。不能以数字和连字符(-)开头。长度范围为 1~128 个字符。如果创建实例时未指定名称,则默认将实例 ID 作为实例名称。
    instanceStatus string
    实例状态。
    ipVersionType string
    IP 版本, 可选直为 IPv4 或者 DualStack。
    networkTypes string
    实例网络类型,固定为 PrivateNetwork。
    productInfo InstanceProductInfo
    产品配置信息。说明仅 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 InstanceTag[]
    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 InstanceChargeDetailArgs
    实例的计费方式等计费信息。
    compute_spec str
    实例的计算规格。您可以在产品规格中查看目前在售的计算规格列表。
    connection_infos Sequence[InstanceConnectionInfoArgs]
    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 小时。
    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 InstanceProductInfoArgs
    产品配置信息。说明仅 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[InstanceTagArgs]
    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 小时。
    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

    InstanceChargeDetail, InstanceChargeDetailArgs

    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:包年

    InstanceConnectionInfo, InstanceConnectionInfoArgs

    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
    实例的公网接入点地址。

    InstanceProductInfo, InstanceProductInfoArgs

    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 占比。

    InstanceTag, InstanceTagArgs

    Key string
    标签键。
    Value string
    标签值。
    Key string
    标签键。
    Value string
    标签值。
    key String
    标签键。
    value String
    标签值。
    key string
    标签键。
    value string
    标签值。
    key str
    标签键。
    value str
    标签值。
    key String
    标签键。
    value String
    标签值。

    Import

    $ pulumi import volcenginecc:rocketmq/instance:Instance example "instance_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    volcenginecc v0.0.20 published on Thursday, Jan 22, 2026 by Volcengine
      Meet Neo: Your AI Platform Teammate