Fetch Job-Associated VM Details

Details

API Details
NameFetch Job-Associated VM Details
DescriptionFetch the VM details for the specified job.
MethodGET
URI
  • /v1/jobs/jobId/nodes
  • /v1/jobs/jobId/nodes?syncFromCloud=value
CloudCenter Release
  • CloudCenter 3.x and 4.x
  • Enhanced in CloudCenter 3.2.6.9 to include the syncFromCloud attribute.

NotesFor additional context on <PORT> usage in the following example(s), see Base URI Format.
ESB Header
  • action: get.jobs.jobId.nodes
  • action: get.jobs.jobId.nodes
    actionparam: syncFromCloud=value

Example 1

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://10.10.100.10/v1/jobs/936/nodes" 

Response

{
    "nodes": [
        {
            "serviceTierId": "UCSD_Workflows-136",
            "virtualMachines": [
                {
                    "id": "DiscoveryCIFS@admin_cifs@10.22.32.155@dsc-cifs1-p001@cifsvol1@testcliqr1003",
                    "resource": "https://10.10.100.10/v1/virtualmachines/DiscoveryCIFS@admin_cifs@10.12.12.15@dsc-cifs1-p001@cifsvol1@testcliqr1003/metrics?jobId=937",
                    "perms": [],
                    "publicIp": "n/a",
                    "privateIp": "n/a",
                    "hostName": "n/a",
                    "status": "NodeReady",
                    "startTime": "2015-04-16 19:58:43.0",
                    "endTime": null,
                    "additionalInfo": []
                }
            ]
        }
    ],
    "size": 1
} 

Example 2

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://10.10.100.10/v1/jobs/936/nodes?syncFromCloud=true" 

Response

{
    "nodes": [
        {
            "serviceTierId": "UCSD_Workflows-136",
            "virtualMachines": [
                {
                    "id": "DiscoveryCIFS@admin_cifs@10.22.32.155@dsc-cifs1-p001@cifsvol1@testcliqr1003",
                    "resource": "https://10.10.100.10/v1/virtualmachines/DiscoveryCIFS@admin_cifs@10.12.12.15@dsc-cifs1-p001@cifsvol1@testcliqr1003/metrics?jobId=937",
                    "perms": [],
                    "publicIp": "n/a",
                    "privateIp": "n/a",
                    "hostName": "n/a",
                    "status": "NodeReady",
                    "startTime": "2015-04-16 19:58:43.0",
                    "endTime": null,
                    "additionalInfo": [
                        {
                            "name": "diskused",
                            "value": "0.00"
                        },
                        {
                            "name": "allocated",
                            "value": "10.49"
                        },
                        {
                            "name": "percentused",
                            "value": "0.00"
                        },
                        {
                            "name": "access-list",
                            "value": "[{'entity': 'bcmsvc_cliqr', 'permissions': 'full_control'}]"
                        }
                    ]
                }
            ]
        }
    ],
    "size": 1
}

Request Attributes

jobId
  • DescriptionUnique, system-generated identifier for the job
  • Type: String
syncFromCloud
  • Description: Configures synchronization of the latest VM information (for all job VMs) from the cloud.
  • Type: Boolean
    • true = enables synchronization from the cloud
    • false = disables synchronization from the cloud

Response Attributes

nodes

serviceTierId
  • Description:

    Type of application tier (for example, Loadbalancer, database, AppCluster, or other tiers). This value is a concatenation of the Application Profile Type Name and the App ID.

    • First job serviceTierId = appName + "-" +appId
    • Child tier serviceTierId = tierName + "-" +appId
  • Type: String
virtualMachines
id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
perms (click for additional details)
publicIpAddr
  • Description: Public IP address of the application VM or CCO. This attribute is the same as the publicIp or publicIpAddress attributes.
  • Type: String
privateIpAddr
  • Description: Private IP address of the application VM or CCO. This attribute is the same as the privateIp attribute.
  • Type: String
hostName
  • Description: The DNS host name for this VM 
  • Type: String
status
  • Description: Status of the operation
  • Type: String
startTime
endTime
  • DescriptionEnd time for this VM
  • Type: Long
additionalInfo (click for additional details)

size
  • Description: Total number of records that any list page should contain. The default is: 

    • v1 APIs = 20 records

    • v2 APIs:

      • Prior to 4.8.0: All elements are returned and the page value is ignored.

      • Effective 4.8.0: 50 records
  • Type: Integer