Exploring an assembly instance

This topic describes how to use the orchestration component to see the assembly structure, and (optionally) the associated history of lifecycle transitions of a previously created assembly, in this case test_1.

Before you begin

You must create the example assembly instance called test_1, which is described in Creating an assembly instance.

About this task

To see the assembly structure and the history of lifecycle transitions, you explore the topology of the assembly instance by using the Assemblies API.

Procedure

Identify the name of the assembly instance from its assemblyName field, in this case test_1.

Query the assembly topology through the Assemblies API using the following GET command:

GET /api/v1/topology/assemblies

The following example depicts the GET request to obtain the topology of test_1.

GET /api/v1/topology/assemblies?name=test_1

This query results in the following response:

{
  "API-VERSION": "1.0.0",
  "type": "Assembly",
  "id": "ef4ea879-e313-4e3b-ad11-6a0a7e7544eb",
  "name": "test_1",
  "state": "Active",
  "descriptorName": "assembly::t_bta::1.0",
  "properties": [
    {
      "name": "numOfServers",
      "value": "1"
    },
    {
      "name": "data",
      "value": "data"
    },
    {
      "name": "deploymentLocation",
      "value": "admin@local"
    },
    {
      "name": "resourceManager",
      "value": "test-rm"
    }
  ],
  "createdAt": "2017-09-12T06:38:43.365+0000",
  "lastModifiedAt": "2017-09-12T06:38:45.514+0000",
  "children": [
    {
      "type": "Component",
      "id": "c903c6db-9a79-4248-b62b-fd11ec01efe0",
      "name": "test_1__A",
      "externalId": "72857624-ccb4-4cf2-8ebf-0ab05e67a5a5",
      "state": "Active",
      "descriptorName": "resource::t_simple::1.0",
      "properties": [
        {
          "name": "data",
          "value": "data"
...
  ]
}

This sample response displays the identity, status and structure of the assembly instance. The assembly instance has two child instances, test_1__A and test_1__B__1. The names are generated from the assembly name test_1 and the resource name from the t_bta descriptor. Resource B is in a scaling group, and each member of a scaling group is numbered. The relationship between the two resources can also be seen, as well as the references to resources used from the deploymentLocation property.