Newer
Older
title: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management'
description: 'ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.'
version: '2.1.1'
license:
name: BSD-3-Clause
url: https://forge.etsi.org/legal-matters
name: ETSI Forge
url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
externalDocs:
description: "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1"
url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
- url: https://localhost/granting/v1
variables: {}
tags:
- name: granting
description: Grant operations
summary: 'requests a grant for a particular application lifecycle operation'
description: requests a grant for a particular application lifecycle operation
content:
application/json:
schema:
$ref: '#/components/schemas/GrantRequest'
responses:
'201':
description: grant was created successfully (synchronous mode)
content:
application/json:
schema:
$ref: '#/components/schemas/Grant'
'202':
description: the request was accepted for processing
headers: {}
content: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
/grants/{grantId}:
summary: 'read the grant'
parameters:
- name: grantId
in: path
description: Identifier of the individual grant.
required: true
style: simple
schema:
type: string
description: A representation of the "individual grant" resource
description: returned when the process of creating the grant is ongoing, no grant is available yet
headers: {}
content: {}
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Unauthorized : used when the client did not submit credentials.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Forbidden : operation is not allowed given the current status of the resource.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
description: 'Too Many Requests : used when a rate limiter has triggered.'
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
deprecated: false
parameters: []
title: AppExtCpConfig
type: object
description: "Identifier of the external CP instance to which this set of configuration parameters is requested to be applied. \n\nShall be present if this instance has already been created."
items:
$ref: '#/components/schemas/CpProtocolData'
description: Parameters for configuring the network protocols on the link port that connects the CP to a VL. See note.
description: Identifier of a pre-configured link port to which the external CP will be associated. See note.
title: AppExtCpData
required:
- cpConfig
- cpdId
type: object
properties:
cpConfig:
minItems: 1
type: array
items:
$ref: '#/components/schemas/AppExtCpConfig'
description: List of instance data that need to be configured on the CP instances created from the respective CPD.
description: The identifier of the CPD in the AppD.
- COMPUTE
- VL
- STORAGE
- LINKPORT
type: string
description: Type of the resource definition referenced.
examples:
- COMPUTE
title: CpProtocolData
required:
- layerProtocol
type: object
properties:
ipOverEthernet:
$ref: '#/components/schemas/IpOverEthernetAddressData'
layerProtocol:
$ref: '#/components/schemas/IpOverEthernetAddressData'
ExtLinkPortData:
title: ExtLinkPortData
description: Identifier of this link port as provided by the entity that has created the link port.
resourceHandle:
$ref: '#/components/schemas/ResourceHandle'
ExtVirtualLinkData:
title: ExtVirtualLinkData
type: object
properties:
extCps:
minItems: 1
type: array
items:
$ref: '#/components/schemas/AppExtCpData'
description: External CPs of the application instance to be connected to this external VL.
extLinkPorts:
items:
$ref: '#/components/schemas/ExtLinkPortData'
description: Externally provided link ports to be used to connect external connection points to this external VL. If this attribute is not present, the MEPM shall create the link ports on the external VL.
description: The identifier of the external VL instance. The identifier is assigned by the MEC entity that manages this VL instance.
description: The identifier of the resource in the scope of the VIM.
description: Identifier of the VIM connection to manage this resource.
Grant:
title: Grant
- appInstanceId
- appLcmOpOccId
- _links
type: string
description: Identifier of application instance.
type: string
description: Identifier of application lifecycle management operation occurrence.
vimConnections:
type: array
items:
$ref: '#/components/schemas/VimConnectionInfo'
zones:
type: array
items:
$ref: '#/components/schemas/ZoneInfo'
zoneGroups:
type: array
items:
$ref: '#/components/schemas/ZoneGroupInfo'
addResources:
type: array
items:
$ref: '#/components/schemas/GrantInfo'
tempResources:
type: array
items:
$ref: '#/components/schemas/GrantInfo'
removeResources:
type: array
items:
$ref: '#/components/schemas/GrantInfo'
updateResources:
type: array
items:
$ref: '#/components/schemas/GrantInfo'
vimAssets:
$ref: '#/components/schemas/VimAssets'
extVirtualLinks:
type: array
items:
$ref: '#/components/schemas/ExtVirtualLinkData'
type: object
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
description: "'This type represents a grant. Refer to clause 9.5.2.3 of ETSI GS NFV-SOL 003 '"
type: object
properties:
softwareImages:
type: array
items:
$ref: '#/components/schemas/VimSoftwareImage'
description: ''
description: Information about assets for the application that are managed by the MEO in the VIM, such as software images.
Grant.links:
title: Grant.links
- appLcmOpOcc
- appInstance
type: object
properties:
appLcmOpOcc:
$ref: '#/components/schemas/LinkType'
appInstance:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
title: GrantInfo
required:
- resourceDefinitionId
type: object
properties:
resourceDefinitionId:
type: string
description: Identifier of the related "ResourceDefinition" structure from the related "GrantRequest" structure.
description: Identifier of the "infrastructure resource group", logical grouping of virtual resources assigned to a tenant within an Infrastructure Domain, to be provided when allocating the resource.If the VIM connection referenced by "vimConnectionId" applies to multiple infrastructure resource groups, this attribute shall be present for new resources.If the VIM connection referenced by "vimConnectionId" applies to a single infrastructure resource group, this attribute may be present for new resources. This attribute shall be absent for resources that have already been allocated.
description: Identifier of the VIM connection to be used to manage this resource. Shall be present for new resources, and shall be absent for resources that have already been allocated.
description: Reference to the identifier of the "ZoneInfo" structure in the "Grant" structure defining the resource zone into which this resource is to be placed. Shall be present for new resources if the zones concept is applicable to them (typically, Compute resources), and shall be absent for resources that have already been allocated.
- appInstanceId
- appLcmOpOccId
- appDId
- operation
- _links
type: object
type: string
description: Identifier of application instance.
type: string
description: Identifier of application lifecycle management operation occurrence.
type: string
description: Identifier of this MEC application descriptor. This attribute shall be globally unique.
operation:
$ref: '#/components/schemas/GrantRequest.Operation'
addResources:
type: array
items:
$ref: '#/components/schemas/ResourceDefinition'
description: ''
type: array
items:
$ref: '#/components/schemas/ResourceDefinition'
description: ''
type: array
items:
$ref: '#/components/schemas/ResourceDefinition'
description: ''
type: array
items:
$ref: '#/components/schemas/ResourceDefinition'
description: ''
type: object
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
_links:
$ref: '#/components/schemas/GrantRequest.links'
description: "'This type represents a grant request. Refer to clause 9.5.2.2 of ETSI GS NFV-SOL 003'"
- INSTANTIATE
- OPERATE
- TERMINATE
type: string
description: "'The lifecycle management operation for which granting is requested'"
examples:
- INSTANTIATE
- appLcmOpOcc
- appInstance
type: object
properties:
appLcmOpOcc:
$ref: '#/components/schemas/LinkType'
appInstance:
$ref: '#/components/schemas/LinkType'
description: Links to resources related to this resource.
type: string
description: "'MAC address. If this attribute is not present, it shall be chosen by the VIM'"
type: array
items:
$ref: '#/components/schemas/IpAddress'
description: List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.
description: "'This type represents network address data for IP over Ethernet. Refer to clause 4.4.1.10c of ETSI GS NFV SOL 003'"
properties:
type:
$ref: '#/components/schemas/IpAddress.Type'
fixedAddresses:
type: array
items:
type: string
description: Fixed addresses to assign (from the subnet defined by subnetId if provided).
type: integer
description: Number of dynamic addresses to assign (from the subnet defined by subnetId if provided)
contentEncoding: int32
addressRange:
$ref: '#/components/schemas/AddressRange'
subnetId:
type: string
description: Subnet defined by the identifier of the subnet resource in the VIM.
description: "'IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet.'"
- IPV4
- IPV6
type: string
description: The type of the IP addresses.
examples:
- IPV4
- minAddress
- maxAddress
type: object
type: string
description: Lowest IP address belonging to the range.
description: Highest IP address belonging to the range.
description: An IP address range to be used, e.g. in case of egress connections.
LinkType:
title: LinkType
properties:
href:
type: string
description: URI referring to a resource
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
- id
- type
- resourceTemplateId
- resource
type: object
type: string
description: Identifier of the related ResourceDefinition structure from the related GrantRequest structure.
type:
$ref: '#/components/schemas/ResourceDefinition.Type'
vduId:
type: string
description: Reference to the related VDU in the AppD applicable to this resource.
type: string
description: Reference to a resource template, i.e. VirtualLinkDesc, VirtualComputeDesc, AppExtCpd, VirtualStorageDesc in the AppD.
description: "'This type provides information of an existing or proposed resource used by the application. Refer to clause 9.5.3.2 of ETSI GS NFV-SOL 003 '"
- vimConnectionInfo
- resourceId
type: object
properties:
vimConnectionInfo:
$ref: '#/components/schemas/VimConnectionInfo'
resourceId:
type: string
description: Identifier of the resource in the scope of the VIM.
description: Resource information for an existing resource
title: ResourceHandle
required:
- resourceId
type: object
description: Identifier of the resource in the scope of the VIM.
description: Identifier of the VIM connection to manage the resource.The applicable "VimConnectionInfo" structure, which is referenced by vimConnectionId, can be obtained from the "vimConnectionInfo" attribute of the "AppInstance" structure.
description: Type of the resource in the scope of the VIM. See note.
VimConnectionInfo:
title: VimConnectionInfo
type: object
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
type: object
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
description: The identifier of the VIM Connection. This identifier is managed by the MEO.
type: object
description: "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'"
description: The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.
description: Discriminator for the different types of the VIM information. The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available.
VimSoftwareImage:
title: VimSoftwareImage
- appDSoftwareImageId
- vimSoftwareImageId
type: object
properties:
appDSoftwareImageId:
type: string
description: Identifier which references the software image descriptor in the AppD.
description: Identifier of the VIM connection to access the software image referenced in this structure.
description: Identifier of the software image in the resource management layer (i.e. VIM).
ZoneGroupInfo:
title: ZoneGroupInfo
type: object
properties:
zoneId:
minItems: 1
type: array
items:
type: string
description: References of identifiers of "ZoneInfo" structures, each of which provides information about a resource zone that belongs to this group.
ZoneInfo:
title: ZoneInfo
- zoneId
type: object
properties:
id:
type: string
description: The identifier of this ZoneInfo instance, for the purpose of referencing it from other structures in the "Grant" structure.
vimConnectionId:
type: string
zoneId:
type: string
description: The identifier of the resource zone, as managed by the resource management layer (typically, the VIM).
security: