Search Topology¶

Get the basic information of on-site topologies.

Operation Permissions¶

Before invoking this API, ensure that the service account has been authorized the policy that includes the following service(s) and action permission(s). For how to authorize the service account, see Managing Service Accounts.

Required Policy	Required Permission
Device Management	Read
Asset Tree Administrator	Read

Before You Start¶

The OU has been bounded with an OU template and the OU template has been assigned at least one topology rule.

Request Format¶

POST https://{apigw-address}/amc/v1.0/topology?action=search

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	The organization ID which the topology belongs to. How to get orgId>>
siteAssetId	Query	Optional	String	The asset ID of the site. `topologyRootId` will be ignored if `siteAssetId` is used.
topologyRootId	Query	Optional	String	The list of the topology with the incoming asset ID as the top node. If blank, `siteAssetId` must be used and get all the topology lists on the site.
topologyRuleId	Query	Optional	String	The identifier of the topology rule.

Response Parameters¶

Name	Data Type	Description
data	TopologyInfo Struct Array	The information of the topology.

TopologyInfo Struct¶

Name	Data Type	Description
topologyId	String	The identifier of the topology.
topologyRuleId	String	The identifier of the topology rule.

Error Codes¶

Code	Message	Description
99500	Internal server error	Internal server error. Contact EnOS support.

Samples¶

Request Sample¶

URL: https://{apigw-address}/amc/v1.0/topology?action=search&orgId=yourOrgId&siteAssetId=yourSiteAssetId

method: POST

Response Sample¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "05acbed9-5288-4183-88f4-da300dd54874",
    "data": [{
        "topologyId": "LyQOvJa3/HnfxM8Rc",
        "topologyRuleIdentifier":"Solar_SoilingGroup"
    }]
}