Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
Data Source schema for Byteplus::BMQ::Instance
Using getInstance
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>def get_instance(id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput> Note: This function is named LookupInstance in the Go SDK.
public static class GetInstance
{
public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
fn::invoke:
function: bytepluscc:bmq/getInstance:getInstance
arguments:
# arguments dictionaryThe following arguments are supported:
- Id string
- Uniquely identifies the resource.
- Id string
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
- id string
- Uniquely identifies the resource.
- id str
- Uniquely identifies the resource.
- id String
- Uniquely identifies the resource.
getInstance Result
The following output properties are available:
- Auto
Renew string - 是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
- Billing
Period string - 购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
- Billing
Type string - 实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
- Created
Time string - 实例的创建时间。
- Description string
- 实例的描述语句。
- Eip
Id string - 实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
- Endpoints
Byteplus.
Get Instance Endpoints - 实例所有接入点响应数据。
- Expiration
Time string - 实例过期时间。
- Group
Limit int - 实例消费组数量上限。
- Id string
- Uniquely identifies the resource.
- Instance
Id string - 实例ID。
- Message
Retention int - 实例下所有 Topic 的消息保留时长,单位为小时。
- Name string
- 自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
- Partition
Limit int - 实例分区数量上限。
- Project
Name string - 实例所属项目名称。
-
List<Byteplus.
Get Instance Resource Tag> - 实例资源标签列表。
- Resources
Byteplus.
Get Instance Resources - 实例资源统计响应数据。
- Security
Group List<string>Id Lists - 实例使用安全组列表。
- Specification string
- 实例规格。
- Status string
- 实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
- Subnet
Id List<string>Lists - 实例使用的子网列表。
-
List<Byteplus.
Get Instance Tag> - 实例资源标签列表。
- Times int
- 包年包月类型实例的购买时长,单位为月。
- Topic
Limit int - 实例Topic数量上限。
- Vpc
Id string - 实例所在VPC ID。
- Zone
Id List<string>Lists - 实例所在可用区列表。
- Auto
Renew string - 是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
- Billing
Period string - 购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
- Billing
Type string - 实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
- Created
Time string - 实例的创建时间。
- Description string
- 实例的描述语句。
- Eip
Id string - 实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
- Endpoints
Get
Instance Endpoints - 实例所有接入点响应数据。
- Expiration
Time string - 实例过期时间。
- Group
Limit int - 实例消费组数量上限。
- Id string
- Uniquely identifies the resource.
- Instance
Id string - 实例ID。
- Message
Retention int - 实例下所有 Topic 的消息保留时长,单位为小时。
- Name string
- 自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
- Partition
Limit int - 实例分区数量上限。
- Project
Name string - 实例所属项目名称。
-
[]Get
Instance Resource Tag - 实例资源标签列表。
- Resources
Get
Instance Resources - 实例资源统计响应数据。
- Security
Group []stringId Lists - 实例使用安全组列表。
- Specification string
- 实例规格。
- Status string
- 实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
- Subnet
Id []stringLists - 实例使用的子网列表。
-
[]Get
Instance Tag - 实例资源标签列表。
- Times int
- 包年包月类型实例的购买时长,单位为月。
- Topic
Limit int - 实例Topic数量上限。
- Vpc
Id string - 实例所在VPC ID。
- Zone
Id []stringLists - 实例所在可用区列表。
- auto
Renew String - 是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
- billing
Period String - 购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
- billing
Type String - 实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
- created
Time String - 实例的创建时间。
- description String
- 实例的描述语句。
- eip
Id String - 实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
- endpoints
Get
Instance Endpoints - 实例所有接入点响应数据。
- expiration
Time String - 实例过期时间。
- group
Limit Integer - 实例消费组数量上限。
- id String
- Uniquely identifies the resource.
- instance
Id String - 实例ID。
- message
Retention Integer - 实例下所有 Topic 的消息保留时长,单位为小时。
- name String
- 自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
- partition
Limit Integer - 实例分区数量上限。
- project
Name String - 实例所属项目名称。
-
List<Get
Instance Resource Tag> - 实例资源标签列表。
- resources
Get
Instance Resources - 实例资源统计响应数据。
- security
Group List<String>Id Lists - 实例使用安全组列表。
- specification String
- 实例规格。
- status String
- 实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
- subnet
Id List<String>Lists - 实例使用的子网列表。
-
List<Get
Instance Tag> - 实例资源标签列表。
- times Integer
- 包年包月类型实例的购买时长,单位为月。
- topic
Limit Integer - 实例Topic数量上限。
- vpc
Id String - 实例所在VPC ID。
- zone
Id List<String>Lists - 实例所在可用区列表。
- auto
Renew string - 是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
- billing
Period string - 购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
- billing
Type string - 实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
- created
Time string - 实例的创建时间。
- description string
- 实例的描述语句。
- eip
Id string - 实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
- endpoints
Get
Instance Endpoints - 实例所有接入点响应数据。
- expiration
Time string - 实例过期时间。
- group
Limit number - 实例消费组数量上限。
- id string
- Uniquely identifies the resource.
- instance
Id string - 实例ID。
- message
Retention number - 实例下所有 Topic 的消息保留时长,单位为小时。
- name string
- 自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
- partition
Limit number - 实例分区数量上限。
- project
Name string - 实例所属项目名称。
-
Get
Instance Resource Tag[] - 实例资源标签列表。
- resources
Get
Instance Resources - 实例资源统计响应数据。
- security
Group string[]Id Lists - 实例使用安全组列表。
- specification string
- 实例规格。
- status string
- 实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
- subnet
Id string[]Lists - 实例使用的子网列表。
-
Get
Instance Tag[] - 实例资源标签列表。
- times number
- 包年包月类型实例的购买时长,单位为月。
- topic
Limit number - 实例Topic数量上限。
- vpc
Id string - 实例所在VPC ID。
- zone
Id string[]Lists - 实例所在可用区列表。
- auto_
renew str - 是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
- billing_
period str - 购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
- billing_
type str - 实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
- created_
time str - 实例的创建时间。
- description str
- 实例的描述语句。
- eip_
id str - 实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
- endpoints
Get
Instance Endpoints - 实例所有接入点响应数据。
- expiration_
time str - 实例过期时间。
- group_
limit int - 实例消费组数量上限。
- id str
- Uniquely identifies the resource.
- instance_
id str - 实例ID。
- message_
retention int - 实例下所有 Topic 的消息保留时长,单位为小时。
- name str
- 自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
- partition_
limit int - 实例分区数量上限。
- project_
name str - 实例所属项目名称。
-
Sequence[Get
Instance Resource Tag] - 实例资源标签列表。
- resources
Get
Instance Resources - 实例资源统计响应数据。
- security_
group_ Sequence[str]id_ lists - 实例使用安全组列表。
- specification str
- 实例规格。
- status str
- 实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
- subnet_
id_ Sequence[str]lists - 实例使用的子网列表。
-
Sequence[Get
Instance Tag] - 实例资源标签列表。
- times int
- 包年包月类型实例的购买时长,单位为月。
- topic_
limit int - 实例Topic数量上限。
- vpc_
id str - 实例所在VPC ID。
- zone_
id_ Sequence[str]lists - 实例所在可用区列表。
- auto
Renew String - 是否开启自动续费,取值如下:true:开启自动续费。false:关闭自动续费。
- billing
Period String - 购买时长的单位,取值如下:MONTHLY:按月购买。YEARLY:按年购买。
- billing
Type String - 实例的计费方式,取值如下:POST:按量计费。MIX:包年包月。
- created
Time String - 实例的创建时间。
- description String
- 实例的描述语句。
- eip
Id String - 实例是否开启公网访问。如果需要开启公网访问,请配置相同地域的公网 IP 的 ID。
- endpoints Property Map
- 实例所有接入点响应数据。
- expiration
Time String - 实例过期时间。
- group
Limit Number - 实例消费组数量上限。
- id String
- Uniquely identifies the resource.
- instance
Id String - 实例ID。
- message
Retention Number - 实例下所有 Topic 的消息保留时长,单位为小时。
- name String
- 自定设置 BMQ 实例的名称,约束限制如下:由小写字母、数字和中划线(-)组成。长度为 1~64 字符。
- partition
Limit Number - 实例分区数量上限。
- project
Name String - 实例所属项目名称。
- List<Property Map>
- 实例资源标签列表。
- resources Property Map
- 实例资源统计响应数据。
- security
Group List<String>Id Lists - 实例使用安全组列表。
- specification String
- 实例规格。
- status String
- 实例的状态。取值如下:INITIALIZING:初始化中,INITIALIZATIONFAILED:初始化失败,RUNNING:运行中,MODIFYING:更新中,MODIFYFAILED:更新失败,RELEASING:释放中,STOPPING:停止中,STOPPED:停止,RECOVERING:恢复中,EXCEPTION:异常,CAPACITYEXPAXIONFAILED:扩容失败,EXPANDINGCAPACITY:扩容中,CANCELEXPANDING_CAPACITY:扩容取消中,RESTARTING:重启中,UNPAID:未支付
- subnet
Id List<String>Lists - 实例使用的子网列表。
- List<Property Map>
- 实例资源标签列表。
- times Number
- 包年包月类型实例的购买时长,单位为月。
- topic
Limit Number - 实例Topic数量上限。
- vpc
Id String - 实例所在VPC ID。
- zone
Id List<String>Lists - 实例所在可用区列表。
Supporting Types
GetInstanceEndpoints
- Overlay
Byteplus.
Get Instance Endpoints Overlay - 实例私网访问接入点响应数据。
- Public
Byteplus.
Get Instance Endpoints Public - 实例公网访问接入点响应数据。
- Overlay
Get
Instance Endpoints Overlay - 实例私网访问接入点响应数据。
- Public
Get
Instance Endpoints Public - 实例公网访问接入点响应数据。
- overlay
Get
Instance Endpoints Overlay - 实例私网访问接入点响应数据。
- public_
Get
Instance Endpoints Public - 实例公网访问接入点响应数据。
- overlay
Get
Instance Endpoints Overlay - 实例私网访问接入点响应数据。
- public
Get
Instance Endpoints Public - 实例公网访问接入点响应数据。
- overlay
Get
Instance Endpoints Overlay - 实例私网访问接入点响应数据。
- public
Get
Instance Endpoints Public - 实例公网访问接入点响应数据。
- overlay Property Map
- 实例私网访问接入点响应数据。
- public Property Map
- 实例公网访问接入点响应数据。
GetInstanceEndpointsOverlay
GetInstanceEndpointsPublic
GetInstanceResourceTag
- Tag
Kvs List<Byteplus.Get Instance Resource Tag Tag Kv> - 标签键值对。
- Type string
- 标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
- Tag
Kvs []GetInstance Resource Tag Tag Kv - 标签键值对。
- Type string
- 标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
- tag
Kvs List<GetInstance Resource Tag Tag Kv> - 标签键值对。
- type String
- 标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
- tag
Kvs GetInstance Resource Tag Tag Kv[] - 标签键值对。
- type string
- 标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
- tag_
kvs Sequence[GetInstance Resource Tag Tag Kv] - 标签键值对。
- type str
- 标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
- tag
Kvs List<Property Map> - 标签键值对。
- type String
- 标签类型,取值如下:CUSTOM:自定义设置标签。SYSTEM:系统标签。
GetInstanceResourceTagTagKv
GetInstanceResources
- Storage
Get
Instance Resources Storage - 资源统计响应数据。
- storage
Get
Instance Resources Storage - 资源统计响应数据。
- storage
Get
Instance Resources Storage - 资源统计响应数据。
- storage
Get
Instance Resources Storage - 资源统计响应数据。
- storage Property Map
- 资源统计响应数据。
GetInstanceResourcesStorage
GetInstanceTag
Package Details
- Repository
- bytepluscc byteplus-sdk/pulumi-bytepluscc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
byteplusccTerraform Provider.
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
published on Monday, Mar 9, 2026 by Byteplus
