tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
TDMQ for Apache Pulsar
    Documentation
    Download PDF

    DescribeCmqSubscriptionDetail

    Last updated: 2023-08-09 14:43:35
    Download PDF

    1. API Description

    Domain name for API request: tdmq.tencentcloudapi.com.

    This API is used to query the CMQ subscription details.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeCmqSubscriptionDetail.
    Version Yes String Common Params. The value used for this API: 2020-02-17.
    Region No String Common Params. This parameter is not required for this API.
    TopicName Yes 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.
    Offset No Integer 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
    Limit No Integer 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.
    SubscriptionName No String Fuzzy search by SubscriptionName

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number
    SubscriptionSet Array of CmqSubscription Set of subscription attributes
    Note: this field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying subscription details

    Input Example

    https://tdmq.tencentcloudapi.com/?Action=DescribeCmqSubscriptionDetail
&TopicName=Conn
&<Common request parameters>

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "SubscriptionSet": [
            {
                "SubscriptionName": "ConnSub",
                "SubscriptionId": "subsc-8y7fn4t2",
                "TopicOwner": 0,
                "MsgCount": 0,
                "LastModifyTime": 1590632987,
                "CreateTime": 1590632987,
                "BindingKey": null,
                "Endpoint": "test1",
                "FilterTags": [],
                "Protocol": "queue",
                "NotifyStrategy": "EXPONENTIAL_DECAY_RETRY",
                "NotifyContentFormat": "SIMPLIFIED"
            }
        ],
        "RequestId": "72cd2d9d-d666-45ad-963a-cf5065a1984c"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.CmqBackendError CMQ backend error.
    ResourceNotFound.Topic The topic does not exist.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy