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" : 1,
  "cloudInstance" : [ {
    "image" : {
      "agentPoolId" : 7,
      "instances" : "[[[cloudInstances...|]]]",
      "agentTypeId" : 5,
      "profile" : "[[[cloudProfile...|cloudprofile.html]]]",
      "name" : "name",
      "errorMessage" : "errorMessage",
      "id" : "id",
      "href" : "href",
      "operatingSystemName" : "operatingSystemName",
      "locator" : "locator"
    },
    "agent" : {
      "disconnectionComment" : "disconnectionComment",
      "idleSinceTime" : "idleSinceTime",
      "enabledInfo" : "[[[enabledInfo...|enabledinfo.html]]]",
      "cpuRank" : 2,
      "enabled" : true,
      "compatibleBuildTypes" : "[[[buildTypes...|buildtypes.html]]]",
      "protocol" : "unidirectional",
      "outdated" : true,
      "authorized" : true,
      "host" : "host",
      "builds" : "[[[builds...|builds.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : 0,
      "href" : "href",
      "cloudImage" : "[[[cloudImage...|cloudimage.html]]]",
      "authorizedInfo" : "[[[authorizedInfo...|authorizedinfo.html]]]",
      "incompatibleBuildTypes" : "[[[compatibilities...|compatibilities.html]]]",
      "uptodate" : true,
      "ip" : "ip",
      "pool" : "[[[agentPool...|agentpool.html]]]",
      "cloudInstance" : "[[[cloudInstance...|cloudinstance.html]]]",
      "version" : "version",
      "connected" : true,
      "currentAgentVersion" : "currentAgentVersion",
      "compatibilityPolicy" : "[[[compatibilityPolicy...|compatibilitypolicy.html]]]",
      "registrationTimestamp" : "registrationTimestamp",
      "environment" : "[[[environment...|environment.html]]]",
      "pluginsOutdated" : true,
      "port" : 3,
      "build" : "[[[build...|build.html]]]",
      "webUrl" : "webUrl",
      "name" : "name",
      "typeId" : 3,
      "lastActivityTime" : "lastActivityTime",
      "locator" : "locator",
      "properties" : "[[[properties...|properties.html]]]",
      "javaOutdated" : true
    },
    "name" : "name",
    "errorMessage" : "errorMessage",
    "id" : "id",
    "state" : "state",
    "href" : "href",
    "networkAddress" : "networkAddress",
    "startDate" : "startDate"
  } ],
  "prevHref" : "prevHref",
  "href" : "href",
  "nextHref" : "nextHref"
}

Last modified: 22 May 2023