1. Packages
  2. Volcengine
  3. API Docs
  4. rocketmq
  5. getTopics
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rocketmq.getTopics

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of rocketmq topics

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.rocketmq.getTopics({
    instanceId: "rocketmq-cnoeea6b32118fc2",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rocketmq.get_topics(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.GetTopics(ctx, &rocketmq.GetTopicsArgs{
			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.GetTopics.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.GetTopicsArgs;
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.getTopics(GetTopicsArgs.builder()
            .instanceId("rocketmq-cnoeea6b32118fc2")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rocketmq:getTopics
      Arguments:
        instanceId: rocketmq-cnoeea6b32118fc2

    Using getTopics

    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 getTopics(args: GetTopicsArgs, opts?: InvokeOptions): Promise<GetTopicsResult>
function getTopicsOutput(args: GetTopicsOutputArgs, opts?: InvokeOptions): Output<GetTopicsResult>
    def get_topics(instance_id: Optional[str] = None,
               message_type: Optional[int] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               topic_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetTopicsResult
def get_topics_output(instance_id: Optional[pulumi.Input[str]] = None,
               message_type: Optional[pulumi.Input[int]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               topic_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetTopicsResult]
    func GetTopics(ctx *Context, args *GetTopicsArgs, opts ...InvokeOption) (*GetTopicsResult, error)
func GetTopicsOutput(ctx *Context, args *GetTopicsOutputArgs, opts ...InvokeOption) GetTopicsResultOutput

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

    public static class GetTopics 
{
    public static Task<GetTopicsResult> InvokeAsync(GetTopicsArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicsResult> Invoke(GetTopicsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTopicsResult> getTopics(GetTopicsArgs args, InvokeOptions options)
public static Output<GetTopicsResult> getTopics(GetTopicsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rocketmq/getTopics:getTopics
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    TopicName string
    The name of the rocketmq topic. This field support fuzzy query.
    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    TopicName string
    The name of the rocketmq topic. This field support fuzzy query.
    instanceId String
    The id of rocketmq instance.
    messageType Integer
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    topicName String
    The name of the rocketmq topic. This field support fuzzy query.
    instanceId string
    The id of rocketmq instance.
    messageType number
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    topicName string
    The name of the rocketmq topic. This field support fuzzy query.
    instance_id str
    The id of rocketmq instance.
    message_type int
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    topic_name str
    The name of the rocketmq topic. This field support fuzzy query.
    instanceId String
    The id of rocketmq instance.
    messageType Number
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    topicName String
    The name of the rocketmq topic. This field support fuzzy query.

    getTopics Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    The id of rocketmq instance.
    RocketmqTopics List<GetTopicsRocketmqTopic>
    The collection of query.
    TotalCount int
    The total count of query.
    MessageType int
    The type of the rocketmq message.
    NameRegex string
    OutputFile string
    TopicName string
    The name of the rocketmq topic.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    The id of rocketmq instance.
    RocketmqTopics []GetTopicsRocketmqTopic
    The collection of query.
    TotalCount int
    The total count of query.
    MessageType int
    The type of the rocketmq message.
    NameRegex string
    OutputFile string
    TopicName string
    The name of the rocketmq topic.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    The id of rocketmq instance.
    rocketmqTopics List<GetTopicsRocketmqTopic>
    The collection of query.
    totalCount Integer
    The total count of query.
    messageType Integer
    The type of the rocketmq message.
    nameRegex String
    outputFile String
    topicName String
    The name of the rocketmq topic.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    The id of rocketmq instance.
    rocketmqTopics GetTopicsRocketmqTopic[]
    The collection of query.
    totalCount number
    The total count of query.
    messageType number
    The type of the rocketmq message.
    nameRegex string
    outputFile string
    topicName string
    The name of the rocketmq topic.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    The id of rocketmq instance.
    rocketmq_topics Sequence[GetTopicsRocketmqTopic]
    The collection of query.
    total_count int
    The total count of query.
    message_type int
    The type of the rocketmq message.
    name_regex str
    output_file str
    topic_name str
    The name of the rocketmq topic.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    The id of rocketmq instance.
    rocketmqTopics List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    messageType Number
    The type of the rocketmq message.
    nameRegex String
    outputFile String
    topicName String
    The name of the rocketmq topic.

    Supporting Types

    GetTopicsRocketmqTopic

    AccessPolicies List<GetTopicsRocketmqTopicAccessPolicy>
    The access policies of the rocketmq topic.
    CreateTime string
    The create time of the rocketmq topic.
    Description string
    The description of the rocketmq topic.
    Groups List<GetTopicsRocketmqTopicGroup>
    The groups information of the rocketmq topic.
    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    QueueNumber int
    The number of the rocketmq topic queue.
    Queues List<GetTopicsRocketmqTopicQueue>
    The queues information of the rocketmq topic.
    TopicName string
    The name of the rocketmq topic. This field support fuzzy query.
    AccessPolicies []GetTopicsRocketmqTopicAccessPolicy
    The access policies of the rocketmq topic.
    CreateTime string
    The create time of the rocketmq topic.
    Description string
    The description of the rocketmq topic.
    Groups []GetTopicsRocketmqTopicGroup
    The groups information of the rocketmq topic.
    InstanceId string
    The id of rocketmq instance.
    MessageType int
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    QueueNumber int
    The number of the rocketmq topic queue.
    Queues []GetTopicsRocketmqTopicQueue
    The queues information of the rocketmq topic.
    TopicName string
    The name of the rocketmq topic. This field support fuzzy query.
    accessPolicies List<GetTopicsRocketmqTopicAccessPolicy>
    The access policies of the rocketmq topic.
    createTime String
    The create time of the rocketmq topic.
    description String
    The description of the rocketmq topic.
    groups List<GetTopicsRocketmqTopicGroup>
    The groups information of the rocketmq topic.
    instanceId String
    The id of rocketmq instance.
    messageType Integer
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    queueNumber Integer
    The number of the rocketmq topic queue.
    queues List<GetTopicsRocketmqTopicQueue>
    The queues information of the rocketmq topic.
    topicName String
    The name of the rocketmq topic. This field support fuzzy query.
    accessPolicies GetTopicsRocketmqTopicAccessPolicy[]
    The access policies of the rocketmq topic.
    createTime string
    The create time of the rocketmq topic.
    description string
    The description of the rocketmq topic.
    groups GetTopicsRocketmqTopicGroup[]
    The groups information of the rocketmq topic.
    instanceId string
    The id of rocketmq instance.
    messageType number
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    queueNumber number
    The number of the rocketmq topic queue.
    queues GetTopicsRocketmqTopicQueue[]
    The queues information of the rocketmq topic.
    topicName string
    The name of the rocketmq topic. This field support fuzzy query.
    access_policies Sequence[GetTopicsRocketmqTopicAccessPolicy]
    The access policies of the rocketmq topic.
    create_time str
    The create time of the rocketmq topic.
    description str
    The description of the rocketmq topic.
    groups Sequence[GetTopicsRocketmqTopicGroup]
    The groups information of the rocketmq topic.
    instance_id str
    The id of rocketmq instance.
    message_type int
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    queue_number int
    The number of the rocketmq topic queue.
    queues Sequence[GetTopicsRocketmqTopicQueue]
    The queues information of the rocketmq topic.
    topic_name str
    The name of the rocketmq topic. This field support fuzzy query.
    accessPolicies List<Property Map>
    The access policies of the rocketmq topic.
    createTime String
    The create time of the rocketmq topic.
    description String
    The description of the rocketmq topic.
    groups List<Property Map>
    The groups information of the rocketmq topic.
    instanceId String
    The id of rocketmq instance.
    messageType Number
    The type of the rocketmq message. Setting this parameter means filtering the Topic list based on the specified message type. The value explanation is as follows: 0: Regular message 1: Transaction message 2: Partition order message 3: Global sequential message 4: Delay message.
    queueNumber Number
    The number of the rocketmq topic queue.
    queues List<Property Map>
    The queues information of the rocketmq topic.
    topicName String
    The name of the rocketmq topic. This field support fuzzy query.

    GetTopicsRocketmqTopicAccessPolicy

    AccessKey string
    The access key of the rocketmq key.
    Authority string
    The authority of the rocketmq key for the current topic.
    AccessKey string
    The access key of the rocketmq key.
    Authority string
    The authority of the rocketmq key for the current topic.
    accessKey String
    The access key of the rocketmq key.
    authority String
    The authority of the rocketmq key for the current topic.
    accessKey string
    The access key of the rocketmq key.
    authority string
    The authority of the rocketmq key for the current topic.
    access_key str
    The access key of the rocketmq key.
    authority str
    The authority of the rocketmq key for the current topic.
    accessKey String
    The access key of the rocketmq key.
    authority String
    The authority of the rocketmq key for the current topic.

    GetTopicsRocketmqTopicGroup

    GroupId string
    The id of the rocketmq group.
    MessageModel string
    The message model of the rocketmq group.
    SubString string
    The sub string of the rocketmq group.
    GroupId string
    The id of the rocketmq group.
    MessageModel string
    The message model of the rocketmq group.
    SubString string
    The sub string of the rocketmq group.
    groupId String
    The id of the rocketmq group.
    messageModel String
    The message model of the rocketmq group.
    subString String
    The sub string of the rocketmq group.
    groupId string
    The id of the rocketmq group.
    messageModel string
    The message model of the rocketmq group.
    subString string
    The sub string of the rocketmq group.
    group_id str
    The id of the rocketmq group.
    message_model str
    The message model of the rocketmq group.
    sub_string str
    The sub string of the rocketmq group.
    groupId String
    The id of the rocketmq group.
    messageModel String
    The message model of the rocketmq group.
    subString String
    The sub string of the rocketmq group.

    GetTopicsRocketmqTopicQueue

    EndOffset int
    The end offset of the rocketmq queue.
    LastUpdateTimestamp int
    The last update timestamp of the rocketmq queue.
    MessageCount int
    The message count of the rocketmq queue.
    QueueId string
    The id of the rocketmq queue.
    StartOffset int
    The start offset of the rocketmq queue.
    EndOffset int
    The end offset of the rocketmq queue.
    LastUpdateTimestamp int
    The last update timestamp of the rocketmq queue.
    MessageCount int
    The message count of the rocketmq queue.
    QueueId string
    The id of the rocketmq queue.
    StartOffset int
    The start offset of the rocketmq queue.
    endOffset Integer
    The end offset of the rocketmq queue.
    lastUpdateTimestamp Integer
    The last update timestamp of the rocketmq queue.
    messageCount Integer
    The message count of the rocketmq queue.
    queueId String
    The id of the rocketmq queue.
    startOffset Integer
    The start offset of the rocketmq queue.
    endOffset number
    The end offset of the rocketmq queue.
    lastUpdateTimestamp number
    The last update timestamp of the rocketmq queue.
    messageCount number
    The message count of the rocketmq queue.
    queueId string
    The id of the rocketmq queue.
    startOffset number
    The start offset of the rocketmq queue.
    end_offset int
    The end offset of the rocketmq queue.
    last_update_timestamp int
    The last update timestamp of the rocketmq queue.
    message_count int
    The message count of the rocketmq queue.
    queue_id str
    The id of the rocketmq queue.
    start_offset int
    The start offset of the rocketmq queue.
    endOffset Number
    The end offset of the rocketmq queue.
    lastUpdateTimestamp Number
    The last update timestamp of the rocketmq queue.
    messageCount Number
    The message count of the rocketmq queue.
    queueId String
    The id of the rocketmq queue.
    startOffset Number
    The start offset of the rocketmq queue.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate