Get Vnf Lcm Op Occ Id
The API consumer can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an "Individual VNF LCM operation occurrence" resource. See clause 5.4.13.3.2.
Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.
Content-Types that are acceptable for the response. Reference: IETF RFC 7231.
The authorization token for the request. Reference: IETF RFC 7235.
Version of the API requested to use when responding to this request.
200 OK
Shall be returned when information about a VNF LCM operation occurrence washas been read successfully. The response body shall contain status information about a VNF lifecycle management operation occurrence (see clause 5.5.2.13).
{
"id": "string",
"operationState": "string",
"stateEnteredTime": "string",
"startTime": "string",
"vnfInstanceId": "string",
"grantId": "string",
"operation": "string",
"isAutomaticInvocation": false,
"isCancelPending": false,
"cancelMode": "string",
"error": {
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
},
"resourceChanges": {
"affectedVnfcs": [
{
"id": "string",
"vduId": "string",
"vnfdId": "string",
"changeType": "string",
"computeResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"resourceDefinitionId": "string",
"zoneId": "string",
"affectedVnfcCpIds": [
"string"
],
"addedStorageResourceIds": [
"string"
],
"removedStorageResourceIds": [
"string"
]
}
],
"affectedVirtualLinks": [
{
"id": "string",
"vnfVirtualLinkDescId": "string",
"vnfdId": "string",
"changeType": "string",
"networkResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"vnfLinkPortIds": [
"string"
],
"resourceDefinitionId": "string",
"zoneId": "string"
}
],
"affectedExtLinkPorts": [
{
"id": "string",
"changeType": "string",
"extCpInstanceId": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"resourceDefinitionId": "string"
}
],
"affectedVirtualStorages": [
{
"id": "string",
"virtualStorageDescId": "string",
"vnfdId": "string",
"changeType": "string",
"storageResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"resourceDefinitionId": "string",
"zoneId": "string"
}
]
},
"changedInfo": {
"vnfInstanceName": "string",
"vnfInstanceDescription": "string",
"vnfdId": "string",
"vnfProvider": "string",
"vnfProductName": "string",
"vnfSoftwareVersion": "string",
"vnfdVersion": "string"
},
"affectedVipCps": [
{
"cpInstanceId": "string",
"cpdId": "string",
"vnfdId": "string",
"changeType": "string"
}
],
"changedExtConnectivity": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"extLinkPorts": [
{
"id": "string",
"resourceHandle": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"cpInstanceId": "string",
"secondaryCpInstanceId": "string",
"trunkResourceId": "string"
}
],
"currentVnfExtCpData": [
{
"cpdId": "string"
}
],
"extNetAttDefResource": [
{
"netAttDefResourceInfoId": "string",
"netAttDefResource": {
"vimConnectionId": "string",
"resourceProviderId": "string",
"resourceId": "string",
"vimLevelResourceType": "string",
"vimLevelAdditionalResourceInfo": {
"hostName": "string",
"persistentVolume": "string"
},
"containerNamespace": "string"
},
"associatedExtCpId": [
"string"
],
"associatedVnfcCpId": [
"string"
]
}
]
}
],
"modificationsTriggeredByVnfPkgChange": {
"vnfdId": "string",
"vnfProvider": "string",
"vnfProductName": "string",
"vnfSoftwareVersion": "string",
"vnfdVersion": "string"
},
"vnfSnapshotInfoId": "string",
"lcmCoordinations": [
{
"id": "string",
"coordinationActionName": "string",
"coordinationResult": "string",
"startTime": "string",
"endTime": "string",
"delay": "string",
"endpointType": "string"
}
],
"rejectedLcmCoordinations": [
{
"coordinationActionName": "string",
"rejectionTime": "string",
"delay": "string",
"endpointType": "string"
}
],
"warnings": [
"string"
],
"_links": {
"self": {
"href": "string"
},
"vnfInstance": {
"href": "string"
},
"grant": {
"href": "string"
},
"cancel": {
"href": "string"
},
"retry": {
"href": "string"
},
"rollback": {
"href": "string"
},
"fail": {
"href": "string"
},
"vnfSnapshot": {
"href": "string"
}
}
}Identifier of this VNF lifecycle management operation occurrence.
The state of the LCM operation.
Date-time when the current state has been entered.
Date-time of the start of the operation.
Identifier of the VNF instance to which the operation applies
Identifier of the grant related to this VNF LCM operation occurrence. Shall be set to the value of the "id" attribute in the "Grant" representing the associated "Individual Grant", if such grant exists.
Type of the actual LCM operation represented by this VNF LCM operation occurrence.
Set to true if this VNF LCM operation occurrence has been triggered by an automated procedure inside the VNFM (i.e. ScaleVnf / ScaleVnfToLevel triggered by auto-scale, or HealVnf triggered by auto-heal). Set to false otherwise.
Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation. In addition, the provisions in clause 5.7 shall apply. The following mapping between operationType and the data type of this attribute shall apply: * INSTANTIATE: InstantiateVnfRequest * SCALE: ScaleVnfRequest * SCALE_TO_LEVEL: ScaleVnfToLevelRequest * CHANGE_FLAVOUR: ChangeVnfFlavourRequest * OPERATE: OperateVnfRequest * HEAL: HealVnfRequest * CHANGE_EXT_CONN: ChangeExtVnfConnectivityRequest * TERMINATE: TerminateVnfRequest * MODIFY_INFO: VnfInfoModifications * CREATE_SNAPSHOT: CreateVnfSnapshotRequest * REVERT_TO_SNAPSHOT: RevertToVnfSnapshotRequest * CHANGE_VNFPKG: ChangeCurrentVnfPkgRequest
If the VNF LCM operation occurrence is in "STARTING", "PROCESSING" or "ROLLING_BACK" state and the operation is being cancelled, this attribute shall be set to true. Otherwise, it shall be set to false.
The mode of an ongoing cancellation. Shall be present when isCancelPending=true, and shall be absent otherwise.
If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState" is "PROCESSING" or "ROLLING_BACK" and previous value of "operationState" was "FAILED_TEMP", this attribute shall be present and contain error information, unless it has been requested to be excluded via an attribute selector.
This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the LCM operation since its start, if applicable.
Information about the changed VNF instance information, including VNF configurable properties, if applicable. See note 1 and note 2.
Information about virtual IP CP instances that were affected during the execution of the lifecycle management operation.
Information about changed external connectivity, if applicable. See note 1.
Information about performed changes of "VnfInstance" attributes triggered by changing the current VNF package, if applicable. Shall be absent if the "operation" attribute is different from "CHANGE_VNFPKG". See notes 1 and 2.
Identifier of the "individual VNF snapshot" resource. Shall be present if applicable to the type of LCM operation, i.e., if the value of the "operation" attribute is either "CREATE_SNAPSHOT" or "REVERT_TO_SNAPSHOT".
Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) related to this LCM operation occurrence.
Information about LCM coordination actions (see clause 10 in ETSI GS NFV-SOL002) that were rejected by 503 error which means they can be tried again after a delay. See note 5.
Warning messages that were generated while the operation was executing. If the operation has included LCM coordination actions and these have resulted in warnings, such warnings should be added to this attribute.
Links to resources related to this resource.
Response Headers
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
The used API version.
The MIME type of the body of the response. Reference: IETF RFC 7231
400 BAD REQUEST 400 code can be returned in the following specified cases, the specific cause has to be proper specified in the "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or the payload body contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the response to a GET request which queries a container resource would be so big that the performance of the API producer is adversely affected, and the API producer does not support paging for the affected resource, it shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. The use of this HTTP error response code described above is applicable to the use of the OAuth 2.0 for the authorization of API requests and notifications, as defined in clauses 4.5.3.3 and 4.5.3.4.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
401 UNAUTHORIZED If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
403 FORBIDDEN If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
404 NOT FOUND If the API producer did not find a current representation for the resource addressed by the URI passed in the request or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable. This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response contains a 200 OK response code and a payload body with an empty array.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
405 METHOD NOT ALLOWED If a particular HTTP method is not supported for a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
406 NOT ACCEPTABLE If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
500 INTERNAL SERVER ERROR If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
503 SERVICE UNAVAILABLE If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.
504 GATEWAY TIMEOUT If the API producer encounters a timeout while waiting for a response from an upstream server (i.e. a server that the API producer communicates with when fulfilling a request), it should respond with this response code.
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
Response Headers
The MIME type of the body of the response.
Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.
Version of the API used in the response.