8 RESTful HTTP-based solution set of performance measurement job control service specific operations and notifications
28.5503GPPManagement and orchestrationPerformance assuranceRelease 18TS
8.1 Mapping of operations
8.1.1 Introduction
The IS operations are mapped to SS equivalents according to table 8.1.1-1.
Table 8.1.1-1: Mapping of IS operations to SS equivalents
|
IS operation |
HTTP Method |
Resource URI |
Qualifier |
|
createMeasurementJob |
POST |
/measJobs |
M |
|
listMeasurementJobs |
GET |
/measJobs |
M |
|
/measJobs/{jobId} |
M |
||
|
stopMeasurementJob |
DELETE |
/measJobs/{jobId} |
M |
8.1.2 Operation createMeasurementJob
The IS operation parameters are mapped to SS equivalents according to table 8.1.2-1 and table 8.1.2-2.
Table 8.1.2-1: Mapping of IS operation input parameters to SS equivalents (HTTP POST)
|
IS operation parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
Qualifier |
|
iOCName |
request body |
iOCName |
string |
M |
|
iOCInstanceList |
request body |
iOCInstanceList |
array(uri-Type) |
M |
|
measurementCategoryList |
request body |
measurementCategoryList |
array(string) |
M |
|
reportingMethod |
request body |
reportingMethod |
reportingMethodType |
M |
|
granularityPeriod |
request body |
granularityPeriod |
Integer |
M |
|
reportingPeriod |
request body |
reportingPeriod |
Integer |
M |
|
startTime |
request body |
startTime |
dateTime-Type |
O |
|
stopTime |
request body |
stopTime |
dateTime-Type |
O |
|
schedule |
request body |
schedule |
ScheduleType |
O |
|
streamTarget |
request body |
streamTarget |
string |
M |
|
priority |
request body |
priority |
PriorityType |
O |
|
reliability |
request body |
reliability |
string |
O |
Table 8.1.2-2: Mapping of IS operation output parameters to SS equivalents (HTTP POST)
|
IS operation parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
Qualifier |
|
jobId |
Location header |
href |
uri-Type |
M |
|
unsupportedList |
response body |
unsupportedList |
array(unsupportedMeas-Type) |
M |
|
status |
response status codes response body |
n/a error |
n/a error-ResponseType |
M |
8.1.3 Operation listMeasurementJobs
The IS operation parameters are mapped to SS equivalents according to table 8.1.3-1 and table 8.1.3-2.
Table 8.1.3-1: Mapping of IS operation input parameters to SS equivalents (HTTP GET)
|
IS operation parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
Qualifier |
|
jobIdList |
Path Query |
MeasJobs/{jobId} jobIdList |
jobId: string array(string) |
O |
Table 8.1.3-2: Mapping of IS operation output parameters to SS equivalents (HTTP POST)
|
IS operation parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
Qualifier |
|
jobInfoList |
response body |
data |
measJobsRetrieval-ResponseType |
O |
|
status |
response status codes response body |
n/a error |
n/a error-ResponseType |
M |
8.1.4 Operation stopMeasurementJob
The IS operation parameters are mapped to SS equivalents according to table 8.1.4-1 and table 8.1.4-2.
Table 8.1.4-1: Mapping of IS operation input parameters to SS equivalents (HTTP DELETE)
|
IS operation parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
Qualifier |
|
jobId |
path |
/MeasJobs/{jobId} |
jobId:string |
M |
Table 8.1.4-2: Mapping of IS operation output parameters to SS equivalents (HTTP DELETE)
|
IS operation parameter name |
SS parameter location |
SS parameter name |
SS parameter type |
Qualifier |
|
status |
response status codes response body |
n/a error |
n/a error-ResponseType |
M |
8.2 Resources
8.2.0 Resource structure
Figure 8.2.0-1 shows the resource structure of the performance measurement job control service.
Figure 8.2.0-1: Resource URI structure of the performance measurement job control service
Table 8.2.0-1 provides an overview of the resources and applicable HTTP methods.
Table 8.2.0-1: Resources and methods overview
|
Resource name |
Resource URI |
HTTP method |
Description |
|
measJobs |
/measJobs |
GET |
Retrieve all or a list of measurement jobs |
|
POST |
Create a measurement job |
||
|
measJob |
/measJobs /{jobId} |
GET |
Retrieve a measurement job |
|
DELETE |
Stop a measurement job |
8.2.1 Resource definitions
8.2.1.1 Void
8.2.1.2 Resource “/measJobs”
8.2.1.2.1 Description
This resource represents a collection of measurement jobs.
8.2.1.2.2 URI
Resource URI = {MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}/measJobs
The resource URI variables a defined in the following table.
Table 8.2.1.2.2-1: URI variables
|
Name |
Definition |
|
MnSRoot |
See subclause 4.4.3 of TS 32.158 [14] |
|
MnSVersion |
See subclause 4.4.3 of TS 32.158 [14] |
8.2.1.2.3 HTTP methods
8.2.1.2.3.1 HTTP POST
This method shall support the URI query parameters specified in the following table.
Table 8.2.1.2.3.1-1: URI query parameters supported by the POST method on this resource
|
Name |
Data type |
Description |
SQ |
This method shall support the request data structures, the response data structures and response codes specified in the following table.
Table 8.2.1.2.3.1-2: Data structures supported by the POST request body on this resource
|
Data type |
Description |
SQ |
|
measJobCreation-RequestType |
The resource representation of the measurement job to be created |
M |
Table 8.2.1.2.3.1-3: Data structures supported by the POST Response Body on this resource
|
Data type |
Response codes |
Description |
SQ |
|
measJobCreation-ResponseType |
201 Created |
In case of success the representation of the created measurement job is returned. |
M |
|
202 Partially created |
In case of partial success the representation of the created measurement job with unsupported list is returned. |
||
|
error-Type |
4xx/5xx |
Returned in case of an error |
M |
8.2.1.2.3.2 HTTP GET
This method shall support the URI query parameters specified in the following table.
Table 8.2.1.2.3.2-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
Description |
SQ |
|
jobIdList |
Array (string) |
This parameter extends the set of targeted resources beyond the base resource identified with the path component of the URI. No scoping mechanism is specified in the present release. |
O |
This method shall support the request data structures, the response data structures and response codes specified in the following tables.
Table 8.2.1.2.3.2-2: Data structures supported by the GET request body on this resource
|
Data type |
Description |
SQ |
Table 8.2.1.2.3.2-3: Data structures supported by the GET response body on this resource
|
Data type |
Response codes |
Description |
SQ |
|
measJobsRetrieval-ResponseType |
200 OK |
The resource representations of the measurement job list retrieved. |
M |
|
error-ResponseType |
4xx/5xx |
Returned in case of an error |
M |
8.2.1.3 Resource “/measJobs/{jobId}”
8.2.1.3.1 Description
This resource represents a measurement job.
8.2.1.3.2 URI
Resource URI = {MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}/measJobs/{jobId}
The resource URI variables a defined in the following table.
Table 8.2.1.3.2-1: URI variables
|
Name |
Definition |
|
MnSRoot |
See subclause 4.4.3 of TS 32.158 [14] |
|
MnSVersion |
See subclause 4.4.3 of TS 32.158 [14] |
|
jobId |
The id of the measurement job |
8.2.1.3.3 HTTP methods
8.2.1.3.3.1 HTTP GET
This method shall support the URI query parameters specified in the following table.
Table 8.2.1.3.3.1-1: URI query parameters supported by the GET method on this resource
|
Name |
Data type |
Description |
SQ |
This method shall support the request data structures, the response data structures and response codes specified in the following tables.
Table 8.2.1.3.3.1-2: Data structures supported by the GET request body on this resource
|
Data type |
Description |
SQ |
|
n/a |
n/a |
n/a |
Table 8.2.1.3.3.1-3: Data structures supported by the GET response body on this resource
|
Data type |
Response codes |
Description |
SQ |
|
measJobsRetrieval-ResponseType |
200 OK |
The resource representations of the measurement job retrieved. |
M |
|
error-ResponseType |
4xx/5xx |
Returned in case of an error |
M |
8.2.1.3.3.2 HTTP DELETE
This method shall support the URI query parameters specified in the following table.
Table 8.2.1.3.3.2-1: URI query parameters supported by the DELETE method on this resource
|
Name |
Data type |
Description |
SQ |
This method shall support the request data structures, the response data structures and response codes specified in the following tables.
Table 8.2.1.3.3.2-2: Data structures supported by the DELETE request body on this resource
|
Data type |
Description |
SQ |
|
n/a |
n/a |
n/a |
Table 8.2.1.3.3.2-3: Data structures supported by the DELETE response body on this resource
|
Data type |
Response codes |
Description |
SQ |
|
n/a |
204 No Content |
In case of success no message body is returned |
M |
|
error-ResponseType |
4xx/5xx |
Returned in case of an error |
M |
8.3 Data type definitions
8.3.1 General
Table 8.3.1-1: Data types defined in this specification
|
Data type |
Reference |
Description |
|
General types |
||
|
dataTime-Type |
8.3.8.2 |
Data type of date and time. |
|
uri-Type |
8.3.8.2 |
The data type of a URI |
|
Types used in paths |
||
|
Types used in query parts |
||
|
Types used in request bodies |
||
|
measJobCreation-RequestType |
8.3.6.1 |
Used in the request body of HTTP POST describing the measurement job to be created |
|
Types used in response bodies |
||
|
measJobCreation-ResponseType |
8.3.6.2 |
Used in the response body of HTTP POST describing the measurement job created |
|
measJobsRetrieval-ResponseType |
8.3.6.3 |
Used in the response body of HTTP GET describing the measurement job(s) retrieved |
|
error-ResponseType |
8.3.6.4 |
Used in the response body describing the error. |
|
Types used for resources |
||
|
measJobInfo-ResourceType |
8.3.6.5 |
Used for representation of the measurement job information. |
|
Types referenced by the definitions above |
||
|
reportingMethod-Type |
8.3.8.3 |
This defines the data type for reporting method. |
|
schedule-Type |
8.3.7.1 |
This defines the data type for schedule. |
|
priority-Type |
8.3.8.4 |
This defines the data type for priority of the measurement job. |
|
unsupportedMeas-Type |
8.3.7.5 |
This defines the data type for the unsupported measurement types for an IOC instance. |
Table 8.3.1-2: Data types imported
|
Data type |
Reference |
Description |
8.3.2 Void
8.3.3 Void
8.3.4 Structured general data types
None.
8.3.5 Structured path data types
None.
8.3.6 Query, message body and resource data types
8.3.6.1 Type measJobCreation-RequestType
Table 8.3.6.1-1: Definition of type measJobCreation-RequestType
|
Attribute name |
Data type |
Description |
SQ |
|
iOCName |
string |
The IOC name of the IOC instances for which the measurement job is to be created. |
M |
|
iOCInstanceList |
array(uri-Type) |
The URI(s) of the IOC instances for which the measurement job is to be created. |
M |
|
measurementCategoryList |
array(string) |
The list of measurement type(s) to be measured. |
M |
|
reportingMethod |
reportingMethod-Type |
The reporting method of the measurements to be collected, i.e., by performance data file or by performance data streaming. |
M |
|
granularityPeriod |
Integer |
The granularity period of the measurement job. |
M |
|
reportingPeriod |
Integer |
The reporting period of the measurement job. |
M |
|
startTime |
dateTime-Type |
The begin time from which the measurement job will be active. |
O |
|
stopTime |
dateTime-Type |
The end time after which the measurement job will be stopped. |
O |
|
schedule |
schedule-Type |
The detailed time frames (within the startTime and stopTime) during which the measurement job is active and monitors the measurement type(s). |
O |
|
streamTarget |
string |
The target of performance data streams carrying the performance data stream unit(s). |
M |
|
priority |
priority-Type |
The priority of the measurement job. |
O |
|
reliability |
string |
The reliability of the measurement job. |
O |
8.3.6.2 Type measJobCreation-ResponseType
Table 8.3.6.2-1: Definition of type measJobCreation-ResponseType
|
Attribute name |
Data type |
Description |
SQ |
|
unsupportedList |
array(unsupportedMeas-Type) |
The list of unsupported IOC instances, unsupported measurement types and reason. |
M |
8.3.6.3 Type measJobsRetrieval-ResponseType
Table 8.3.6.3-1: Definition of type measJobsRetrieval-ResponseType
|
Attribute name |
Data type |
Description |
SQ |
|
jobInfoList |
array(measJobInfo-ResourceType) |
The list of measurement job information. |
M |
8.3.6.4 Type error-ResponseType
Table 8.3.6.4-1: Definition of type error-ResponseType
|
Attribute name |
Data type |
Description |
SQ |
|
error |
object |
Key indicating the response body containing an error |
M |
|
> errorInfo |
string |
Attribute allowing to convey error information in string format |
M |
8.3.6.5 Type measJobInfo-ResourceType
Table 8.3.6.3-1: Definition of type measJobsRetrieval-ResponseType
|
Attribute name |
Data type |
Description |
SQ |
|
href |
uri-Type |
The URI of the measurement job. |
M |
|
iOCName |
string |
The IOC name of the IOC instances for which the measurement job created. |
M |
|
iOCInstanceList |
array(uri-Type) |
The URI(s) of the IOC instances for which the measurement job is created. |
M |
|
measurementCategoryList |
array(string) |
The list of measurement type(s) measured. |
M |
|
reportingMethod |
reportingMethod-Type |
The reporting method of the measurements, i.e., by performance data file or by performance data streaming. |
M |
|
granularityPeriod |
Integer |
The granularity period of the measurement job. |
M |
|
reportingPeriod |
Integer |
The reporting period of the measurement job. |
M |
|
startTime |
dateTime-Type |
The begin time from which the measurement job is active. |
O |
|
stopTime |
dateTime-Type |
The end time after which the measurement job will be stopped. |
O |
|
schedule |
schedule-Type |
The detailed time frames (within the startTime and stopTime) during which the measurement job is active and monitors the measurement type(s). |
O |
|
streamTarget |
string |
The target of performance data streams carrying the performance data stream unit(s). |
M |
|
priority |
priority-Type |
The priority of the measurement job. |
O |
|
reliability |
string |
The reliability of the measurement job. |
O |
8.3.7 Referenced structured data types
8.3.7.1 Type schedule-Type
Table 8.3.7.1-1: Definition of schedule-Type
|
Attribute name |
Data type |
Description |
SQ |
|
scheduleOption |
scheduleOption-Type |
It indicates the schedule is daily or weekly |
M |
|
dailySchedule |
array(timeInterval-Type) |
It defines the daily schedule. |
M |
|
weeklySchedule |
array(scheduleOfDay-Type) |
It defines the weekly schedule. |
M |
8.3.7.2 Type timeInterval-Type
Table 8.3.7.2-1: Definition of timeInterval-Type
|
Attribute name |
Data type |
Description |
SQ |
|
intervalStart |
string |
It defines the start time of the schedule, by a string in Time format. |
M |
|
intervalEnd |
string |
It defines the end time of the schedule, by a string in Time format.s |
M |
8.3.7.3 Type scheduleOfDay-Type
Table 8.3.7.3-1: Definition of scheduleOfDay-Type
|
Attribute name |
Data type |
Description |
SQ |
|
dayOfWeek |
dayOfWeek-Type |
It defines the day of a week. |
M |
|
intervalsOfDay |
array(timeInterval-Type) |
It defines the schedule of the day. |
M |
8.3.7.4 Void
8.3.7.5 Type unsupportedMeas-Type
Table 8.3.7.5-1: Definition of unsupportedMeas-Type
|
Attribute name |
Data type |
Description |
SQ |
|
iOCInstance |
uri-Type |
The URI of the IOC instance. |
M |
|
measurementTypeName |
string |
It defines the measurement type name that the IOC Instance as indicated above does not support |
M |
|
reason |
string |
It specifies the reason that measurement type name is not supported by the IOC instance |
M |
8.3.8 Simple data types and enumerations
8.3.8.1 General
This subclause defines simple data types and enumerations that are used by the data structures defined in the previous subclauses.
8.3.8.2 Simple data types
Table 8.3.8.2-1: Simple data types
|
Type name |
Type definition |
Description |
|
dataTime-Type |
string |
The data type for date and time in “date-time” format. |
|
uri-Type |
string |
The type of a URI |
8.3.8.3 Enumeration reportingMethod-Type
Table 8.3.8.3-1: Enumeration reportingMethod-Type
|
Enumeration value |
Description |
|
file |
It indicates that the performance data are to be reported by performance data file. |
|
streaming |
It indicates that the performance data are to be reported by performance data streaming. |
8.3.8.4 Enumeration priority-Type
Table 8.3.8.4-1: Enumeration priority-Type
|
Enumeration value |
Description |
|
Low |
It indicates that the priority of the measurement job is low |
|
medium |
It indicates that the priority of the measurement job is medium |
|
high |
It indicates that the priority of the measurement job is high |
8.3.8.5 Enumeration scheduleOption-Type
Table 8.3.8.5-1: Enumeration scheduleOption-Type
|
Enumeration value |
Description |
|
daily |
It indicates the schedule of the measurement job is daily. |
|
weekly |
It indicates the schedule of the measurement job is weekly. |
8.3.8.6 Enumeration dayOfWeek-Type
Table 8.3.8.6-1: Enumeration dayOfWeek-Type
|
Enumeration value |
Description |
|
Monday |
It indicates Monday of a week. |
|
Tuesday |
It indicates Tuesday of a week. |
|
Wednesday |
It indicates Wednesday of a week. |
|
Thursday |
It indicates Thursday of a week. |
|
Friday |
It indicates Friday of a week. |
|
Saturday |
It indicates Saturday of a week. |
|
Sunday |
It indicates Sunday of a week. |