Changes between Version 21 and Version 22 of GAPI_AM_API_V3_DETAILS


Ignore:
Timestamp:
07/19/12 13:00:52 (12 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • GAPI_AM_API_V3_DETAILS

    v21 v22  
    115115== `ListResources` Details ==
    116116`ListResources` returns the advertised or available resources that can be reserved at this aggregate.
    117 
     117As elsewhere, this page provides only details not covered by the [wiki:GAPI_AM_API_V3#ListResources main AM API page].
     118
     119'''Options'''
    118120 `geni_available`::
    119121    Optional. An [http://www.xmlrpc.com/spec XML-RPC] boolean value indicating whether the caller is interested in all resources or available resources. If this value is true (`1`), the result should contain only available resources. If this value is false (`0`) or unspecified, both available and allocated resources should be returned. The Aggregate Manager is free to limit visibility of certain resources based on the {{{credentials}}} parameter.
    … …  
    149151-----
    150152== `Describe` Details ==
    151 `Describe` is used to list the resources belonging to a particular reservation. The return is the standard AM API struct, whose value is a struct that always includes a single manifest RSpec, describing the resources in the set of slivers whose URNs were supplied, or describing the entire single slice whose URN was supplied as an argument.
     153`Describe` is used to list the resources belonging to a particular reservation. The return is the standard AM API struct, with a `value` that is a struct that always includes a single manifest RSpec, describing the resources in the set of slivers whose URNs were supplied, or describing the entire single slice whose URN was supplied as an argument.
    152154
    153155The manifest RSpec should contain all necessary details about resource identity, configuration, and access information necessary for experimenters to use the resources. As that configuration information may change as the resource becomes operationally `geni_ready`, this information may change. Otherwise, the manifest is mostly static.
    … …  
    165167....   
    166168",
     169    geni_urn: "urn:publicid:IDN+pgenigpolabbbncom+slice+ahtest",
    167170    geni_slivers: [
    168171          {
    … …  
    177180              geni_allocation_status: "geni_provisioned"
    178181              geni_operational_status: "geni_ready",
    179               geni_error: ""
     182              geni_error: "" # optional field, included here as an example
    180183          }
    181184    ]