Update an NsInstance

Use this API to update an NsInstance.

Use this API to update an NsInstance to a new descriptor.

Request

Table 1. Request
Aspect	Value
Endpoint URL	/api/etsi/nslcm/v2/ns_instances/<nsInstanceId>/update
HTTP Method	POST

Table 2. Request headers
Header	Value
Content-Type	application/json
Version	2.0.0

Table 3. Request body
Parameter	Type	Description	Required
assocNewNsdVersionData	object	An AssocNewNsdVersionData object.	Yes
assocNewNsdVersionData.newNsdId	string	A string that contains a new descriptor name.	Yes
assocNewNsdVersionData.sync	Boolean	Whether the NsInstance updates immediately. Must be set to true.	Yes

Where:

nsInstanceId: Corresponds to the assemblyId passed to POST /api/intent/upgradeAssembly.
updateType: Determines what type of update operation to perform. Only `ASSOC_NEW_NSD_VERSION` is supported.
assocNewNsdVersionData.newNsdId: Corresponds to the ` descriptorName` field that is passed to POST /api/intent/ upgradeAssembly.

{
  "updateType": "ASSOC_NEW_NSD_VERSION",
  "assocNewNsdVersionData": {
    "newNsdId": "assembly::basic_assembly::2",
    "sync": true
  }
}

Table 4. Response codes
HTTP status code	Description
202	When the update request is accepted.
404	When an NsInstance with the supplied ID is not found.
409	When the NsInstance is in the NOT_INSTANTIATED state.
4xx/5xx	In addition to the response codes defined in this table, any common error response codes.

Table 5. Response headers
Header	Description
location	On success, this value contains the URL for the Ns LCM operation occurrence for this operation.

On success (202), the response body is empty. On failure, it contains an object that describes the problem that caused it to fail.