NSLifecycleManagement.yaml 102 KB
Newer Older
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string

    NsLcmOpOccContinue.Post.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
        with the state of the NS LCM operation occurrence resource.
        Typically, this is due to the fact that the NS LCM operation occurrence is not in FAILED_TEMP state, or
        another error handling action is starting, such as retry or fail.
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string

    NsLcmOpOccFail.Post.200:
      description: |
        200 OK
        Shall be returned when the state of the NS lifecycle management operation occurrence has been changed
        successfully. The response shall include a representation of the "Individual NS lifecycle management
        operation occurrence" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc


    NsLcmOpOccFail.Post.404:
      description: |
        404 NOT FOUND

        Shall be returned upon the following error: The API producer did not find a current representation for the
        target resource or is not willing to disclose that one exists.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this task resource, the response code 404 shall also be returned if the task is not
        supported for the NS LCM operation occurrence represented by the parent resource, which means that the task resource consequently does not exist.
        In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the
        "detail" attribute shall convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    NsLcmOpOccFail.Post.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with
        the state of the NS LCM operation occurrence resource.
        Typically, this is due to the fact that the NS LCM operation occurrence is not in FAILED_TEMP state, or another
        error handling action is starting, such as retry or rollback.
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more
        information about the error.

      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    NsLcmOpOccCancel.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the request has been accepted for processing, but processing has not been completed.
        The response shall have an empty entity body.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: The resource URI of the created NS instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content: {}

    NsLcmOpOccCancel.Post.404:
      description: |
        404 NOT FOUND

        Shall be returned upon the following error: The API producer did not find a current representation for the
        target resource or is not willing to disclose that one exists.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically, in case of this task resource, the response code 404 shall also be returned if the task is not
        supported for the NS LCM operation occurrence represented by the parent resource, which means that the task resource consequently does not exist.
        In this case, the response body shall be present, and shall contain a ProblemDetails structure, in which the
        "detail" attribute shall convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    NsLcmOpOccCancel.Post.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
        with the state of the NS LCM operation occurrence resource.
        Typically, this is due to the fact that the operation occurrence is not in STARTING, PROCESSING or ROLLING_BACK state.
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more
        information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    NsLcmSubscriptions.Get.200:
      description: |
        200 OK
        Shall be returned when the list of subscriptions has been queried successfully. The response body shall
        contain in an array the representations of all active subscriptions of the functional block that invokes
        the method, i.e. zero or more representations of lifecycle change notification subscriptions as defined in
        clause 6.5.2.4. If the "filter" URI parameter was supplied in the request, the data in the response body
        shall have been transformed according to the rules specified in clause 5.2.2 of ETSI GS NFV-SOL 013 [16].
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 [16] for this
        resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3
        of ETSI GS NFV-SOL 013 [16].
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription

    NsLcmSubscriptions.Post.201:
      description: |
        201 Created\nShall be returned when the subscription has been
        created successfully. The response body shall contain a representation
        of the created "Individual subscription" resource. The HTTP response
        shall include a "Location:" HTTP header that points to the created
        "Individual subscription" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription

    NsLcmSubscriptions.Post.303:
      description: |
        303 See Other

        Shall be returned if a subscription with the same callback URI and the same filter already exits and the
        policy of the NFVO is to not create redundant subscriptions.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing
        "Individual subscription" resource.
        The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string

    NsLcmSubscriptions.Post.422:
      description: |
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type of the payload body is supported and the
        payload body of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 6.4.18.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    IndividualNsLcmSubscription.Get.200:
      description: |
        200 OK
        Shall be returned when information about an individual
        subscription has been read successfully. The response body shall contain
        a representation of the "Individual subscription" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription

    IndividualNsLcmSubscription.Delete.204:
      description: |
        204 NO CONTENT
        Shall be returned when the "Individual subscription" resource has been deleted successfully. The response
        body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
    VnfSnapshots.Get.200:
      description: |
        200 OK
        Shall be returned when information about zero or more VNF snapshots was queried successfully.
        The response body shall contain in an array the representations of zero or more "Individual VNF snapshot" resources,
        as defined in clause 6.5.2.17.
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource,
        inclusion of the Link HTTP header in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo

    IndividualVnfSnapshot.Get.200:
      description: |
        200 OK
        Shall be returned when information about an individual VNF snapshot was read successfully.
        The response body shall contain a representation of the "Individual VNF snapshot" resource, as defined in clause
        6.5.2.17.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo

    IndividualVnfSnapshot.Delete.204:
      description: |
        204 NO CONTENT
        Shall be returned when the VNF snapshot resource and the associated VNF snapshot were deleted successfully.
        The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string