1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getTcmqSubscribe
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.getTcmqSubscribe

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Use this data source to query detailed information of tcmq subscribe

    Using getTcmqSubscribe

    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 getTcmqSubscribe(args: GetTcmqSubscribeArgs, opts?: InvokeOptions): Promise<GetTcmqSubscribeResult>
    function getTcmqSubscribeOutput(args: GetTcmqSubscribeOutputArgs, opts?: InvokeOptions): Output<GetTcmqSubscribeResult>
    def get_tcmq_subscribe(id: Optional[str] = None,
                           limit: Optional[float] = None,
                           offset: Optional[float] = None,
                           result_output_file: Optional[str] = None,
                           subscription_name: Optional[str] = None,
                           topic_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetTcmqSubscribeResult
    def get_tcmq_subscribe_output(id: Optional[pulumi.Input[str]] = None,
                           limit: Optional[pulumi.Input[float]] = None,
                           offset: Optional[pulumi.Input[float]] = None,
                           result_output_file: Optional[pulumi.Input[str]] = None,
                           subscription_name: Optional[pulumi.Input[str]] = None,
                           topic_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetTcmqSubscribeResult]
    func LookupTcmqSubscribe(ctx *Context, args *LookupTcmqSubscribeArgs, opts ...InvokeOption) (*LookupTcmqSubscribeResult, error)
    func LookupTcmqSubscribeOutput(ctx *Context, args *LookupTcmqSubscribeOutputArgs, opts ...InvokeOption) LookupTcmqSubscribeResultOutput

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

    public static class GetTcmqSubscribe 
    {
        public static Task<GetTcmqSubscribeResult> InvokeAsync(GetTcmqSubscribeArgs args, InvokeOptions? opts = null)
        public static Output<GetTcmqSubscribeResult> Invoke(GetTcmqSubscribeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTcmqSubscribeResult> getTcmqSubscribe(GetTcmqSubscribeArgs args, InvokeOptions options)
    public static Output<GetTcmqSubscribeResult> getTcmqSubscribe(GetTcmqSubscribeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getTcmqSubscribe:getTcmqSubscribe
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TopicName string
    Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    Id string
    Limit double
    Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
    Offset double
    Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default.
    ResultOutputFile string
    Used to save results.
    SubscriptionName string
    Fuzzy search by SubscriptionName.
    TopicName string
    Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    Id string
    Limit float64
    Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
    Offset float64
    Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default.
    ResultOutputFile string
    Used to save results.
    SubscriptionName string
    Fuzzy search by SubscriptionName.
    topicName String
    Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id String
    limit Double
    Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
    offset Double
    Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default.
    resultOutputFile String
    Used to save results.
    subscriptionName String
    Fuzzy search by SubscriptionName.
    topicName string
    Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id string
    limit number
    Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
    offset number
    Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default.
    resultOutputFile string
    Used to save results.
    subscriptionName string
    Fuzzy search by SubscriptionName.
    topic_name str
    Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id str
    limit float
    Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
    offset float
    Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default.
    result_output_file str
    Used to save results.
    subscription_name str
    Fuzzy search by SubscriptionName.
    topicName String
    Topic name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id String
    limit Number
    Number of topics to be returned per page in case of paginated return. If this parameter is not passed in, 20 will be used by default. Maximum value: 50.
    offset Number
    Starting position of the list of topics to be returned on the current page in case of paginated return. If a value is entered, limit is required. If this parameter is left empty, 0 will be used by default.
    resultOutputFile String
    Used to save results.
    subscriptionName String
    Fuzzy search by SubscriptionName.

    getTcmqSubscribe Result

    The following output properties are available:

    Id string
    SubscriptionLists List<GetTcmqSubscribeSubscriptionList>
    Set of subscription attributes.
    TopicName string
    Limit double
    Offset double
    ResultOutputFile string
    SubscriptionName string
    Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    Id string
    SubscriptionLists []GetTcmqSubscribeSubscriptionList
    Set of subscription attributes.
    TopicName string
    Limit float64
    Offset float64
    ResultOutputFile string
    SubscriptionName string
    Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id String
    subscriptionLists List<GetTcmqSubscribeSubscriptionList>
    Set of subscription attributes.
    topicName String
    limit Double
    offset Double
    resultOutputFile String
    subscriptionName String
    Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id string
    subscriptionLists GetTcmqSubscribeSubscriptionList[]
    Set of subscription attributes.
    topicName string
    limit number
    offset number
    resultOutputFile string
    subscriptionName string
    Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id str
    subscription_lists Sequence[GetTcmqSubscribeSubscriptionList]
    Set of subscription attributes.
    topic_name str
    limit float
    offset float
    result_output_file str
    subscription_name str
    Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.
    id String
    subscriptionLists List<Property Map>
    Set of subscription attributes.
    topicName String
    limit Number
    offset Number
    resultOutputFile String
    subscriptionName String
    Subscription name, which must be unique in the same topic under the same account in the same region. It can contain up to 64 letters, digits, and hyphens and must begin with a letter.

    Supporting Types

    GetTcmqSubscribeSubscriptionList

    BindingKeys List<string>
    Filtering policy for subscribing to and receiving messages.
    CreateTime double
    Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned.
    Endpoint string
    Endpoint that receives notifications, which varies by protocol: for HTTP, the endpoint must start with http://, and the host can be a domain or IP; for queue, queueName should be entered.
    FilterTags List<string>
    Filtering policy selected when a subscription is created:If filterType is 1, filterTag will be used for filtering. If filterType is 2, bindingKey will be used for filtering.
    LastModifyTime double
    Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
    MsgCount double
    Number of messages to be delivered in the subscription.
    NotifyContentFormat string
    Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If Protocol is queue, this value must be SIMPLIFIED. If Protocol is http, both options are acceptable, and the default value is JSON.
    NotifyStrategy string
    CMQ push server retry policy in case an error occurs while pushing a message to Endpoint. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY.
    Protocol string
    Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently.
    SubscriptionId string
    Subscription ID, which will be used during monitoring data pull.
    SubscriptionName string
    Fuzzy search by SubscriptionName.
    TopicOwner double
    Subscription owner APPID.
    BindingKeys []string
    Filtering policy for subscribing to and receiving messages.
    CreateTime float64
    Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned.
    Endpoint string
    Endpoint that receives notifications, which varies by protocol: for HTTP, the endpoint must start with http://, and the host can be a domain or IP; for queue, queueName should be entered.
    FilterTags []string
    Filtering policy selected when a subscription is created:If filterType is 1, filterTag will be used for filtering. If filterType is 2, bindingKey will be used for filtering.
    LastModifyTime float64
    Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
    MsgCount float64
    Number of messages to be delivered in the subscription.
    NotifyContentFormat string
    Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If Protocol is queue, this value must be SIMPLIFIED. If Protocol is http, both options are acceptable, and the default value is JSON.
    NotifyStrategy string
    CMQ push server retry policy in case an error occurs while pushing a message to Endpoint. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY.
    Protocol string
    Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently.
    SubscriptionId string
    Subscription ID, which will be used during monitoring data pull.
    SubscriptionName string
    Fuzzy search by SubscriptionName.
    TopicOwner float64
    Subscription owner APPID.
    bindingKeys List<String>
    Filtering policy for subscribing to and receiving messages.
    createTime Double
    Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned.
    endpoint String
    Endpoint that receives notifications, which varies by protocol: for HTTP, the endpoint must start with http://, and the host can be a domain or IP; for queue, queueName should be entered.
    filterTags List<String>
    Filtering policy selected when a subscription is created:If filterType is 1, filterTag will be used for filtering. If filterType is 2, bindingKey will be used for filtering.
    lastModifyTime Double
    Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
    msgCount Double
    Number of messages to be delivered in the subscription.
    notifyContentFormat String
    Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If Protocol is queue, this value must be SIMPLIFIED. If Protocol is http, both options are acceptable, and the default value is JSON.
    notifyStrategy String
    CMQ push server retry policy in case an error occurs while pushing a message to Endpoint. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY.
    protocol String
    Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently.
    subscriptionId String
    Subscription ID, which will be used during monitoring data pull.
    subscriptionName String
    Fuzzy search by SubscriptionName.
    topicOwner Double
    Subscription owner APPID.
    bindingKeys string[]
    Filtering policy for subscribing to and receiving messages.
    createTime number
    Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned.
    endpoint string
    Endpoint that receives notifications, which varies by protocol: for HTTP, the endpoint must start with http://, and the host can be a domain or IP; for queue, queueName should be entered.
    filterTags string[]
    Filtering policy selected when a subscription is created:If filterType is 1, filterTag will be used for filtering. If filterType is 2, bindingKey will be used for filtering.
    lastModifyTime number
    Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
    msgCount number
    Number of messages to be delivered in the subscription.
    notifyContentFormat string
    Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If Protocol is queue, this value must be SIMPLIFIED. If Protocol is http, both options are acceptable, and the default value is JSON.
    notifyStrategy string
    CMQ push server retry policy in case an error occurs while pushing a message to Endpoint. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY.
    protocol string
    Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently.
    subscriptionId string
    Subscription ID, which will be used during monitoring data pull.
    subscriptionName string
    Fuzzy search by SubscriptionName.
    topicOwner number
    Subscription owner APPID.
    binding_keys Sequence[str]
    Filtering policy for subscribing to and receiving messages.
    create_time float
    Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned.
    endpoint str
    Endpoint that receives notifications, which varies by protocol: for HTTP, the endpoint must start with http://, and the host can be a domain or IP; for queue, queueName should be entered.
    filter_tags Sequence[str]
    Filtering policy selected when a subscription is created:If filterType is 1, filterTag will be used for filtering. If filterType is 2, bindingKey will be used for filtering.
    last_modify_time float
    Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
    msg_count float
    Number of messages to be delivered in the subscription.
    notify_content_format str
    Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If Protocol is queue, this value must be SIMPLIFIED. If Protocol is http, both options are acceptable, and the default value is JSON.
    notify_strategy str
    CMQ push server retry policy in case an error occurs while pushing a message to Endpoint. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY.
    protocol str
    Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently.
    subscription_id str
    Subscription ID, which will be used during monitoring data pull.
    subscription_name str
    Fuzzy search by SubscriptionName.
    topic_owner float
    Subscription owner APPID.
    bindingKeys List<String>
    Filtering policy for subscribing to and receiving messages.
    createTime Number
    Subscription creation time. A Unix timestamp accurate down to the millisecond will be returned.
    endpoint String
    Endpoint that receives notifications, which varies by protocol: for HTTP, the endpoint must start with http://, and the host can be a domain or IP; for queue, queueName should be entered.
    filterTags List<String>
    Filtering policy selected when a subscription is created:If filterType is 1, filterTag will be used for filtering. If filterType is 2, bindingKey will be used for filtering.
    lastModifyTime Number
    Time when the subscription attribute is last modified. A Unix timestamp accurate down to the millisecond will be returned.
    msgCount Number
    Number of messages to be delivered in the subscription.
    notifyContentFormat String
    Push content format. Valid values: 1. JSON; 2. SIMPLIFIED, i.e., the raw format. If Protocol is queue, this value must be SIMPLIFIED. If Protocol is http, both options are acceptable, and the default value is JSON.
    notifyStrategy String
    CMQ push server retry policy in case an error occurs while pushing a message to Endpoint. Valid values: 1. BACKOFF_RETRY: backoff retry, which is to retry at a fixed interval, discard the message after a certain number of retries, and continue to push the next message; 2. EXPONENTIAL_DECAY_RETRY: exponential decay retry, which is to retry at an exponentially increasing interval, such as 1s, 2s, 4s, 8s, and so on. As a message can be retained in a topic for one day, failed messages will be discarded at most after one day of retry. Default value: EXPONENTIAL_DECAY_RETRY.
    protocol String
    Subscription protocol. Currently, two protocols are supported: HTTP and queue. To use the HTTP protocol, you need to build your own web server to receive messages. With the queue protocol, messages are automatically pushed to a CMQ queue and you can pull them concurrently.
    subscriptionId String
    Subscription ID, which will be used during monitoring data pull.
    subscriptionName String
    Fuzzy search by SubscriptionName.
    topicOwner Number
    Subscription owner APPID.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack