Scale NS

Scale NS

The POST method requests to scale a NS instance resource. The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2. In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall reflect the result of scaling the NS instance by updating the "nsScaleStatus" attribute in the representation of the "Individual NS instance" resource.

Request
URI
POST
https://{api_host}/telco/api/nslcm/v2/ns_instances/{nsInstanceId}/scale
COPY
Path Parameters
string
nsInstanceId
Required

Identifier of the NS instance to be scaled.

Header Parameters
string
Accept
Required

Content-Types that are acceptable for the response. Reference: IETF RFC 7231

string
Authorization
Optional

The authorization token for the request. Reference: IETF RFC 7235

string
Content-Type
Required

The MIME type of the body of the request. Reference: IETF RFC 7231

string
Version
Required

Version of the API requested to use when responding to this request.


Request Body

Parameters for the scale NS operation, as defined in clause 6.5.2.14.

ScaleNsRequest of type(s) application/json
Required
{
    "scaleType": "string",
    "scaleNsData": {
        "vnfInstanceToBeAdded": [
            {
                "vnfInstanceId": "string",
                "vnfProfileId": "string"
            }
        ],
        "vnfInstanceToBeRemoved": [
            "string"
        ],
        "scaleNsByStepsData": {
            "scalingDirection": "string",
            "aspectId": "string",
            "numberOfSteps": 0
        },
        "scaleNsToLevelData": {
            "nsInstantiationLevel": "string",
            "nsScaleInfo": [
                {
                    "nsScalingAspectId": "string",
                    "nsScaleLevelId": "string"
                }
            ]
        },
        "additionalParamsForNs": {
            "nfType": "string",
            "entityPrefix": "string",
            "useVAppTemplates": false,
            "catalogName": "string",
            "catalogId": "string",
            "vduParams": [
                {
                    "vduName": "string",
                    "vduId": "string",
                    "deploymentProfileId": "string",
                    "chartName": "string",
                    "namespace": "string",
                    "repoUrl": "string",
                    "username": "string",
                    "password": "string",
                    "extensionId": "string",
                    "overrides": "string",
                    "metadata": [
                        {}
                    ],
                    "catalogName": "string",
                    "catalogId": "string"
                }
            ],
            "instantiationLevelId": "string",
            "extVirtualLinks": [
                {
                    "extVirtualLinkId": "string",
                    "vimId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "extCps": [
                        {
                            "cpdId": "string",
                            "cpConfig": [
                                {
                                    "cpInstanceId": "string",
                                    "linkPortId": "string",
                                    "cpProtocolData": [
                                        {
                                            "layerProtocol": "string",
                                            "ipOverEthernet": {
                                                "macAddress": "string",
                                                "ipAddresses": [
                                                    {
                                                        "type": "string",
                                                        "fixedAddresses": [
                                                            "string"
                                                        ],
                                                        "numDynamicAddresses": 0,
                                                        "addressRange": {
                                                            "minAddress": "string",
                                                            "maxAddress": "string"
                                                        },
                                                        "subnetId": "string"
                                                    }
                                                ]
                                            }
                                        }
                                    ]
                                }
                            ]
                        }
                    ],
                    "extLinkPorts": [
                        {
                            "id": "string",
                            "resourceHandle": {
                                "vimId": "string",
                                "resourceProviderId": "string",
                                "resourceId": "string",
                                "vimLevelResourceType": "string"
                            }
                        }
                    ]
                }
            ],
            "nodeProfileName": "string",
            "vimConnectionInfo": [
                {
                    "id": "string",
                    "vimId": "string",
                    "vimType": "string",
                    "extra": {
                        "deploymentProfileId": "string",
                        "nodeProfileName": "string",
                        "nodePoolId": "string",
                        "nodePoolName": "string",
                        "vimName": "string",
                        "nodePools": [
                            "string"
                        ],
                        "nodePoolBatchSize": 0
                    }
                }
            ],
            "lcmInterfaces": {
                "lcmInterfaces": {
                    "scale_start": [
                        {
                            "name": "USER",
                            "type": "string",
                            "value": "root"
                        },
                        {
                            "name": "PWD",
                            "type": "password",
                            "value": "Y2EkaGMwdw=="
                        },
                        {
                            "name": "HOSTNAME",
                            "type": "string",
                            "value": "10.176.160.54"
                        },
                        {
                            "name": "CMD",
                            "type": "string",
                            "value": "uptime"
                        },
                        {
                            "name": "VIM_LOCATION",
                            "type": "location",
                            "value": "vmware_641917F756584A7FA21F455F775D5F66"
                        }
                    ],
                    "scale_end": [
                        {
                            "name": "USER",
                            "type": "string",
                            "value": "root"
                        },
                        {
                            "name": "PWD",
                            "type": "password",
                            "value": "Y2EkaGMwdw=="
                        },
                        {
                            "name": "HOSTNAME",
                            "type": "string",
                            "value": "10.176.160.54"
                        },
                        {
                            "name": "CMD",
                            "type": "string",
                            "value": "uptime"
                        },
                        {
                            "name": "VIM_LOCATION",
                            "type": "location",
                            "value": "vmware_641917F756584A7FA21F455F775D5F66"
                        }
                    ]
                }
            },
            "isVnfVAppTemplate": false,
            "vAppTemplateName": "string",
            "storageProfiles": [
                "string"
            ]
        },
        "additionalParamsForVnf": [
            {
                "vnfProfileId": "string",
                "vnfInstanceName": "string",
                "vnfInstanceDescription": "string",
                "additionalParams": {
                    "nfType": "string",
                    "entityPrefix": "string",
                    "useVAppTemplates": false,
                    "catalogName": "string",
                    "catalogId": "string",
                    "vduParams": [
                        {
                            "vduName": "string",
                            "vduId": "string",
                            "deploymentProfileId": "string",
                            "chartName": "string",
                            "namespace": "string",
                            "repoUrl": "string",
                            "username": "string",
                            "password": "string",
                            "extensionId": "string",
                            "overrides": "string",
                            "metadata": [
                                {}
                            ],
                            "catalogName": "string",
                            "catalogId": "string"
                        }
                    ],
                    "instantiationLevelId": "string",
                    "extVirtualLinks": [
                        {
                            "extVirtualLinkId": "string",
                            "vimId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "extCps": [
                                {
                                    "cpdId": "string",
                                    "cpConfig": [
                                        {
                                            "cpInstanceId": "string",
                                            "linkPortId": "string",
                                            "cpProtocolData": [
                                                {
                                                    "layerProtocol": "string",
                                                    "ipOverEthernet": {
                                                        "macAddress": "string",
                                                        "ipAddresses": [
                                                            {
                                                                "type": "string",
                                                                "fixedAddresses": [
                                                                    "string"
                                                                ],
                                                                "numDynamicAddresses": 0,
                                                                "addressRange": {
                                                                    "minAddress": "string",
                                                                    "maxAddress": "string"
                                                                },
                                                                "subnetId": "string"
                                                            }
                                                        ]
                                                    }
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ],
                            "extLinkPorts": [
                                {
                                    "id": "string",
                                    "resourceHandle": {
                                        "vimId": "string",
                                        "resourceProviderId": "string",
                                        "resourceId": "string",
                                        "vimLevelResourceType": "string"
                                    }
                                }
                            ]
                        }
                    ],
                    "nodeProfileName": "string",
                    "vimConnectionInfo": [
                        {
                            "id": "string",
                            "vimId": "string",
                            "vimType": "string",
                            "extra": {
                                "deploymentProfileId": "string",
                                "nodeProfileName": "string",
                                "nodePoolId": "string",
                                "nodePoolName": "string",
                                "vimName": "string",
                                "nodePools": [
                                    "string"
                                ],
                                "nodePoolBatchSize": 0
                            }
                        }
                    ],
                    "lcmInterfaces": {
                        "lcmInterfaces": {
                            "scale_start": [
                                {
                                    "name": "USER",
                                    "type": "string",
                                    "value": "root"
                                },
                                {
                                    "name": "PWD",
                                    "type": "password",
                                    "value": "Y2EkaGMwdw=="
                                },
                                {
                                    "name": "HOSTNAME",
                                    "type": "string",
                                    "value": "10.176.160.54"
                                },
                                {
                                    "name": "CMD",
                                    "type": "string",
                                    "value": "uptime"
                                },
                                {
                                    "name": "VIM_LOCATION",
                                    "type": "location",
                                    "value": "vmware_641917F756584A7FA21F455F775D5F66"
                                }
                            ],
                            "scale_end": [
                                {
                                    "name": "USER",
                                    "type": "string",
                                    "value": "root"
                                },
                                {
                                    "name": "PWD",
                                    "type": "password",
                                    "value": "Y2EkaGMwdw=="
                                },
                                {
                                    "name": "HOSTNAME",
                                    "type": "string",
                                    "value": "10.176.160.54"
                                },
                                {
                                    "name": "CMD",
                                    "type": "string",
                                    "value": "uptime"
                                },
                                {
                                    "name": "VIM_LOCATION",
                                    "type": "location",
                                    "value": "vmware_641917F756584A7FA21F455F775D5F66"
                                }
                            ]
                        }
                    },
                    "isVnfVAppTemplate": false,
                    "vAppTemplateName": "string",
                    "storageProfiles": [
                        "string"
                    ]
                }
            }
        ],
        "locationConstraints": [
            {
                "vnfProfileId": "string",
                "locationConstraints": {
                    "countryCode": "string",
                    "civicAddressElement": [
                        {
                            "caType": 0,
                            "caValue": "string"
                        }
                    ]
                }
            }
        ]
    },
    "scaleVnfData": [
        {
            "vnfInstanceid": "string",
            "scaleVnfType": "string",
            "scaleToLevelData": {
                "vnfInstantiationLevelId": "string",
                "vnfScaleInfo": [
                    {
                        "aspectId": "string",
                        "scaleLevel": 0
                    }
                ],
                "additionalParams": {
                    "nfType": "string",
                    "vduParams": [
                        {
                            "vduName": "string",
                            "vduId": "string",
                            "deploymentProfileId": "string",
                            "chartName": "string",
                            "namespace": "string",
                            "repoUrl": "string",
                            "username": "string",
                            "password": "string",
                            "extensionId": "string",
                            "overrides": "string",
                            "metadata": [
                                {}
                            ],
                            "catalogName": "string",
                            "catalogId": "string"
                        }
                    ]
                }
            },
            "scaleByStepData": {
                "aspectId": "string",
                "numberOfSteps": 0,
                "additionalParams": {
                    "nfType": "string",
                    "vduParams": [
                        {
                            "vduName": "string",
                            "vduId": "string",
                            "deploymentProfileId": "string",
                            "chartName": "string",
                            "namespace": "string",
                            "repoUrl": "string",
                            "username": "string",
                            "password": "string",
                            "extensionId": "string",
                            "overrides": "string",
                            "metadata": [
                                {}
                            ],
                            "catalogName": "string",
                            "catalogId": "string"
                        }
                    ]
                }
            }
        }
    ],
    "scaleTime": "string"
}
string
scaleType
Required

Indicates the type of scaling to be performed. Possible values: - SCALE_NS - SCALE_VNF

Possible values are : SCALE_NS, SCALE_VNF,
scaleNsData
Optional

scaleNsData

scaleVnfData
Optional

The necessary information to scale the referenced NS instance. It shall be present when scaleType = SCALE_VNF.

scaleTime
Optional

scaleTime

Authentication
This operation uses the following authentication methods.
Responses
202
Operation doesn't return any data structure

400
Returns 400 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


401
Returns 401 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


403
Returns 403 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


404
Returns 404 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


405
Returns 405 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


406
Returns 406 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


409
Returns 409 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


500
Returns 500 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


503
Returns 503 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.


504
Returns 504 of type(s) */*
{
    "type": "string",
    "title": "string",
    "status": 0,
    "detail": "string",
    "instance": "string"
}
string As URI As URI
type
Optional

A URI reference according to IETF RFC 3986 [5] 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".

string
title
Optional

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).

integer
status
Required

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.

string
detail
Required

A human-readable explanation specific to this occurrence of the problem.

string As URI As URI
instance
Optional

A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.