CloudImage
Represents a cloud instance image saved with a profile.
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.
<cloudImage agentPoolId="123" agentTypeId="123" errorMessage="string" href="string" id="string" locator="string" name="string" operatingSystemName="string">
<profile cloudProviderId="string" href="string" id="string" name="string">
<project>[[[project...|project.html]]]</project>
<images>[[[cloudImages...|cloudimages.html]]]</images>
</profile>
<instances count="123" href="string" nextHref="string" prevHref="string">
<cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance>
</instances>
</cloudImage>
{
"agentPoolId" : 2,
"instances" : {
"count" : 3,
"cloudInstance" : [ {
"image" : "[[[cloudImage...|cloudimage.html]]]",
"agent" : "[[[agent...|agent.html]]]",
"name" : "name",
"errorMessage" : "errorMessage",
"id" : "id",
"state" : "state",
"href" : "href",
"networkAddress" : "networkAddress",
"startDate" : "startDate"
} ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"agentTypeId" : 8,
"profile" : {
"images" : {
"count" : 4,
"prevHref" : "prevHref",
"href" : "href",
"cloudImage" : [ "[[[cloudImage...|cloudimage.html]]]" ],
"nextHref" : "nextHref"
},
"name" : "name",
"project" : {
"parentProjectName" : "parentProjectName",
"parentProject" : {
"parentProjectName" : "parentProjectName",
"parentProject" : "[[[project...|project.html]]]",
"vcsRoots" : "[[[vcs-roots...|vcsroots.html]]]",
"projects" : "[[[projects...|projects.html]]]",
"templates" : "[[[buildTypes...|buildtypes.html]]]",
"defaultTemplate" : "[[[buildType...|buildtype.html]]]",
"description" : "description",
"uuid" : "uuid",
"parentProjectInternalId" : "parentProjectInternalId",
"cloudProfiles" : "[[[cloudProfiles...|cloudprofiles.html]]]",
"internalId" : "internalId",
"archived" : true,
"readOnlyUI" : "[[[StateField...|statefield.html]]]",
"parentProjectId" : "parentProjectId",
"webUrl" : "webUrl",
"buildTypes" : "[[[buildTypes...|buildtypes.html]]]",
"name" : "name",
"links" : "[[[links...|links.html]]]",
"id" : "id",
"href" : "href",
"parameters" : "[[[properties...|properties.html]]]",
"projectFeatures" : "[[[projectFeatures...|projectfeatures.html]]]",
"locator" : "locator"
},
"vcsRoots" : {
"count" : 4,
"vcs-root" : [ "[[[vcs-root...|vcsroot.html]]]" ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"projects" : {
"count" : 7,
"project" : [ "[[[project...|project.html]]]" ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"templates" : {
"buildType" : [ "[[[buildType...|buildtype.html]]]" ],
"count" : 0,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"defaultTemplate" : {
"template" : "[[[buildType...|buildtype.html]]]",
"paused" : true,
"description" : "description",
"project" : "[[[project...|project.html]]]",
"investigations" : "[[[investigations...|investigations.html]]]",
"templateFlag" : true,
"type" : "regular",
"uuid" : "uuid",
"projectInternalId" : "projectInternalId",
"internalId" : "internalId",
"features" : "[[[features...|features.html]]]",
"builds" : "[[[builds...|builds.html]]]",
"links" : "[[[links...|links.html]]]",
"id" : "id",
"href" : "href",
"settings" : "[[[properties...|properties.html]]]",
"vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
"templates" : "[[[buildTypes...|buildtypes.html]]]",
"artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
"compatibleAgents" : "[[[agents...|agents.html]]]",
"pauseComment" : "[[[comment...|comment.html]]]",
"triggers" : "[[[triggers...|triggers.html]]]",
"branches" : "[[[branches...|branches.html]]]",
"steps" : "[[[steps...|steps.html]]]",
"externalStatusAllowed" : true,
"agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]",
"webUrl" : "webUrl",
"inherited" : true,
"snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]",
"name" : "name",
"vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]",
"projectName" : "projectName",
"projectId" : "projectId",
"parameters" : "[[[properties...|properties.html]]]",
"locator" : "locator"
},
"description" : "description",
"uuid" : "uuid",
"parentProjectInternalId" : "parentProjectInternalId",
"cloudProfiles" : {
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"cloudProfile" : [ "[[[cloudProfile...|cloudprofile.html]]]" ],
"nextHref" : "nextHref"
},
"internalId" : "internalId",
"archived" : true,
"readOnlyUI" : {
"inherited" : true,
"value" : true
},
"parentProjectId" : "parentProjectId",
"webUrl" : "webUrl",
"buildTypes" : {
"buildType" : [ "[[[buildType...|buildtype.html]]]" ],
"count" : 0,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"name" : "name",
"links" : {
"count" : 6,
"link" : [ "[[[link...|link.html]]]" ]
},
"id" : "id",
"href" : "href",
"parameters" : {
"count" : 6,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "[[[type...|type.html]]]",
"value" : "value"
} ],
"href" : "href"
},
"projectFeatures" : {
"projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ],
"count" : 8,
"href" : "href"
},
"locator" : "locator"
},
"id" : "id",
"href" : "href",
"cloudProviderId" : "cloudProviderId"
},
"name" : "name",
"errorMessage" : "errorMessage",
"id" : "id",
"href" : "href",
"operatingSystemName" : "operatingSystemName",
"locator" : "locator"
}
Last modified: 30 March 2022