All Products
Search

This Product

    DataHub:GetSubscription

    Document Center

    DataHub:GetSubscription

    Last Updated:Sep 10, 2026

    Queries subscription information.

    Operation description

    Queries subscription information.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dhs:GetSubscription

    get

    *Subscription

    acs:dhs:{#regionId}:{#accountId}:projects/{#ProjectName}/topics/{#TopicName}/subscriptions/{#SubscriptionId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProjectName

    string

    Yes

    The project name.

    test_project
    TopicName

    string

    Yes

    The topic name.

    test_topic
    SubscriptionId

    string

    Yes

    The subscription ID.

    1764122860063VIIZ2

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    A20A7093-8FE0-058C-BE0C-3C8057D5F1A1
    Success

    boolean

    Indicates whether the request was successful.

    True
    ProjectName

    string

    The project name.

    test_project
    TopicName

    string

    The topic name.

    test_topic

    SubscriptionId

    string

    The subscription ID.

    1741072334529RFEF7
    Type

    string

    The subscription type. Valid values:

    • USER: created by the user.

    • SYSTEM: created by the system.

    USER
    State

    integer

    The subscription status. Valid values:

    • 0: offline.

    • 1: online.

    1
    Comment

    string

    The subscription description.

    test_comment
    Application

    string

    The name of the application to which the subscription belongs.

    test_application_name
    Creator

    string

    The creator of the subscription.

    1559031978056215
    CreateTime

    integer

    The creation time.

    1724041098000
    UpdateTime

    integer

    The last update time.

    1724041098000

    Examples

    Success response

    JSON format

    {
  "RequestId": "A20A7093-8FE0-058C-BE0C-3C8057D5F1A1",
  "Success": true,
  "ProjectName": "test_project",
  "TopicName": "test_topic\n",
  "SubscriptionId": "1741072334529RFEF7",
  "Type": "USER",
  "State": 1,
  "Comment": "test_comment",
  "Application": "test_application_name",
  "Creator": "1559031978056215",
  "CreateTime": 1724041098000,
  "UpdateTime": 1724041098000
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParameter Error:%s. The parameter entered is illegal
    400 MissingParameter Error:%s. Missing required parameters
    500 InternalServerError Error:%s. Server error, server unavailable or unexpected error occurred
    403 NoPermission Error:%s. You are not authorized to perform this operation.
    403 OperationDenied Error:%s. Operation denied
    404 ResourceNotFound Error:%s. Resource does not exist

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.