volcenginecc.rocketmq.getTopic

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getTopic

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 getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>

def get_topic(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]

func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput

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

public static class GetTopic 
{
    public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
public static Output<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:rocketmq/getTopic:getTopic
  arguments:
    # arguments dictionary

The 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.

getTopic Result

The following output properties are available:

AccessPolicies List<Volcengine.GetTopicAccessPolicy>: Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.
CreatedTime string: Topic creation time.
Description string: Topic description, length: 0–128 characters.
GroupsInfos List<Volcengine.GetTopicGroupsInfo>: Consumer group information list.
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID.
InstanceName string: Instance name.
MessageType int: Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
QueueNumber int: Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
QueuesInfos List<Volcengine.GetTopicQueuesInfo>: Queue information list.
ReadAccessPolicies List<Volcengine.GetTopicReadAccessPolicy>: Permissions for each RocketMQ key on the current Topic, permission field
ServiceStatus string: Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
TopicName string: Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

AccessPolicies []GetTopicAccessPolicy: Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.
CreatedTime string: Topic creation time.
Description string: Topic description, length: 0–128 characters.
GroupsInfos []GetTopicGroupsInfo: Consumer group information list.
Id string: Uniquely identifies the resource.
InstanceId string: Instance ID.
InstanceName string: Instance name.
MessageType int: Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
QueueNumber int: Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
QueuesInfos []GetTopicQueuesInfo: Queue information list.
ReadAccessPolicies []GetTopicReadAccessPolicy: Permissions for each RocketMQ key on the current Topic, permission field
ServiceStatus string: Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
TopicName string: Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

accessPolicies List<GetTopicAccessPolicy>: Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.
createdTime String: Topic creation time.
description String: Topic description, length: 0–128 characters.
groupsInfos List<GetTopicGroupsInfo>: Consumer group information list.
id String: Uniquely identifies the resource.
instanceId String: Instance ID.
instanceName String: Instance name.
messageType Integer: Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
queueNumber Integer: Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
queuesInfos List<GetTopicQueuesInfo>: Queue information list.
readAccessPolicies List<GetTopicReadAccessPolicy>: Permissions for each RocketMQ key on the current Topic, permission field
serviceStatus String: Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
topicName String: Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

accessPolicies GetTopicAccessPolicy[]: Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.
createdTime string: Topic creation time.
description string: Topic description, length: 0–128 characters.
groupsInfos GetTopicGroupsInfo[]: Consumer group information list.
id string: Uniquely identifies the resource.
instanceId string: Instance ID.
instanceName string: Instance name.
messageType number: Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
queueNumber number: Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
queuesInfos GetTopicQueuesInfo[]: Queue information list.
readAccessPolicies GetTopicReadAccessPolicy[]: Permissions for each RocketMQ key on the current Topic, permission field
serviceStatus string: Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
topicName string: Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

access_policies Sequence[GetTopicAccessPolicy]: Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.
created_time str: Topic creation time.
description str: Topic description, length: 0–128 characters.
groups_infos Sequence[GetTopicGroupsInfo]: Consumer group information list.
id str: Uniquely identifies the resource.
instance_id str: Instance ID.
instance_name str: Instance name.
message_type int: Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
queue_number int: Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
queues_infos Sequence[GetTopicQueuesInfo]: Queue information list.
read_access_policies Sequence[GetTopicReadAccessPolicy]: Permissions for each RocketMQ key on the current Topic, permission field
service_status str: Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
topic_name str: Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

accessPolicies List<Property Map>: Permissions for each RocketMQ key on the current Topic, supports batch permission settings. If not set, each key retains its default permissions for the current Topic.
createdTime String: Topic creation time.
description String: Topic description, length: 0–128 characters.
groupsInfos List<Property Map>: Consumer group information list.
id String: Uniquely identifies the resource.
instanceId String: Instance ID.
instanceName String: Instance name.
messageType Number: Message type. Set this parameter to filter the Topic list by the specified message type. Value description: 0: Normal message. 1: Transaction message. 2: Partitioned ordered message. 3: Globally ordered message. 4: Delayed message.
queueNumber Number: Set the number of queues for the current Topic. The maximum cannot exceed the remaining available queues for the current instance. For queue limits per instance specification, refer to the product specifications. When creating a Topic in a 4.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the queue number depends on the compute specification. For n3 and below, the default is 6; for above n3, the default is twice the number of broker groups. It is recommended to set the queue number as a multiple of the number of compute nodes to avoid data imbalance across Brokers. For example, for the rocketmq.n3.x2.medium specification with 3 compute nodes, set the queue number to a multiple of 3, such as 3, 6, or 9. When creating a Topic in a 5.x version instance, set the number of queues as follows: For globally ordered Topics, the default queue number is 1. For other Topic types, the default is twice the number of broker groups. In non-ordered scenarios, performance is not affected by the number of queues; more queues only improve concurrent performance for ordered consumption.
queuesInfos List<Property Map>: Queue information list.
readAccessPolicies List<Property Map>: Permissions for each RocketMQ key on the current Topic, permission field
serviceStatus String: Service status. Creating: being created, Running: running, Deleting: being deleted, Abnormal: abnormal, Updating: being updated.
topicName String: Topic name. Naming rules: Length must be 3–100 characters. Only English letters, numbers, hyphens (-), and underscores () are allowed. Topic names cannot contain the following reserved characters or special prefixes. Reserved characters: RMQSYSTRANSOPHALFTOPIC, BenchmarkTest, TBW102, OFFSETMOVEDEVENT, SELFTESTTOPIC, RMQSYSTRANSHALFTOPIC, SCHEDULETOPICXXXX, RMQSYSTRACETOPIC. Special prefixes: rocketmq-broker-, %RETRY%, rmqsys_, %DLQ%.

Supporting Types

GetTopicAccessPolicy

AccessKey string: AccessKey of the RocketMQ key.
Authority string: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

AccessKey string: AccessKey of the RocketMQ key.
Authority string: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

accessKey String: AccessKey of the RocketMQ key.
authority String: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

accessKey string: AccessKey of the RocketMQ key.
authority string: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

access_key str: AccessKey of the RocketMQ key.
authority str: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

accessKey String: AccessKey of the RocketMQ key.
authority String: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

GetTopicGroupsInfo

GroupId string: Group ID of the consumer group.
MessageModel string: Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
SubString string: Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

GroupId string: Group ID of the consumer group.
MessageModel string: Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
SubString string: Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

groupId String: Group ID of the consumer group.
messageModel String: Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
subString String: Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

groupId string: Group ID of the consumer group.
messageModel string: Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
subString string: Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

group_id str: Group ID of the consumer group.
message_model str: Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
sub_string str: Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

groupId String: Group ID of the consumer group.
messageModel String: Consumption mode. The values are as follows: Clustering: cluster consumption mode. Broadcasting: broadcast consumption mode.
subString String: Subscription rule. This field contains the exact string specified by the consumer group when subscribing to this Topic, usually * or TAG1 || TAG2.

GetTopicQueuesInfo

EndOffset int: The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
LastUpdateTimestamp int: The time of the most recent message written to this queue.
MessageCount int: The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
QueueId string: Queue ID.
StartOffset int: The earliest message offset in the current queue.

EndOffset int: The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
LastUpdateTimestamp int: The time of the most recent message written to this queue.
MessageCount int: The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
QueueId string: Queue ID.
StartOffset int: The earliest message offset in the current queue.

endOffset Integer: The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
lastUpdateTimestamp Integer: The time of the most recent message written to this queue.
messageCount Integer: The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
queueId String: Queue ID.
startOffset Integer: The earliest message offset in the current queue.

endOffset number: The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
lastUpdateTimestamp number: The time of the most recent message written to this queue.
messageCount number: The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
queueId string: Queue ID.
startOffset number: The earliest message offset in the current queue.

end_offset int: The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
last_update_timestamp int: The time of the most recent message written to this queue.
message_count int: The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
queue_id str: Queue ID.
start_offset int: The earliest message offset in the current queue.

endOffset Number: The maximum offset of the current queue, which is the offset of the next message. The position of the latest message is EndOffset - 1.
lastUpdateTimestamp Number: The time of the most recent message written to this queue.
messageCount Number: The number of messages in the current queue. EndOffset is the offset of the next message, so MessageCount = EndOffset - StartOffset.
queueId String: Queue ID.
startOffset Number: The earliest message offset in the current queue.

GetTopicReadAccessPolicy

AccessKey string: AccessKey of the RocketMQ key.
Authority string: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

AccessKey string: AccessKey of the RocketMQ key.
Authority string: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

accessKey String: AccessKey of the RocketMQ key.
authority String: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

accessKey string: AccessKey of the RocketMQ key.
authority string: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

access_key str: AccessKey of the RocketMQ key.
authority str: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.

accessKey String: AccessKey of the RocketMQ key.
authority String: User access permissions for the current Topic. ALL: Publish and subscribe permissions. PUB: Publish permission. SUB: Subscribe permission. DENY: No publish or subscribe permissions.