Get topology relationship data

This API provides clients with comprehensive access to full topology relationship data, offering a detailed view of the interconnections between resources within a system. It facilitates seamless data synchronization and supports advanced topology visualization by enabling the extraction of key relationship details.

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

Query Parameters

  • pageSizeinteger

    Specifies the number of results to display per page, ranging from 1 to 500.

  • pageNointeger

    Specifies the page number to retrieve, such as 1.

  • relationstring

    Filters relationships based on specific types. Accepted values include: manages, managed by, contains, contained in, provides, initiates, powers, post data, receive data, uses, used by, hosts, consumes, impacts, defines, runs on, hosted on, supported by, depends, consumes, registered on, impacts, deps, topology, NetworkTopology, running, connects, memberof, associatewith, ClusterOf, belongsTo, attachedto, componentOf.

  • queryNodestring

    Specifies the resource node, such as resourceName:index-dev-4.

  • queryLinkstring

    Specifies a link using the internal application ID.

Responses

  • resultsarray

  • totalResultsinteger

  • pageNointeger

  • pageSizeinteger

  • totalPagesinteger

  • nextPageboolean

  • nextPageNointeger

  • descendingOrderboolean

Loading Examples...