This section describes subscribing to the performance management jobs.
Create a Performance Management Subscription
The NFVO can subscribe to the performance management jobs.
Method Type:
POST
VNFM Endpoint:
{api_root}/vnfpm/v1/subscriptions(DataStructure=PmSubscriptionRequest)
Example 1:
Request Payload:
{
"callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", "PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfdIds": ["25ec9e1c-ad9e-4613-9280-411920f3649a"],
"vnfInstanceIds": ["cc6a34e5-0463-459a-b367-493ba997775f"]
}
}
}
Response Payload:
{
"id": "4fba7dcb-e015-4674-9c50-8cee7059eb91"
"callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfdIds": ["25ec9e1c-ad9e-4613-9280-411920f3649a"],
"vnfInstanceIds": ["cc6a34e5-0463-459a-b367-493ba997775f"] }
},
"_links": {
"self": {
"href": "http://host:port/vnfpm/v1/subscriptions/4fba7dcb-e015-4674-9c50-8cee7059eb91"
}
}
}
Example 2:
Request Payload:
{
"callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", "PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfProductsFromProviders": [{
"vnfProvider": "Cisco",
"vnfProducts": [{
"vnfProductName": "vnfd-1VDU",
"versions": [{
"vnfSoftwareVersion": "1.3.1",
"vnfdVersions": ["1.0", "1.1", "1.2"]
}]
}]
}],
"vnfInstanceNames": ["kaswaczy-TestETSIPmSubscriptionGet-114113"]
}
}
}
Response Payload:
{
"id": "4fba7dcb-e015-4674-9c50-8cee7059eb92"
"callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", "PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfProductsFromProviders": [{
"vnfProvider": "Cisco",
"vnfProducts": [{
"vnfProductName": "vnfd-1VDU",
"versions": [{
"vnfSoftwareVersion": "1.3.1",
"vnfdVersions": ["1.0", 1.1", 1.2"]
}]
}]
}],
"vnfInstanceNames": ["kaswaczy-TestETSIPmSubscriptionGet-114113"]
}
},
"_links": {
"self": {
"href": "http://host:port/vnfpm/v1/subscriptions/4fba7dcb-e015-4674-9c50-8cee7059eb92"
}
}
}
Note |
-
The vnfdIds and vnfProductsFromProviders attributes are mutually exclusive. Only one of them can be provided in a single create request.
-
The vnfInstanceIds and vnfInstanceNames attributes are mutually exclusive. Only one of them can be provided in a single create request.
-
If the specified callbackUri and filter precisely matches an existing subscription, the create subscription operation will
fail with an error message stating duplicate subscriptions are not allowed.
|
Query an Individual Performance Management Subscription
Method Type:
GET
VNFM Endpoint:
{api_root}/vnfpm/v1/subscriptions/{subscriptionId}
Request Payload: NA
Response Payload:
{
"id": "4fba7dcb-e015-4674-9c50-8cee7059eb91"
"callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", "PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfdIds": ["25ec9e1c-ad9e-4613-9280-411920f3649a"],
"vnfInstanceIds": ["cc6a34e5-0463-459a-b367-493ba997775f"] }
},
"_links": {
"self": {
"href": "http://host:port/vnfpm/v1/subscriptions/4fba7dcb-e015-4674-9c50-8cee7059eb91"
}
}
}
Note |
Attribute-based filtering is not possible when specifying a subscription id.
|
Query all Performance Management Subscriptions
Method Type:
GET
{api_root}/vnfpm/v1/subscriptions
Request Payload: NA
Response Payload:
{
"_embedded": {
"pmSubscriptions": [{
"id": "4fba7dcb-e015-4674-9c50-8cee7059eb91""callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", "PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfdIds": ["25ec9e1c-ad9e-4613-9280-411920f3649a"],
"vnfInstanceIds": ["cc6a34e5-0463-459a-b367-493ba997775f"]
}
},
"_links": {
"self": {
"href": "http://host:port/vnfpm/v1/subscriptions/4fba7dcb-e015-4674-9c50-8cee7059eb91"
}
}
},
{
"id": "4fba7dcb-e015-4674-9c50-8cee7059eb92""callbackUri": "http://host:port/notification",
"filter": {
"notificationTypes": ["ThresholdCrossedNotification", "PerformanceInformationAvailableNotification"],
"vnfInstanceSubscriptionFilter": {
"vnfProductsFromProviders": [{
"vnfProvider": "Cisco",
"vnfProducts": [{
"vnfProductName": "vnfd-1VDU",
"versions": [{
"vnfSoftwareVersion": "1.3.1",
"vnfdVersions": ["1.0", "1.1", "1.2"]
}]
}]
}],
"vnfInstanceNames": ["kaswaczy-TestETSIPmSubscriptionGet-114113"]
}
},
"_links": {
"self": {
"href": "http://host:port/vnfpm/v1/subscriptions/4fba7dcb-e015-4674-9c50-8cee7059eb92"
}
}
}]
}
}
Note |
All attribute names and data types referenced in the response payload are supported in attribute-based filtering of the parameters.
|
Terminate a Performance Management Subscription
The NFVO can terminate a subscription.
DELETE {api_root}/vnfpm/v1/subscriptions/{subscriptionId}
Feedback