TeamCity REST API Reference 2024.07 Help

CloudInstanceLocator

Represents a locator string for filtering CloudInstance entities. Examples:

  • agent:<agentLocator> - find cloud instance which hosts agent found by agentLocator.

  • profile:<profileLocator> - find all cloud instances in cloud profile found by profileLocator.

Properties

Dimension

Data type

Format

Description

affectedProject

string

ProjectLocator

Projects where the cloud profiles/images are accessible.

agent

string

AgentLocator

Agent running on an instance.

count

long

int64

For paginated calls, how many entities to return per page.

id

string

Should be in the form "profileId:<profileId>,imageId:<imageId>,id:<instanceId>".

Instance id as provided by list instances call.

image

string

CloudImageDimensions

Cloud image corresponding to an instance.

networkAddress

string

DNS name or IP address

Instance network address.

profile

string

CloudProfileFinder

Cloud profile of an instance.

project

string

ProjectLocator

Project defining the cloud profiles/images.

property

string

property:(name:<name>,value:<value>,matchType:<matchType>)

Supported matchType values:

  • exists

  • not-exists

  • equals

  • does-not-equal

  • starts-with

  • contains

  • does-not-contain

  • ends-with

  • any

  • matches

  • does-not-match

  • more-than

  • no-more-than

  • less-than

  • no-less-than

  • ver-more-than

  • ver-no-more-than

  • ver-less-than

  • ver-no-less-than

start

long

int64

For paginated calls, from which entity to start rendering the page.

Last modified: 04 July 2024