Obtaining Mesh Service Topology Data

This API is used to obtain the topology data of the associated service of a mesh service.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.
Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies
asm:mesh:getTopology

Read

mesh *

g:EnterpriseProjectId

g:ResourceTag/<tag-key>

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
asm:mesh:getTopology	Read	mesh *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	-	-

GET /api/namespaces/{namespace}/services/{service}/graph

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
namespace	Yes	String	Namespace of the associated service to be queried
service	Yes	String	Name of the associated service to be queried

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
duration	Yes	Integer	Time span of the obtained topology, in seconds
queryTime	Yes	String	Time point for obtaining the topology
graphType	Yes	String	Type of the obtained topology
metric	Yes	String	Metric to be displayed

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Mesh-ID	Yes	String	ID of the mesh whose topology needs to be obtained
X-Clusters-List	Yes	String	Cluster ID set, which is separated by commas (,)
Instance-Map	Yes	String	Instance information is separated by colons (:). This parameter can reduce the request response time. Example: Id:Region:Type:ProjectID

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
edges	Array of Edge objects	Edge data of the mesh application topology
nodes	Array of Node objects	Point data of the mesh application topology

**Table 5** Edge
Parameter	Type	Description
id	String	Mesh topology edge ID
source	String	Start node ID of the mesh topology edge
target	String	End node ID of the mesh topology edge
traffic	Traffic object	Traffic information of the connection represented by the mesh topology edge

**Table 6** Node
Parameter	Type	Description
id	String	ID of a topology node
parent	String	ID of the parent node of a composite node in the topology
nodeType	String	Type of a topology node
cluster	String	Cluster where a topology node is located
namespace	String	Namespace of a topology node
pod	String	Name of the service instance on a topology node
version	String	Version of a topology node
service	String	Service of a topology node
isBox	Boolean	Whether the topology node is a frame
traffic	Traffic object	Traffic of a topology node