...
The following is the schema for a valid candidate
: candidate_id
uniquely identifies a candidate. Currently, it is either a Service Instance ID or Cloud Region ID. candidate_type
identifies the type of the candidate. Currently, it is either cloud
or service
. inventory_type
is defined as described in *Inventory Provider Criteria inventory_provider
identifies the inventory from which the candidate was drawn. host_id
is an ID of a specific host (used only when referring to service/existing inventory). cost
is expressed as a unitless number. location_id
is always a location ID of the specified location type (e.g., for a type of cloud
this will be an Cloud Region ID). location_type
is an inventory provider supported location type. latitude
is a valid latitude corresponding to the locationid. longitude
is a valid longitude corresponding to the *locationid. city
(Optional) city corresponding to the location_id. state
(Optional) state corresponding to the locationid. country
(Optional) country corresponding to the *locationid. region
(Optional) geographic region corresponding to the location_id. complex_name
(Optional) Name of the complex corresponding to the locationid. ``cloudowner(Optional) refers to the *cloud owner* (e.g.,
azure,
aws,
att, etc.). *
cloudregionversion(Optional) is an inventory provider supported version of the cloud region. *
physicallocationid`` (Optional) is an inventory provider supported CLLI code corresponding to the cloud region.
Examples
Code Block | ||||
---|---|---|---|---|
| ||||
{ "candidate_id": "1ac71fb8-ad43-4e16-9459-c3f372b8236d", "candidate_type": "service", "inventory_type": "service", "inventory_provider": "aai", "host_id": "vnf_123456", "cost": "100", "location_id": "DLLSTX55", "location_type": "azure", "latitude": "32.897480", "longitude": "-97.040443", "city": "Dallas", "state": "TX", "country": "USA", "region": "US", "complex_name": "dalls_one", "cloud_owner": "att-aic", "cloud_region_version": "1.1", "physical_location_id": "DLLSTX55", } |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "candidate_id": "NYCNY55", "candidate_type": "cloud", "inventory_type": "cloud", "inventory_provider": "aai", "cost": "100", "location_id": "NYCNY55", "location_type": "azure", "latitude": "40.7128", "longitude": "-74.0060", "city": "New York", "state": "NY", "country": "USA", "region": "US", "complex_name": "ny_one", "cloud_owner": "att-aic", "cloud_region_version": "1.1", "physical_location_id": "NYCNY55" } |
Questions * Currently, candidates are either service instances or cloud regions. As new services are on-boarded, this can be evolved to represent different types of resources.
...