Create Ns

Create Ns

The POST method creates a new NS instance resource. As the result of successfully executing this method, a new "Individual NS instance" resource as defined in clause 6.4.3 shall have been created, and the value of the "instantiationState" attribute in the representation of that resource shall be "NOT_INSTANTIATED". A notification of type NsIdentifierCreationNotification shall be triggered as part of successfully executing this method as defined in clause 6.5.2.6.

Request
URI
POST
https://{api_host}/telco/api/nslcm/v2/ns_instances
COPY
Header Parameters
string
Authorization
Optional

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

string
Version
Required

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

string
Accept
Required

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

string
Content-Type
Required

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


Request Body

The NS creation parameters, as defined in clause 6.5.2.7.

CreateNsRequest of type(s) application/json
Required
{
    "nsdId": "string",
    "nsName": "string",
    "nsDescription": "string"
}
nsdId
Required

nsdId

string
nsName
Required

Human-readable name of the NS instance to be created.

string
nsDescription
Required

Human-readable description of the NS instance to be created.

Authentication
This operation uses the following authentication methods.
Responses
201

201 Created Shall be returned when a new "Individual NS instance" resource and the associated NS instance identifier has been created successfully. The response body shall contain a representation of the created NS instance, as defined in clause 6.5.2.10. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created NS instance.

Returns NsInstance of type(s) */*
{
    "id": "string",
    "nsInstanceName": "string",
    "nsInstanceDescription": "string",
    "nsdId": "string",
    "nsdInfoId": "string",
    "flavourId": "string",
    "vnfInstance": [
        {
            "id": "string",
            "vnfInstanceName": "string",
            "vnfInstanceDescription": "string",
            "vnfdId": "string",
            "vnfProvider": "string",
            "vnfProductName": "string",
            "vnfSoftwareVersion": "string",
            "vnfdVersion": "string",
            "vnfPkgId": "string",
            "vimId": "string",
            "instantiationState": "string",
            "instantiatedVnfInfo": {
                "flavourId": "string",
                "vnfState": "string",
                "scaleStatus": [
                    {
                        "aspectId": "string",
                        "scaleLevel": 0
                    }
                ],
                "maxScaleLevels": [
                    {
                        "aspectId": "string",
                        "scaleLevel": 0
                    }
                ],
                "extCpInfo": [
                    {
                        "id": "string",
                        "cpdId": "string",
                        "cpProtocolInfo": [
                            {
                                "layerProtocol": "string",
                                "ipOverEthernet": {
                                    "macAddress": "string",
                                    "ipAddresses": [
                                        {
                                            "type": "string",
                                            "addresses": [
                                                "string"
                                            ],
                                            "isDynamic": false,
                                            "addressRange": {
                                                "minAddress": "string",
                                                "maxAddress": "string"
                                            },
                                            "subnetId": "string"
                                        }
                                    ],
                                    "type": "string",
                                    "addresses": "string",
                                    "isDynamic": false,
                                    "addressRange": {
                                        "minAddress": "string",
                                        "maxAddress": "string"
                                    },
                                    "minAddress": "string",
                                    "maxAddress": "string",
                                    "subnetId": "string"
                                }
                            }
                        ],
                        "extLinkPortId": {
                            "layerProtocol": "string",
                            "ipOverEthernet": {
                                "macAddress": "string",
                                "ipAddresses": [
                                    {
                                        "type": "string",
                                        "addresses": [
                                            "string"
                                        ],
                                        "isDynamic": false,
                                        "addressRange": {
                                            "minAddress": "string",
                                            "maxAddress": "string"
                                        },
                                        "subnetId": "string"
                                    }
                                ],
                                "type": "string",
                                "addresses": "string",
                                "isDynamic": false,
                                "addressRange": {
                                    "minAddress": "string",
                                    "maxAddress": "string"
                                },
                                "minAddress": "string",
                                "maxAddress": "string",
                                "subnetId": "string"
                            }
                        },
                        "associatedVnfcCpId": "string",
                        "associatedVnfVirtualLinkId": "string"
                    }
                ],
                "extVirtualLinkInfo": [
                    {
                        "id": "string",
                        "resourceHandle": {
                            "vimId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "extLinkPorts": [
                            {
                                "id": "string",
                                "resourceHandle": {
                                    "vimId": "string",
                                    "resourceProviderId": "string",
                                    "resourceId": "string",
                                    "vimLevelResourceType": "string"
                                },
                                "cpInstanceId": "string"
                            }
                        ]
                    }
                ],
                "extManagedVirtualLinkInfo": [
                    {
                        "id": "string",
                        "vnfVirtualLinkDescId": "string",
                        "networkResource": {
                            "vimId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "vnfLinkPorts": [
                            {
                                "id": "string",
                                "resourceHandle": {
                                    "vimId": "string",
                                    "resourceProviderId": "string",
                                    "resourceId": "string",
                                    "vimLevelResourceType": "string"
                                },
                                "cpInstanceId": "string",
                                "cpInstanceType": "string"
                            }
                        ]
                    }
                ],
                "monitoringParameters": [
                    {
                        "id": "string",
                        "name": "string",
                        "performanceMetric": "string"
                    }
                ],
                "localizationLanguage": "string",
                "vnfcResourceInfo": [
                    {
                        "id": "string",
                        "vduId": "string",
                        "computeResource": {
                            "vimId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "storageResourceIds": [
                            "string"
                        ],
                        "reservationId": "string",
                        "vnfcCpInfo": [
                            {
                                "id": "string",
                                "cpdId": "string",
                                "vnfExtCpId": "string",
                                "cpProtocolInfo": [
                                    {
                                        "layerProtocol": "string",
                                        "ipOverEthernet": {
                                            "macAddress": "string",
                                            "ipAddresses": [
                                                {
                                                    "type": "string",
                                                    "addresses": [
                                                        "string"
                                                    ],
                                                    "isDynamic": false,
                                                    "addressRange": {
                                                        "minAddress": "string",
                                                        "maxAddress": "string"
                                                    },
                                                    "subnetId": "string"
                                                }
                                            ],
                                            "type": "string",
                                            "addresses": "string",
                                            "isDynamic": false,
                                            "addressRange": {
                                                "minAddress": "string",
                                                "maxAddress": "string"
                                            },
                                            "minAddress": "string",
                                            "maxAddress": "string",
                                            "subnetId": "string"
                                        }
                                    }
                                ],
                                "vnfLinkPortId": "string"
                            }
                        ]
                    }
                ],
                "virtualLinkResourceInfo": [
                    {
                        "id": "string",
                        "vnfVirtualLinkDescId": "string",
                        "networkResource": {
                            "vimId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "reservationId": "string",
                        "vnfLinkPorts": [
                            {
                                "id": "string",
                                "resourceHandle": {
                                    "vimId": "string",
                                    "resourceProviderId": "string",
                                    "resourceId": "string",
                                    "vimLevelResourceType": "string"
                                },
                                "cpInstanceId": "string",
                                "cpInstanceType": "string"
                            }
                        ]
                    }
                ],
                "virtualStorageResourceInfo": [
                    {
                        "id": "string",
                        "virtualStorageDescId": "string",
                        "storageResource": {
                            "vimId": "string",
                            "resourceProviderId": "string",
                            "resourceId": "string",
                            "vimLevelResourceType": "string"
                        },
                        "reservationId": "string"
                    }
                ]
            },
            "extensions": {
                "managedBy": {
                    "extensionSubtype": "string",
                    "extensionName": "string"
                },
                "type": "string",
                "networks": [
                    {
                        "resourceId": "string",
                        "networkName": "string",
                        "vl_id": "string",
                        "key_name": "string"
                    }
                ],
                "vimName": "string",
                "lcmOperation": "string",
                "lcmOperationState": "string",
                "isOrchestrated": false
            }
        }
    ],
    "pnfInfo": [
        {
            "pnfId": "string",
            "pnfName": "string",
            "pnfdId": "string",
            "pnfdInfoId": "string",
            "pnfProfileId": "string",
            "cpInfo": {
                "cpInstanceId": "string",
                "cpdId": "string",
                "cpProtocolData": [
                    {
                        "layerProtocol": "string",
                        "ipOverEthernet": {
                            "macAddress": "string",
                            "ipAddresses": [
                                {
                                    "type": "string",
                                    "fixedAddresses": [
                                        "string"
                                    ],
                                    "numDynamicAddresses": 0,
                                    "addressRange": {
                                        "minAddress": "string",
                                        "maxAddress": "string"
                                    },
                                    "subnetId": "string"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ],
    "virtualLinkInfo": [
        {
            "id": "string",
            "nsVirtualLinkDescId": "string",
            "nsVirtualLinkProfileId": "string",
            "resourceHandle": [
                {
                    "vimId": "string",
                    "resourceProviderId": "string",
                    "resourceId": "string",
                    "vimLevelResourceType": "string"
                }
            ],
            "linkPort": [
                {
                    "id": "string",
                    "resourceHandle": {
                        "vimId": "string",
                        "resourceProviderId": "string",
                        "resourceId": "string",
                        "vimLevelResourceType": "string"
                    },
                    "nsCpHandle": [
                        {
                            "vnfInstanceId": "string",
                            "vnfExtCpInstanceId": "string",
                            "pnfInfoId": "string",
                            "pnfExtCpInstanceId": "string",
                            "nsInstanceId": "string",
                            "nsSapInstanceId": "string"
                        }
                    ]
                }
            ]
        }
    ],
    "vnffgInfo": [
        {
            "id": "string",
            "vnffgdId": "string",
            "vnfInstanceId": [
                "string"
            ],
            "pnfdInfoId": [
                "string"
            ],
            "nsVirtualLinkInfoId": [
                "string"
            ],
            "nsCpHandle": [
                {
                    "vnfInstanceId": "string",
                    "vnfExtCpInstanceId": "string",
                    "pnfInfoId": "string",
                    "pnfExtCpInstanceId": "string",
                    "nsInstanceId": "string",
                    "nsSapInstanceId": "string"
                }
            ]
        }
    ],
    "sapInfo": [
        {
            "id": "string",
            "sapdId": "string",
            "sapName": "string",
            "description": "string",
            "sapProtocolInfo": [
                {
                    "layerProtocol": "string",
                    "ipOverEthernet": {
                        "macAddress": "string",
                        "ipAddresses": [
                            {
                                "type": "string",
                                "addresses": [
                                    "string"
                                ],
                                "isDynamic": false,
                                "addressRange": {
                                    "minAddress": "string",
                                    "maxAddress": "string"
                                },
                                "subnetId": "string"
                            }
                        ],
                        "type": "string",
                        "addresses": "string",
                        "isDynamic": false,
                        "addressRange": {
                            "minAddress": "string",
                            "maxAddress": "string"
                        },
                        "minAddress": "string",
                        "maxAddress": "string",
                        "subnetId": "string"
                    }
                }
            ]
        }
    ],
    "nestedNsInstanceId": [
        "string"
    ],
    "nsState": "string",
    "monitoringParameter": [
        {
            "id": "string",
            "name": "string",
            "performanceMetric": "string"
        }
    ],
    "nsScaleStatus": [
        {
            "nsScalingAspectId": "string",
            "nsScaleLevelId": "string"
        }
    ],
    "additionalAffinityOrAntiAffinityRule": [
        {
            "vnfdId": [
                "string"
            ],
            "vnfProfileId": [
                "string"
            ],
            "vnfInstanceId": [
                "string"
            ],
            "affinityOrAntiAffiinty": "string",
            "scope": "string"
        }
    ],
    "_links": {
        "self": {
            "href": "string"
        },
        "nestedNsInstances": [
            {
                "href": "string"
            }
        ],
        "instantiate": {
            "href": "string"
        },
        "terminate": {
            "href": "string"
        },
        "update": {
            "href": "string"
        },
        "scale": {
            "href": "string"
        },
        "heal": {
            "href": "string"
        }
    }
}
id
Required

id

string
nsInstanceName
Required

Human readable name of the NS instance.

string
nsInstanceDescription
Required

Human readable description of the NS instance.

nsdId
Required

nsdId

nsdInfoId
Required

nsdInfoId

flavourId
Optional

flavourId

vnfInstance
Optional

Information on constituent VNF(s) of the NS instance.

array of PnfInfo
pnfInfo
Optional

Information on the PNF(s) that are part of the NS instance.

virtualLinkInfo
Optional

Information on the VL(s) of the NS instance. This attribute shall be present if the nsState attribute value is INSTANTIATED and if the NS instance has specified connectivity.

array of VnffgInfo
vnffgInfo
Optional

Information on the VNFFG(s) of the NS instance.

array of SapInfo
sapInfo
Optional

Information on the SAP(s) of the NS instance.

array of Identifier
nestedNsInstanceId
Optional

Identifier of the nested NS(s) of the NS instance.

string
nsState
Required

The state of the NS instance. Permitted values: NOT_INSTANTIATED: The NS instance is terminated or not instantiated. INSTANTIATED: The NS instance is instantiated.

Possible values are : NOT_INSTANTIATED, INSTANTIATED,
monitoringParameter
Optional

Performance metrics tracked by the NFVO (e.g. for auto-scaling purposes) as identified by the NS designer in the NSD.

nsScaleStatus
Optional

Status of each NS scaling aspect declared in the applicable DF, how "big" the NS instance has been scaled w.r.t. that aspect. This attribute shall be present if the nsState attribute value is INSTANTIATED.

additionalAffinityOrAntiAffinityRule
Optional

Information on the additional affinity or anti-affinity rule from NS instantiation operation. Shall not conflict with rules already specified in the NSD.

object
_links
Required

Links to resources related to this resource.

Response Headers

string
Content-Type

The MIME type of the body of the response.This header field shall be present if the response has a non-empty message body.

string
WWW-Authenticate

Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

string
Version

Version of the API used in the response.


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.


416
Returns 416 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.