CloudInstance
Represents a running cloud instance.
Related Help article: Cloud Profile
Properties
Field | Data type |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
| |
| |
|
|
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.
<cloudInstance errorMessage="string" href="string" id="string" name="string" networkAddress="string" startDate="string" state="string">
<image agentPoolId="123" agentTypeId="123" errorMessage="string" href="string" id="string" locator="string" name="string" operatingSystemName="string">
<profile>[[[cloudProfile...|cloudprofile.html]]]</profile>
<instances>[[[cloudInstances...|cloudinstances.html]]]</instances>
</image>
<agent authorized="true" connected="true" cpuRank="123" currentAgentVersion="string" disconnectionComment="string" enabled="true" host="string" href="string" id="123" idleSinceTime="string" ip="string" javaOutdated="true" lastActivityTime="string" locator="string" name="string" outdated="true" pluginsOutdated="true" port="123" protocol="string" registrationTimestamp="string" typeId="123" uptodate="true" version="string" webUrl="string">
<build>[[[build...|build.html]]]</build>
<links>[[[links...|links.html]]]</links>
<enabledInfo>[[[enabledInfo...|enabledinfo.html]]]</enabledInfo>
<authorizedInfo>[[[authorizedInfo...|authorizedinfo.html]]]</authorizedInfo>
<properties>[[[properties...|properties.html]]]</properties>
<cloudInstance>[[[cloudInstance...|]]]</cloudInstance>
<cloudImage>[[[cloudImage...|cloudimage.html]]]</cloudImage>
<environment>[[[environment...|environment.html]]]</environment>
<pool>[[[agentPool...|agentpool.html]]]</pool>
<compatibilityPolicy>[[[compatibilityPolicy...|compatibilitypolicy.html]]]</compatibilityPolicy>
<compatibleBuildTypes>[[[buildTypes...|buildtypes.html]]]</compatibleBuildTypes>
<incompatibleBuildTypes>[[[compatibilities...|compatibilities.html]]]</incompatibleBuildTypes>
<builds>[[[builds...|builds.html]]]</builds>
</agent>
</cloudInstance>
{
"image" : {
"agentPoolId" : 7,
"instances" : "[[[cloudInstances...|cloudinstances.html]]]",
"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...|]]]",
"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"
}
Last modified: 22 May 2023