CloudInstances

Represents a paginated list of CloudInstance entities.

Properties

Field	Data type
`count`	`integer`
`nextHref`	`string`
`prevHref`	`string`
`href`	`string`
`cloudInstance`	`List<CloudInstance>`

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<cloudInstances count="123" href="string" nextHref="string" prevHref="string">
  <cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance>
</cloudInstances>

{
  "count" : 7,
  "cloudInstance" : [ {
    "image" : {
      "agentPoolId" : 1,
      "instances" : "[[[cloudInstances...|]]]",
      "agentTypeId" : 1,
      "webUrl" : "https://example.com/app/rest/cloudImage/3414",
      "profile" : "[[[cloudProfile...|cloudprofile.html]]]",
      "name" : "name",
      "errorMessage" : "errorMessage",
      "id" : "id",
      "href" : "href",
      "error" : "[[[cloudError...|clouderror.html]]]",
      "operatingSystemName" : "operatingSystemName",
      "locator" : "locator"
    },
    "agent" : {
      "disconnectionComment" : "Unregistered because of inactivity",
      "idleSinceTime" : "20240816T150655+0200",
      "enabledInfo" : "[[[enabledInfo...|enabledinfo.html]]]",
      "cpuRank" : 396,
      "enabled" : true,
      "compatibleBuildTypes" : "[[[buildTypes...|buildtypes.html]]]",
      "protocol" : "unidirectional",
      "outdated" : true,
      "authorized" : true,
      "host" : "ip-52-211-39-10.eu-west-1.compute.internal, localhost",
      "builds" : "[[[builds...|builds.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : 771,
      "href" : "/app/rest/agents/id:771",
      "cloudImage" : "[[[cloudImage...|cloudimage.html]]]",
      "authorizedInfo" : "[[[authorizedInfo...|authorizedinfo.html]]]",
      "incompatibleBuildTypes" : "[[[compatibilities...|compatibilities.html]]]",
      "uptodate" : false,
      "ip" : "52.211.39.100",
      "pool" : "[[[agentPool...|agentpool.html]]]",
      "cloudInstance" : "[[[cloudInstance...|cloudinstance.html]]]",
      "version" : "156364",
      "connected" : true,
      "currentAgentVersion" : "160569",
      "compatibilityPolicy" : "[[[compatibilityPolicy...|compatibilitypolicy.html]]]",
      "registrationTimestamp" : "20240816T150655+0200",
      "environment" : "[[[environment...|environment.html]]]",
      "pluginsOutdated" : false,
      "port" : 9090,
      "build" : "[[[build...|build.html]]]",
      "webUrl" : "https://example.com/agentDetails.html?id=771&agentTypeId=11389&realAgentName=db-win-2003",
      "name" : "Ubuntu-22.04-Large-i-045902939eae4af1a",
      "typeId" : 661,
      "lastActivityTime" : "20240816T151123+0200",
      "locator" : "locator",
      "properties" : "[[[properties...|properties.html]]]",
      "javaOutdated" : false
    },
    "name" : "name",
    "errorMessage" : "errorMessage",
    "id" : "id",
    "state" : "state",
    "href" : "href",
    "error" : {
      "detailedMessage" : "detailedMessage",
      "message" : "message"
    },
    "networkAddress" : "networkAddress",
    "startDate" : "startDate"
  } ],
  "prevHref" : "prevHref",
  "href" : "href",
  "nextHref" : "nextHref"
}

Last modified: 14 March 2025