Changes between Version 6 and Version 7 of GAPI_AM_API_V3
- Timestamp:
- 05/01/12 10:53:53 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
GAPI_AM_API_V3
v6 v7 115 115 == !GetVersion == 116 116 Query static configuration information about this aggregate manager implementation, such as API and RSpec versions supported. 117 118 For details on the arguments, return structure, and semantics, see [wiki:GAPI_AM_API_V3_DETAILS#GetVersionDetails the details page].119 117 120 118 The !GetVersion operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#GetVersion GetVersion] operation. The [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA] specification does not include this operation. … … 179 177 * List of advertisement RSpec formats supported by this aggregate. For details on RSpecs, see [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecs the Common Concepts page]. 180 178 * List of supported credential types and versions. For details, see [wiki:GAPI_AM_API_V3/CommonConcepts the Common Concepts#credentials page]. 181 * Options on how sliver allocation works. See [wiki: API_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers the Common Concepts page].179 * Options on how sliver allocation works. See [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers the Common Concepts page]. 182 180 183 181 For details on !GetVersion arguments, returns, and semantics, and a sample minimal return, see [wiki:GAPI_AM_API_V3_DETAILS#GetVersionDetails the Details page]. … … 205 203 206 204 Return: 207 A `geni.rspec` advertisment RSpec. See the Common Concepts page.205 A `geni.rspec` advertisment RSpec. For details on RSpecs, see [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecs the Common Concepts page]. 208 206 209 207 Note that this is only part of what !ListResources did in earlier versions of this API. For the what-is-in-my-slice functionality, see `Describe()`. … … 211 209 This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#DiscoverResources DiscoverResources] operation and to the [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA]'s !GetResources operation (sec. 6.2.4). 212 210 213 For details on the options (which are required), see the Details page.211 For details on the options (which are required), see [wiki:GAPI_AM_API_V3_DETAILS#ListResourcesDetails the Details page]. 214 212 215 213 == Describe == … … 235 233 Note that all options may be omitted by the client, exception `geni_rspec_version` which is required. 236 234 237 For details on the options, see the Details page. 238 See the Common Concepts page about the credentials, rspec, and urns arguments. 235 For details on the options, see [wiki:GAPI_AM_API_V3_DETAILS#DescribeDetails the Details page]. 239 236 240 237 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]. … … 259 256 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. 260 257 261 For details on rspecs, allocation states, operational states, and datetime values, see the Common Concepts page. See GeniIdentifiers for details on URN structure.258 See the Common Concepts page about the [wiki:GAPI_AM_API_V3/CommonConcepts#credentials credentials], [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatype rspec], and [wiki:GAPI_AM_API_V3/CommonConcepts#urns urns] arguments, and also for details on [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation states], [wiki:GAPI_AM_API_V3/CommonConcepts#SliverOperationalStates operational states], and [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype datetime values]. See GeniIdentifiers for details on URN structure. 262 259 263 260 == Allocate == … … 278 275 279 276 This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#GetTicket GetTicket] operation. 280 281 * {{{slice_urn}}}: The URN of the slice to which the resources specified in {{{rspec}}} will be allocated. For details on GENI AM API URN identifiers, see the [wiki:GeniApiIdentifiers GENI wiki page].282 * {{{rspec}}}: An RSpec matching the [http://www.protogeni.net/trac/protogeni/wiki/RSpec GENI standard] request RSpec [http://www.geni.net/resources/rspec/3/request.xsd schema] containing the resources that the caller is requesting for allocation to the slice specified in {{{slice_urn}}}. See the Common Concepts page.283 * `credentials`: The standard authorization argument. See the Common Concepts page.284 285 Options include:286 {{{287 {288 [optional geni_end_time: <dateTime.rfc3339: requested expiration of all new slivers, may be ignored by aggregates>]289 }290 }}}291 292 See the Common Concepts page for details on `geni_end_time`.293 277 294 278 Return struct: … … 309 293 The manifest is a manifest of only newly allocated slivers. 310 294 311 See the Common Concepts page for details on RSpecs, expiration dateTime, and allocation states. 295 Arguments: 296 * {{{slice_urn}}}: The URN of the slice to which the resources specified in {{{rspec}}} will be allocated. For details on GENI AM API URN identifiers, see the [wiki:GeniApiIdentifiers GENI wiki page]. 297 * {{{rspec}}}: An RSpec matching the [http://www.protogeni.net/trac/protogeni/wiki/RSpec GENI standard] request RSpec [http://www.geni.net/resources/rspec/3/request.xsd schema] containing the resources that the caller is requesting for allocation to the slice specified in {{{slice_urn}}}. See [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatype the Common Concepts page]. 298 * `credentials`: The standard authorization argument. See [wiki:GAPI_AM_API_V3/CommonConcepts#credentials the Common Concepts page]. 299 300 Options include: 301 {{{ 302 { 303 [optional geni_end_time: <dateTime.rfc3339: requested expiration of all new slivers, may be ignored by aggregates>] 304 } 305 }}} 306 307 See the Common Concepts page for details on [wiki:GAPI_AM_API_V3/CommonConcepts#geni_end_time `geni_end_time`], [wiki:GAPI_AM_API_V3/CommonConcepts#RSpecdatatype RSpecs], [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype expiration dateTime], and [wiki:GAPI_AM_API_V3/CommonConcepts#SliverAllocationStates allocation states]. 312 308 313 309 == Renew == … … 321 317 }}} 322 318 323 This operation used to be called !RenewSliver. Use Renew(<slice_urn>)to get the equivalent functionality.319 This operation used to be called !RenewSliver. Use `Renew(<slice_urn>)` to get the equivalent functionality. 324 320 325 321 This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#RenewSlice RenewSlice] operation. 326 322 327 Options include {{{geni_best_effort}}}, specifying whether the client prefers all included slivers to be renewed or none, or wants a partial success if possible. See the Common Concepts page under `geni_best_effort` and Operations on Individual Slivers. 328 329 {{{expiration_time}}}: The date-time string in [http://tools.ietf.org/html/rfc3339 RFC 3339] format in UTC when the reservation(s) should be extended until. See the Common Concepts page. 330 331 See the Common Concepts page for details on the `urns[]` and `credentiasl[]` arguments. 323 Options include {{{geni_best_effort}}}, specifying whether the client prefers all included slivers to be renewed or none, or wants a partial success if possible. See the Common Concepts page under [wiki:GAPI_AM_API_V3/CommonConcepts#geni_best_effort `geni_best_effort`] and [wiki:GAPI_AM_API_V3/CommonConcepts#OperationsonIndividualSlivers Operations on Individual Slivers]. 324 325 Arguments: 326 {{{expiration_time}}}: The date-time string in [http://tools.ietf.org/html/rfc3339 RFC 3339] format in UTC when the reservation(s) should be extended until. See [wiki:GAPI_AM_API_V3/CommonConcepts#datetimedatatype the Common Concepts page]. 327 328 See the Common Concepts page for details on the [wiki:GAPI_AM_API_V3/CommonConcepts#urns `urns[]`] and [wiki:GAPI_AM_API_V3/CommonConcepts#credentials `credentials[]`] arguments. 332 329 333 330 Return value is a list of structs: … … 403 400 - {{{geni_best_effort}}} 404 401 - {{{geni_end_time}}} 405 - `struct geni_users[]` 402 - `struct geni_users[]`: Resource login information. See [wiki:GAPI_AM_API_V3/CommonConcepts#geni_users the Common Concepts page]. 406 403 407 404 See the Common Concepts page for details on each option. … … 445 442 - {{{geni_end_time}}} 446 443 - {{{geni_best_effort}}} 447 - `struct geni_users[]` 444 - `struct geni_users[]`: Resource login information. See [wiki:GAPI_AM_API_V3/CommonConcepts#geni_users the Common Concepts page]. 448 445 449 446 Return struct: