Ns Update

Ns Update

The POST method updates an NS instance.

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

Identifier of the NS instance to be updated.

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 update NS operation, as defined in clause 6.5.2.12.

UpdateNsRequest of type(s) application/json
Required
{
    "updateType": "string",
    "addVnfIstance": [
        {
            "vnfInstanceId": "string",
            "vnfProfileId": "string"
        }
    ],
    "removeVnfInstanceId": [
        "string"
    ],
    "instantiateVnfData": [
        {
            "vnfdId": "string",
            "vnfFlavourId": "string",
            "vnfInstantiationLevelId": "string",
            "vnfInstanceName": "string",
            "vnfInstanceDescription": "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"
                            }
                        }
                    ]
                }
            ],
            "extManagedVirtualLinks": [
                {
                    "extManagedVirtualLinkId": "string",
                    "vnfVirtualLinkDescId": "string",
                    "vimId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string"
                }
            ],
            "localizationLanguage": "string",
            "locationConstraints": {
                "vnfProfileId": "string",
                "locationConstraints": {
                    "countryCode": "string",
                    "civicAddressElement": [
                        {
                            "caType": 0,
                            "caValue": "string"
                        }
                    ]
                }
            }
        }
    ],
    "changeVnfFlavourData": [
        {
            "vnfInstanceId": "string",
            "newFlavourId": "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"
                            }
                        }
                    ]
                }
            ],
            "extManagedVirtualLinks": [
                {
                    "extManagedVirtualLinkId": "string",
                    "vnfVirtualLinkDescId": "string",
                    "vimId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string"
                }
            ]
        }
    ],
    "operateVnfData": [
        {
            "vnfInstanceId": "string",
            "changeStateTo": "string",
            "stopType": "string",
            "gracefulStopTimeout": 0
        }
    ],
    "modifyVnfInfoData": [
        {
            "vnfInstanceId": "string",
            "vnfInstanceName": "string",
            "vnfInstanceDescription": "string",
            "vnfdId": "string"
        }
    ],
    "changeExtVnfConnectivityData": [
        {
            "vnfInstanceId": "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"
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "addSap": [
        {
            "sapdId": "string",
            "sapName": "string",
            "description": "string",
            "sapProtocolData": [
                {
                    "layerProtocol": "string",
                    "ipOverEthernet": {
                        "macAddress": "string",
                        "ipAddresses": [
                            {
                                "type": "string",
                                "fixedAddresses": [
                                    "string"
                                ],
                                "numDynamicAddresses": 0,
                                "addressRange": {
                                    "minAddress": "string",
                                    "maxAddress": "string"
                                },
                                "subnetId": "string"
                            }
                        ]
                    }
                }
            ]
        }
    ],
    "removeSapId": [
        "string"
    ],
    "addNestedNsData": [
        {
            "nestedNsInstanceId": "string",
            "nsProfileId": "string"
        }
    ],
    "removeNestedNsId": [
        "string"
    ],
    "assocNewNsdVersionData": {
        "newNsdId": "string",
        "sync": false
    },
    "moveVnfInstanceData": [
        {
            "targetNsInstanceId": "string",
            "vnfInstanceId": [
                "string"
            ]
        }
    ],
    "addVnffg": [
        {
            "targetNsInstanceId": "string",
            "vnffgName": "string",
            "description": "string"
        }
    ],
    "removeVnffgId": [
        "string"
    ],
    "updateVnffg": [
        {
            "vnffgInfoId": "string",
            "nfp": [
                {
                    "nfpInfoId": "string",
                    "nfpName": "string",
                    "description": "string",
                    "cpGroup": [
                        {
                            "cpPairInfo": [
                                {
                                    "vnfExtCpIds": [
                                        "string"
                                    ],
                                    "pnfExtCpIds": [
                                        "string"
                                    ],
                                    "sapIds": [
                                        "string"
                                    ]
                                }
                            ],
                            "forwardingBehaviour": "string",
                            "forwardingBehaviourInputParameters": {
                                "algortihmName": "string",
                                "algorithmWeights": [
                                    0
                                ]
                            }
                        }
                    ],
                    "nfpRule": {
                        "etherDestinationAddress": "string",
                        "etherSourceAddress": "string",
                        "etherType": "string",
                        "vlanTag": [
                            "string"
                        ],
                        "protocol": "string",
                        "dscp": "string",
                        "sourcePortRange": {
                            "lowerPort": 0,
                            "upperPort": 0
                        },
                        "destinationPortRange": {
                            "lowerPort": 0,
                            "upperPort": 0
                        },
                        "sourceIpAddressPrefix": "string",
                        "destinationIpAddressPrefix": "string",
                        "extendedCriteria": [
                            {
                                "startingPoint": 0,
                                "length": 0,
                                "value": "string"
                            }
                        ]
                    }
                }
            ],
            "nfpInfoId": [
                "string"
            ]
        }
    ],
    "changeNsFlavourData": {
        "newNsFlavourId": "string",
        "instantiationLevelId": "string"
    },
    "addPnfData": [
        {
            "pnfId": "string",
            "pnfName": "string",
            "pnfdId": "string",
            "pnfProfileId": "string",
            "cpData": [
                {
                    "cpInstanceId": "string",
                    "cpdId": "string",
                    "cpProtocolData": [
                        {
                            "layerProtocol": "string",
                            "ipOverEthernet": {
                                "macAddress": "string",
                                "ipAddresses": [
                                    {
                                        "type": "string",
                                        "fixedAddresses": [
                                            "string"
                                        ],
                                        "numDynamicAddresses": 0,
                                        "addressRange": {
                                            "minAddress": "string",
                                            "maxAddress": "string"
                                        },
                                        "subnetId": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "modifyPnfData": [
        {
            "pnfId": "string",
            "pnfName": "string",
            "cpData": [
                {
                    "cpInstanceId": "string",
                    "cpdId": "string",
                    "cpProtocolData": [
                        {
                            "layerProtocol": "string",
                            "ipOverEthernet": {
                                "macAddress": "string",
                                "ipAddresses": [
                                    {
                                        "type": "string",
                                        "fixedAddresses": [
                                            "string"
                                        ],
                                        "numDynamicAddresses": 0,
                                        "addressRange": {
                                            "minAddress": "string",
                                            "maxAddress": "string"
                                        },
                                        "subnetId": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "removePnfId": [
        "string"
    ],
    "updateTime": "string"
}
string
updateType
Required

The type of update. It determines also which one of the following parameters is present in the operation. Possible values include: * ADD_VNF: Adding existing VNF instance(s) * REMOVE_VNF: Removing VNF instance(s) * INSTANTIATE_VNF: Instantiating new VNF(s) * CHANGE_VNF_DF: Changing VNF DF * OPERATE_VNF: Changing VNF state, * MODIFY_VNF_INFORMATION: Modifying VNF information and/or the configurable properties of VNF instance(s) * CHANGE_EXTERNAL_VNF_CONNECTIVITY: Changing the external connectivity of VNF instance(s) * ADD_SAP: Adding SAP(s) * REMOVE_SAP: Removing SAP(s) * ADD_NESTED_NS: Adding existing NS instance(s) as nested NS(s) * REMOVE_NESTED_NS: Removing existing nested NS instance(s) * ASSOC_NEW_NSD_VERSION: Associating a new NSD version to the NS instance * MOVE_VNF: Moving VNF instance(s) from one origin NS instance to another target NS instance * ADD_VNFFG: Adding VNFFG(s) * REMOVE_VNFFG: Removing VNFFG(s) * UPDATE_VNFFG: Updating VNFFG(s) * CHANGE_NS_DF: Changing NS DF * ADD_PNF: Adding PNF * MODIFY_PNF: Modifying PNF * REMOVE_PNF: Removing PNF

Possible values are : ADD_VNF, REMOVE_VNF, INSTANTIATE_VNF, CHANGE_VNF_DF, OPERATE_VNF, MODIFY_VNF_INFORMATION, CHANGE_EXTERNAL_VNF_CONNECTIVITY, ADD SAP, REMOVE_SAP, ADD_NESTED_NS, REMOVE_NESTED_NS, ASSOC_NEW_NSD_VERSION, MOVE_VNF, ADD_VNFFG, REMOVE_VNFFG, UPDATE_VNFFG, CHANGE_NS_DF, ADD_PNF, MODIFY_PNF, REMOVE_PNF,
addVnfIstance
Optional

Identifies an existing VNF instance to be added to the NS instance. It shall be present only if updateType = "ADD_VNF".

array of Identifier
removeVnfInstanceId
Optional

Identifies an existing VNF instance to be removed from the NS instance. It contains the identifier(s) of the VNF instances to be removed. It shall be present only if updateType = "REMOVE_VNF." Note: If a VNF instance is removed from a NS and this NS was the last one for which this VNF instance was a part, the VNF instance is terminated by the NFVO.

instantiateVnfData
Optional

Identifies the new VNF to be instantiated. It can be used e.g. for the bottom-up NS creation. It shall be present only if updateType = "INSTANTIATE_VNF".

changeVnfFlavourData
Optional

Identifies the new DF of the VNF instance to be changed to. It shall be present only if updateType = "CHANGE_VNF_DF".

operateVnfData
Optional

Identifies the state of the VNF instance to be changed. It shall be present only if updateType = "OPERATE_VNF".

modifyVnfInfoData
Optional

Identifies the VNF information parameters and/or the configurable properties of VNF instance to be modified. It shall be present only if updateType = "MODIFY_VNF_INFORMATION".

changeExtVnfConnectivityData
Optional

Specifies the new external connectivity data of the VNF instance to be changed. It shall be present only if updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".

array of SapData
addSap
Optional

Identifies a new SAP to be added to the NS instance. It shall be present only if updateType = "ADD_SAP."

array of Identifier
removeSapId
Optional

The identifier an existing SAP to be removed from the NS instance. It shall be present only if updateType = "REMOVE_SAP."

addNestedNsData
Optional

The identifier of an existing nested NS instance to be added to (nested within) the NS instance. It shall be present only if updateType = "ADD_NESTED_NS".

removeNestedNsId
Optional

The identifier of an existing nested NS instance to be removed from the NS instance. It shall be present only if updateType = "REMOVE_NESTED_NS".

assocNewNsdVersionData
Optional

assocNewNsdVersionData

moveVnfInstanceData
Optional

Specify existing VNF instance to be moved from one NS instance to another NS instance. It shall be present only if updateType = MOVE_VNF".

addVnffg
Optional

Specify the new VNFFG to be created to the NS Instance. It shall be present only if updateType = "ADD_VNFFG".

array of Identifier
removeVnffgId
Optional

Identifier of an existing VNFFG to be removed from the NS Instance. It shall be present only if updateType = "REMOVE_VNFFG".

updateVnffg
Optional

Specify the new VNFFG Information data to be updated for a VNFFG of the NS Instance. It shall be present only if updateType = "UPDATE_VNFFG".

changeNsFlavourData
Optional

changeNsFlavourData

array of AddPnfData
addPnfData
Optional

specifies the PNF to be added into the NS instance. It shall be present only if updateType = "ADD_PNF".

modifyPnfData
Optional

Specifies the PNF to be modified in the NS instance. It shall be present only if updateType = "MODIFY_PNF".

array of Identifier
removePnfId
Optional

Identifier of the PNF to be deleted from the NS instance. It shall be present only if updateType = "REMOVE_PNF".

updateTime
Optional

updateTime

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.