Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine.rocketmq.Groups
Explore with Pulumi AI
Use this data source to query detailed information of rocketmq groups
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
const foo = volcengine.rocketmq.Groups({
instanceId: "rocketmq-cnoeea6b32118fc2",
});
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.rocketmq.groups(instance_id="rocketmq-cnoeea6b32118fc2")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rocketmq"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rocketmq.Groups(ctx, &rocketmq.GroupsArgs{
InstanceId: "rocketmq-cnoeea6b32118fc2",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = Volcengine.Rocketmq.Groups.Invoke(new()
{
InstanceId = "rocketmq-cnoeea6b32118fc2",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rocketmq.RocketmqFunctions;
import com.pulumi.volcengine.rocketmq.inputs.GroupsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var foo = RocketmqFunctions.Groups(GroupsArgs.builder()
.instanceId("rocketmq-cnoeea6b32118fc2")
.build());
}
}
variables:
foo:
fn::invoke:
Function: volcengine:rocketmq:Groups
Arguments:
instanceId: rocketmq-cnoeea6b32118fc2
Using Groups
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 groups(args: GroupsArgs, opts?: InvokeOptions): Promise<GroupsResult>
function groupsOutput(args: GroupsOutputArgs, opts?: InvokeOptions): Output<GroupsResult>
def groups(group_id: Optional[str] = None,
group_type: Optional[str] = None,
instance_id: Optional[str] = None,
output_file: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GroupsResult
def groups_output(group_id: Optional[pulumi.Input[str]] = None,
group_type: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
output_file: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GroupsResult]
func Groups(ctx *Context, args *GroupsArgs, opts ...InvokeOption) (*GroupsResult, error)
func GroupsOutput(ctx *Context, args *GroupsOutputArgs, opts ...InvokeOption) GroupsResultOutput
public static class Groups
{
public static Task<GroupsResult> InvokeAsync(GroupsArgs args, InvokeOptions? opts = null)
public static Output<GroupsResult> Invoke(GroupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GroupsResult> groups(GroupsArgs args, InvokeOptions options)
public static Output<GroupsResult> groups(GroupsArgs args, InvokeOptions options)
fn::invoke:
function: volcengine:rocketmq:Groups
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - The id of rocketmq instance.
- Group
Id string - The id of rocketmq group. This field support fuzzy query.
- Group
Type string - The type of rocketmq group. Valid values:
TCP
. - Output
File string - File name where to save data source results.
- Instance
Id string - The id of rocketmq instance.
- Group
Id string - The id of rocketmq group. This field support fuzzy query.
- Group
Type string - The type of rocketmq group. Valid values:
TCP
. - Output
File string - File name where to save data source results.
- instance
Id String - The id of rocketmq instance.
- group
Id String - The id of rocketmq group. This field support fuzzy query.
- group
Type String - The type of rocketmq group. Valid values:
TCP
. - output
File String - File name where to save data source results.
- instance
Id string - The id of rocketmq instance.
- group
Id string - The id of rocketmq group. This field support fuzzy query.
- group
Type string - The type of rocketmq group. Valid values:
TCP
. - output
File string - File name where to save data source results.
- instance_
id str - The id of rocketmq instance.
- group_
id str - The id of rocketmq group. This field support fuzzy query.
- group_
type str - The type of rocketmq group. Valid values:
TCP
. - output_
file str - File name where to save data source results.
- instance
Id String - The id of rocketmq instance.
- group
Id String - The id of rocketmq group. This field support fuzzy query.
- group
Type String - The type of rocketmq group. Valid values:
TCP
. - output
File String - File name where to save data source results.
Groups Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Rocketmq
Groups List<GroupsRocketmq Group> - The collection of query.
- Total
Count int - The total count of query.
- Group
Id string - The id of the rocketmq group.
- Group
Type string - The type of the rocketmq group.
- Output
File string
- Id string
- The provider-assigned unique ID for this managed resource.
- Instance
Id string - Rocketmq
Groups []GroupsRocketmq Group - The collection of query.
- Total
Count int - The total count of query.
- Group
Id string - The id of the rocketmq group.
- Group
Type string - The type of the rocketmq group.
- Output
File string
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - rocketmq
Groups List<GroupsRocketmq Group> - The collection of query.
- total
Count Integer - The total count of query.
- group
Id String - The id of the rocketmq group.
- group
Type String - The type of the rocketmq group.
- output
File String
- id string
- The provider-assigned unique ID for this managed resource.
- instance
Id string - rocketmq
Groups GroupsRocketmq Group[] - The collection of query.
- total
Count number - The total count of query.
- group
Id string - The id of the rocketmq group.
- group
Type string - The type of the rocketmq group.
- output
File string
- id str
- The provider-assigned unique ID for this managed resource.
- instance_
id str - rocketmq_
groups Sequence[GroupsRocketmq Group] - The collection of query.
- total_
count int - The total count of query.
- group_
id str - The id of the rocketmq group.
- group_
type str - The type of the rocketmq group.
- output_
file str
- id String
- The provider-assigned unique ID for this managed resource.
- instance
Id String - rocketmq
Groups List<Property Map> - The collection of query.
- total
Count Number - The total count of query.
- group
Id String - The id of the rocketmq group.
- group
Type String - The type of the rocketmq group.
- output
File String
Supporting Types
GroupsRocketmqGroup
- Consumed
Clients List<GroupsRocketmq Group Consumed Client> - The consumed topic information of the rocketmq group.
- Consumed
Topics List<GroupsRocketmq Group Consumed Topic> - The consumed topic information of the rocketmq group.
- Create
Time string - The create time of the rocketmq group.
- Description string
- The description of the rocketmq group.
- Group
Id string - The id of rocketmq group. This field support fuzzy query.
- Group
Type string - The type of rocketmq group. Valid values:
TCP
. - Is
Sub boolSame - Whether the subscription relationship of consumer instance groups within the group is consistent.
- Message
Delay stringTime - The message delay time of the rocketmq group. The unit is milliseconds.
- Message
Model string - The message model of the rocketmq group.
- Status string
- The status of the rocketmq group.
- Total
Consume stringRate - The total consume rate of the rocketmq group. The unit is per second.
- Total
Diff int - The total amount of unconsumed messages.
- Consumed
Clients []GroupsRocketmq Group Consumed Client - The consumed topic information of the rocketmq group.
- Consumed
Topics []GroupsRocketmq Group Consumed Topic - The consumed topic information of the rocketmq group.
- Create
Time string - The create time of the rocketmq group.
- Description string
- The description of the rocketmq group.
- Group
Id string - The id of rocketmq group. This field support fuzzy query.
- Group
Type string - The type of rocketmq group. Valid values:
TCP
. - Is
Sub boolSame - Whether the subscription relationship of consumer instance groups within the group is consistent.
- Message
Delay stringTime - The message delay time of the rocketmq group. The unit is milliseconds.
- Message
Model string - The message model of the rocketmq group.
- Status string
- The status of the rocketmq group.
- Total
Consume stringRate - The total consume rate of the rocketmq group. The unit is per second.
- Total
Diff int - The total amount of unconsumed messages.
- consumed
Clients List<GroupsRocketmq Group Consumed Client> - The consumed topic information of the rocketmq group.
- consumed
Topics List<GroupsRocketmq Group Consumed Topic> - The consumed topic information of the rocketmq group.
- create
Time String - The create time of the rocketmq group.
- description String
- The description of the rocketmq group.
- group
Id String - The id of rocketmq group. This field support fuzzy query.
- group
Type String - The type of rocketmq group. Valid values:
TCP
. - is
Sub BooleanSame - Whether the subscription relationship of consumer instance groups within the group is consistent.
- message
Delay StringTime - The message delay time of the rocketmq group. The unit is milliseconds.
- message
Model String - The message model of the rocketmq group.
- status String
- The status of the rocketmq group.
- total
Consume StringRate - The total consume rate of the rocketmq group. The unit is per second.
- total
Diff Integer - The total amount of unconsumed messages.
- consumed
Clients GroupsRocketmq Group Consumed Client[] - The consumed topic information of the rocketmq group.
- consumed
Topics GroupsRocketmq Group Consumed Topic[] - The consumed topic information of the rocketmq group.
- create
Time string - The create time of the rocketmq group.
- description string
- The description of the rocketmq group.
- group
Id string - The id of rocketmq group. This field support fuzzy query.
- group
Type string - The type of rocketmq group. Valid values:
TCP
. - is
Sub booleanSame - Whether the subscription relationship of consumer instance groups within the group is consistent.
- message
Delay stringTime - The message delay time of the rocketmq group. The unit is milliseconds.
- message
Model string - The message model of the rocketmq group.
- status string
- The status of the rocketmq group.
- total
Consume stringRate - The total consume rate of the rocketmq group. The unit is per second.
- total
Diff number - The total amount of unconsumed messages.
- consumed_
clients Sequence[GroupsRocketmq Group Consumed Client] - The consumed topic information of the rocketmq group.
- consumed_
topics Sequence[GroupsRocketmq Group Consumed Topic] - The consumed topic information of the rocketmq group.
- create_
time str - The create time of the rocketmq group.
- description str
- The description of the rocketmq group.
- group_
id str - The id of rocketmq group. This field support fuzzy query.
- group_
type str - The type of rocketmq group. Valid values:
TCP
. - is_
sub_ boolsame - Whether the subscription relationship of consumer instance groups within the group is consistent.
- message_
delay_ strtime - The message delay time of the rocketmq group. The unit is milliseconds.
- message_
model str - The message model of the rocketmq group.
- status str
- The status of the rocketmq group.
- total_
consume_ strrate - The total consume rate of the rocketmq group. The unit is per second.
- total_
diff int - The total amount of unconsumed messages.
- consumed
Clients List<Property Map> - The consumed topic information of the rocketmq group.
- consumed
Topics List<Property Map> - The consumed topic information of the rocketmq group.
- create
Time String - The create time of the rocketmq group.
- description String
- The description of the rocketmq group.
- group
Id String - The id of rocketmq group. This field support fuzzy query.
- group
Type String - The type of rocketmq group. Valid values:
TCP
. - is
Sub BooleanSame - Whether the subscription relationship of consumer instance groups within the group is consistent.
- message
Delay StringTime - The message delay time of the rocketmq group. The unit is milliseconds.
- message
Model String - The message model of the rocketmq group.
- status String
- The status of the rocketmq group.
- total
Consume StringRate - The total consume rate of the rocketmq group. The unit is per second.
- total
Diff Number - The total amount of unconsumed messages.
GroupsRocketmqGroupConsumedClient
- Client
Address string - The address of the consumed client.
- Client
Id string - The id of the consumed client.
- Diff int
- The amount of message.
- Language string
- The language of the consumed client.
- Version string
- The version of the consumed client.
- Client
Address string - The address of the consumed client.
- Client
Id string - The id of the consumed client.
- Diff int
- The amount of message.
- Language string
- The language of the consumed client.
- Version string
- The version of the consumed client.
- client
Address String - The address of the consumed client.
- client
Id String - The id of the consumed client.
- diff Integer
- The amount of message.
- language String
- The language of the consumed client.
- version String
- The version of the consumed client.
- client
Address string - The address of the consumed client.
- client
Id string - The id of the consumed client.
- diff number
- The amount of message.
- language string
- The language of the consumed client.
- version string
- The version of the consumed client.
- client_
address str - The address of the consumed client.
- client_
id str - The id of the consumed client.
- diff int
- The amount of message.
- language str
- The language of the consumed client.
- version str
- The version of the consumed client.
- client
Address String - The address of the consumed client.
- client
Id String - The id of the consumed client.
- diff Number
- The amount of message.
- language String
- The language of the consumed client.
- version String
- The version of the consumed client.
GroupsRocketmqGroupConsumedTopic
- queue_
num int - The queue number of the rocketmq topic.
- sub_
string str - The sub string of the rocketmq topic.
- topic_
name str - The name of the rocketmq topic.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.