Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
published on Thursday, May 7, 2026 by Byteplus
Viewing docs for bytepluscc v0.0.25
published on Thursday, May 7, 2026 by Byteplus
published on Thursday, May 7, 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: pulumi.Input[Optional[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 - Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
- Billing
Period string - Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
- Billing
Type string - Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
- Created
Time string - Instance creation time
- Description string
- Instance description statement
- Eip
Id string - Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
- Endpoints
Byteplus.
Get Instance Endpoints - Response data for all instance endpoints
- Expiration
Time string - Instance expiration time
- Group
Limit int - Maximum number of consumer groups per instance
- Id string
- Uniquely identifies the resource.
- Instance
Id string - Instance ID
- Message
Retention int - Message retention period for all topics under the instance, in hours
- Name string
- Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- Partition
Limit int - Maximum number of partitions per instance
- Project
Name string - Project name to which the instance belongs
-
List<Byteplus.
Get Instance Resource Tag> - Instance resource tag list
- Resources
Byteplus.
Get Instance Resources - Instance resource statistics response data
- Security
Group List<string>Id Lists - List of security groups used by the instance
- Specification string
- Instance specification
- Status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- Subnet
Id List<string>Lists - List of subnets used by the instance
-
List<Byteplus.
Get Instance Tag> - Instance resource tag list
- Times int
- Purchase duration for subscription instances, in months
- Topic
Limit int - Maximum number of topics per instance
- Vpc
Id string - VPC ID where the instance is located
- Zone
Id List<string>Lists - List of availability zones where the instance is located
- Auto
Renew string - Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
- Billing
Period string - Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
- Billing
Type string - Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
- Created
Time string - Instance creation time
- Description string
- Instance description statement
- Eip
Id string - Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
- Endpoints
Get
Instance Endpoints - Response data for all instance endpoints
- Expiration
Time string - Instance expiration time
- Group
Limit int - Maximum number of consumer groups per instance
- Id string
- Uniquely identifies the resource.
- Instance
Id string - Instance ID
- Message
Retention int - Message retention period for all topics under the instance, in hours
- Name string
- Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- Partition
Limit int - Maximum number of partitions per instance
- Project
Name string - Project name to which the instance belongs
-
[]Get
Instance Resource Tag - Instance resource tag list
- Resources
Get
Instance Resources - Instance resource statistics response data
- Security
Group []stringId Lists - List of security groups used by the instance
- Specification string
- Instance specification
- Status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- Subnet
Id []stringLists - List of subnets used by the instance
-
[]Get
Instance Tag - Instance resource tag list
- Times int
- Purchase duration for subscription instances, in months
- Topic
Limit int - Maximum number of topics per instance
- Vpc
Id string - VPC ID where the instance is located
- Zone
Id []stringLists - List of availability zones where the instance is located
- auto
Renew String - Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
- billing
Period String - Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
- billing
Type String - Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
- created
Time String - Instance creation time
- description String
- Instance description statement
- eip
Id String - Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
- endpoints
Get
Instance Endpoints - Response data for all instance endpoints
- expiration
Time String - Instance expiration time
- group
Limit Integer - Maximum number of consumer groups per instance
- id String
- Uniquely identifies the resource.
- instance
Id String - Instance ID
- message
Retention Integer - Message retention period for all topics under the instance, in hours
- name String
- Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition
Limit Integer - Maximum number of partitions per instance
- project
Name String - Project name to which the instance belongs
-
List<Get
Instance Resource Tag> - Instance resource tag list
- resources
Get
Instance Resources - Instance resource statistics response data
- security
Group List<String>Id Lists - List of security groups used by the instance
- specification String
- Instance specification
- status String
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet
Id List<String>Lists - List of subnets used by the instance
-
List<Get
Instance Tag> - Instance resource tag list
- times Integer
- Purchase duration for subscription instances, in months
- topic
Limit Integer - Maximum number of topics per instance
- vpc
Id String - VPC ID where the instance is located
- zone
Id List<String>Lists - List of availability zones where the instance is located
- auto
Renew string - Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
- billing
Period string - Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
- billing
Type string - Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
- created
Time string - Instance creation time
- description string
- Instance description statement
- eip
Id string - Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
- endpoints
Get
Instance Endpoints - Response data for all instance endpoints
- expiration
Time string - Instance expiration time
- group
Limit number - Maximum number of consumer groups per instance
- id string
- Uniquely identifies the resource.
- instance
Id string - Instance ID
- message
Retention number - Message retention period for all topics under the instance, in hours
- name string
- Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition
Limit number - Maximum number of partitions per instance
- project
Name string - Project name to which the instance belongs
-
Get
Instance Resource Tag[] - Instance resource tag list
- resources
Get
Instance Resources - Instance resource statistics response data
- security
Group string[]Id Lists - List of security groups used by the instance
- specification string
- Instance specification
- status string
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet
Id string[]Lists - List of subnets used by the instance
-
Get
Instance Tag[] - Instance resource tag list
- times number
- Purchase duration for subscription instances, in months
- topic
Limit number - Maximum number of topics per instance
- vpc
Id string - VPC ID where the instance is located
- zone
Id string[]Lists - List of availability zones where the instance is located
- auto_
renew str - Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
- billing_
period str - Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
- billing_
type str - Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
- created_
time str - Instance creation time
- description str
- Instance description statement
- eip_
id str - Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
- endpoints
Get
Instance Endpoints - Response data for all instance endpoints
- expiration_
time str - Instance expiration time
- group_
limit int - Maximum number of consumer groups per instance
- id str
- Uniquely identifies the resource.
- instance_
id str - Instance ID
- message_
retention int - Message retention period for all topics under the instance, in hours
- name str
- Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition_
limit int - Maximum number of partitions per instance
- project_
name str - Project name to which the instance belongs
-
Sequence[Get
Instance Resource Tag] - Instance resource tag list
- resources
Get
Instance Resources - Instance resource statistics response data
- security_
group_ Sequence[str]id_ lists - List of security groups used by the instance
- specification str
- Instance specification
- status str
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet_
id_ Sequence[str]lists - List of subnets used by the instance
-
Sequence[Get
Instance Tag] - Instance resource tag list
- times int
- Purchase duration for subscription instances, in months
- topic_
limit int - Maximum number of topics per instance
- vpc_
id str - VPC ID where the instance is located
- zone_
id_ Sequence[str]lists - List of availability zones where the instance is located
- auto
Renew String - Whether to enable auto-renewal. Possible values: true: Enable auto-renewal. false: Disable auto-renewal
- billing
Period String - Unit of purchase duration. Possible values: MONTHLY: Monthly purchase. YEARLY: Annual purchase
- billing
Type String - Instance billing method. Possible values: POST: Pay-as-you-go. MIX: Subscription
- created
Time String - Instance creation time
- description String
- Instance description statement
- eip
Id String - Whether public access is enabled for the instance. To enable public access, configure the public IP ID in the same region
- endpoints Property Map
- Response data for all instance endpoints
- expiration
Time String - Instance expiration time
- group
Limit Number - Maximum number of consumer groups per instance
- id String
- Uniquely identifies the resource.
- instance
Id String - Instance ID
- message
Retention Number - Message retention period for all topics under the instance, in hours
- name String
- Set a custom name for the BMQ instance. Constraints: Use lowercase letters, numbers, and hyphens (-). Length: 1–64 characters
- partition
Limit Number - Maximum number of partitions per instance
- project
Name String - Project name to which the instance belongs
- List<Property Map>
- Instance resource tag list
- resources Property Map
- Instance resource statistics response data
- security
Group List<String>Id Lists - List of security groups used by the instance
- specification String
- Instance specification
- status String
- Instance status. Possible values: INITIALIZING: Initializing, INITIALIZATIONFAILED: Initialization failed, RUNNING: Running, MODIFYING: Updating, MODIFYFAILED: Update failed, RELEASING: Releasing, STOPPING: Stopping, STOPPED: Stopped, RECOVERING: Recovering, EXCEPTION: Exception, CAPACITYEXPAXIONFAILED: Capacity expansion failed, EXPANDINGCAPACITY: Expanding capacity, CANCELEXPANDING_CAPACITY: Canceling capacity expansion, RESTARTING: Restarting, UNPAID: Unpaid
- subnet
Id List<String>Lists - List of subnets used by the instance
- List<Property Map>
- Instance resource tag list
- times Number
- Purchase duration for subscription instances, in months
- topic
Limit Number - Maximum number of topics per instance
- vpc
Id String - VPC ID where the instance is located
- zone
Id List<String>Lists - List of availability zones where the instance is located
Supporting Types
GetInstanceEndpoints
- Overlay
Byteplus.
Get Instance Endpoints Overlay - Instance private network access endpoint response data
- Public
Byteplus.
Get Instance Endpoints Public - Instance public access endpoint response data
- Overlay
Get
Instance Endpoints Overlay - Instance private network access endpoint response data
- Public
Get
Instance Endpoints Public - Instance public access endpoint response data
- overlay
Get
Instance Endpoints Overlay - Instance private network access endpoint response data
- public_
Get
Instance Endpoints Public - Instance public access endpoint response data
- overlay
Get
Instance Endpoints Overlay - Instance private network access endpoint response data
- public
Get
Instance Endpoints Public - Instance public access endpoint response data
- overlay
Get
Instance Endpoints Overlay - Instance private network access endpoint response data
- public
Get
Instance Endpoints Public - Instance public access endpoint response data
- overlay Property Map
- Instance private network access endpoint response data
- public Property Map
- Instance public access endpoint response data
GetInstanceEndpointsOverlay
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain endpoint
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication endpoint
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids List<string> - List of VPC IDs associated with the sales zone network
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain endpoint
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication endpoint
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids []string - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain endpoint
- plain
Port Integer - Standard endpoint port
- sasl String
- Private network SASL authentication endpoint
- sasl
Port Integer - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Integer - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
- address string
- Domain mapping address
- eip
Id string - ID of the EIP bound to the instance
- plain string
- Private network Plain endpoint
- plain
Port number - Standard endpoint port
- sasl string
- Private network SASL authentication endpoint
- sasl
Port number - Authentication endpoint port
- ssl string
- Encrypted endpoint
- ssl
Port number - Encrypted endpoint port
- status string
- Endpoint status
- vpc
Ids string[] - List of VPC IDs associated with the sales zone network
- address str
- Domain mapping address
- eip_
id str - ID of the EIP bound to the instance
- plain str
- Private network Plain endpoint
- plain_
port int - Standard endpoint port
- sasl str
- Private network SASL authentication endpoint
- sasl_
port int - Authentication endpoint port
- ssl str
- Encrypted endpoint
- ssl_
port int - Encrypted endpoint port
- status str
- Endpoint status
- vpc_
ids Sequence[str] - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain endpoint
- plain
Port Number - Standard endpoint port
- sasl String
- Private network SASL authentication endpoint
- sasl
Port Number - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Number - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
GetInstanceEndpointsPublic
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain endpoint
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication endpoint
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids List<string> - List of VPC IDs associated with the sales zone network
- Address string
- Domain mapping address
- Eip
Id string - ID of the EIP bound to the instance
- Plain string
- Private network Plain endpoint
- Plain
Port int - Standard endpoint port
- Sasl string
- Private network SASL authentication endpoint
- Sasl
Port int - Authentication endpoint port
- Ssl string
- Encrypted endpoint
- Ssl
Port int - Encrypted endpoint port
- Status string
- Endpoint status
- Vpc
Ids []string - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain endpoint
- plain
Port Integer - Standard endpoint port
- sasl String
- Private network SASL authentication endpoint
- sasl
Port Integer - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Integer - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
- address string
- Domain mapping address
- eip
Id string - ID of the EIP bound to the instance
- plain string
- Private network Plain endpoint
- plain
Port number - Standard endpoint port
- sasl string
- Private network SASL authentication endpoint
- sasl
Port number - Authentication endpoint port
- ssl string
- Encrypted endpoint
- ssl
Port number - Encrypted endpoint port
- status string
- Endpoint status
- vpc
Ids string[] - List of VPC IDs associated with the sales zone network
- address str
- Domain mapping address
- eip_
id str - ID of the EIP bound to the instance
- plain str
- Private network Plain endpoint
- plain_
port int - Standard endpoint port
- sasl str
- Private network SASL authentication endpoint
- sasl_
port int - Authentication endpoint port
- ssl str
- Encrypted endpoint
- ssl_
port int - Encrypted endpoint port
- status str
- Endpoint status
- vpc_
ids Sequence[str] - List of VPC IDs associated with the sales zone network
- address String
- Domain mapping address
- eip
Id String - ID of the EIP bound to the instance
- plain String
- Private network Plain endpoint
- plain
Port Number - Standard endpoint port
- sasl String
- Private network SASL authentication endpoint
- sasl
Port Number - Authentication endpoint port
- ssl String
- Encrypted endpoint
- ssl
Port Number - Encrypted endpoint port
- status String
- Endpoint status
- vpc
Ids List<String> - List of VPC IDs associated with the sales zone network
GetInstanceResourceTag
- Tag
Kvs List<Byteplus.Get Instance Resource Tag Tag Kv> - Tag key-value pair
- Type string
- Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
- Tag
Kvs []GetInstance Resource Tag Tag Kv - Tag key-value pair
- Type string
- Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
- tag
Kvs List<GetInstance Resource Tag Tag Kv> - Tag key-value pair
- type String
- Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
- tag
Kvs GetInstance Resource Tag Tag Kv[] - Tag key-value pair
- type string
- Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
- tag_
kvs Sequence[GetInstance Resource Tag Tag Kv] - Tag key-value pair
- type str
- Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
- tag
Kvs List<Property Map> - Tag key-value pair
- type String
- Tag type. Options: CUSTOM: custom tag. SYSTEM: system tag
GetInstanceResourceTagTagKv
GetInstanceResources
- Storage
Byteplus.
Get Instance Resources Storage - Resource statistics response data
- Storage
Get
Instance Resources Storage - Resource statistics response data
- storage
Get
Instance Resources Storage - Resource statistics response data
- storage
Get
Instance Resources Storage - Resource statistics response data
- storage
Get
Instance Resources Storage - Resource statistics response data
- storage Property Map
- Resource statistics response data
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.25
published on Thursday, May 7, 2026 by Byteplus
published on Thursday, May 7, 2026 by Byteplus
