Changes between Version 24 and Version 25 of GAPI_AM_API_V3
- Timestamp:
- 07/17/12 11:15:34 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
GAPI_AM_API_V3
v24 v25 117 117 118 118 ----- 119 ''Method Signatures'' 119 '''Method Signatures''' 120 120 121 Signatures for the aggregate manager API follow. Examples, return codes, and other details are on the [wiki:GAPI_AM_API_V3_DETAILS Details page]. Most data types and the state machines are explained on the [wiki:GAPI_AM_API_V3/CommonConcepts Common Concepts page]. 121 122 … … 218 219 219 220 == `Describe` == 220 Retrieve a manifest RSpec describing the resources contained by the named entities, e.g. a single slice or a set of the slivers in a slice. This listing and description should be sufficient to allow experimenters to use the resources.221 Retrieve a manifest RSpec describing the resources contained by the named entities, e.g. a single slice or a set of the slivers in a slice. This listing and description should be sufficiently descriptive to allow experimenters to use the resources. 221 222 222 223 {{{ … … 235 236 }}} 236 237 237 Note that all options may be omitted by the client , exception`geni_rspec_version` which is required.238 Note that all options may be omitted by the client except for `geni_rspec_version` which is required. 238 239 239 240 For details on the options, see [wiki:GAPI_AM_API_V3_DETAILS#DescribeDetails the Details page]. 240 241 241 This method is part of what `ListResources` used to do , and is similar to ProtoGENI [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#Resolve Resolve].242 243 Return: On success, the `value` field of the [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct return struct] will contain a tstruct:244 {{{ 245 { 246 geni_rspec: <geni.rspec, Manifest>242 This method is part of what `ListResources` used to do in previous versions of the AM API, and is similar to ProtoGENI [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#Resolve `Resolve`]. 243 244 Return: On success, the `value` field of the [wiki:GAPI_AM_API_V3/CommonConcepts#ReturnStruct return struct] will contain a struct: 245 {{{ 246 { 247 geni_rspec: <geni.rspec, a Manifest RSpec> 247 248 geni_urn: <string slice urn of the containing slice> 248 249 geni_slivers: [ … … 250 251 geni_sliver_urn: <string sliver urn> 251 252 geni_expires: <dateTime.rfc3339 allocation expiration string, as in geni_expires from SliversStatus>, 252 geni_allocation_status: <string sliver state - allocated or ??>,253 geni_allocation_status: <string sliver state - e.g. geni_allocated or geni_provisioned >, 253 254 geni_operational_status: <string sliver operational state>, 254 255 geni_error: <optional string, may be omitted entirely, explaining any failure for a sliver> … … 259 260 }}} 260 261 261 Note that the manifest RSpec for allocated slivers may contain less detail than for provisioned slivers. Aggregates are expected to combine the manifests of all requested slivers into a single manifest RSpec. Note that a manifest returned here for only some of the slivers in a slice at this aggregate , may contain references to resources not described in this manifest (they are in other slivers). As a result, such manifests may not be directly usable as a subsequent request.262 263 If a slice urn is supplied and there are no slivers in the given slice at this aggregate, then `geni_rspec` shall be a valid manifest RSpec, containing 0`node` or `link` elements - that is, specifying no resources. `geni_slivers` may be an empty array, or may be an array of previous slivers that have since been deleted or expired.262 Note that the manifest RSpec for allocated slivers may contain less detail than for provisioned slivers. Aggregates are expected to combine the manifests of all requested slivers into a single manifest RSpec. Note that a manifest returned here for only some of the slivers in a slice at this aggregate may contain references to resources not described in this manifest because they are in other slivers. 263 264 If a slice urn is supplied and there are no slivers in the given slice at this aggregate, then `geni_rspec` shall be a valid manifest RSpec, containing zero (0) `node` or `link` elements - that is, specifying no resources. `geni_slivers` may be an empty array, or may be an array of previous slivers that have since been deleted or expired. 264 265 265 266 Manifests are not necessarily static. In general, the manifest of a given sliver should be static once it has reached the operational state `geni_ready` (e.g., fully booted). However, this API does not require that to be true. … … 280 281 }}} 281 282 282 This is the first part of what `CreateSliver` used to do . The second part is now done by `Provision`, and the final part is done by `PerformOperationalAction`.283 This is the first part of what `CreateSliver` used to do in previous versions of the AM API. The second part is now done by `Provision`, and the final part is done by `PerformOperationalAction`. 283 284 284 285 This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#GetTicket GetTicket] operation. … … 287 288 {{{ 288 289 { 289 geni_rspec: <geni.rspec manifest >,290 geni_rspec: <geni.rspec manifest of newly allocated slivers>, 290 291 geni_slivers: [ 291 292 { 292 293 geni_sliver_urn: <string sliver urn> 293 294 geni_expires: <dateTime.rfc3339 allocation expiration string, as in geni_expires from Status>, 294 geni_allocation_status: <string sliver state - allocated or ??>295 geni_allocation_status: <string sliver state - e.g. geni_allocated> 295 296 }, 296 297 ... … … 299 300 }}} 300 301 301 The manifest is a manifest of onlynewly allocated slivers.302 The manifest is a manifest RSpec of _only_ newly allocated slivers. 302 303 303 304 Arguments:
