...
| Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
resourceModuleName | Y | 1 | String | A resource name as defined in a service model. | |
serviceResourceId | Y | 1 | String | A unique resource Id with a local scope between client and OOF. | |
tenantId | N | 1 | String | A tenant Id as defined in the ordering system. | |
resourceModelInfo | Y | 1 | ModelMetaData Object | Resource model information as defined in SDC. | |
existingCandidates | N | 1..N | List of Candidates Objects | The existing placement information of a resource. | |
excludedCandidates | N | 1..N | List of Candidates Objects | Candidates that need to be excluded from solutions. | |
requiredCandidates | N | 1..N | List of Candidates Objects | Candidates that must be included in solutions. |
SubscriberInfo Object
| Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
globalSubscriberId | Y | 1 | String | An ID of a subscriber. | |
subscriberName | N | 1. | String | The name of a subscriber. | |
| subscriberCommonSiteId | N | 1 | String | Id representing a subscriber location. |
ModelMetaData Object
| Attribute | Required? | Cardinality | Content | Values | Description |
|---|---|---|---|---|---|
modelInvariantId | Y | 1 | String | A model invariant Id as defined in a service model. | |
modelVersionId | Y | 1 | String | A unique model Id as defined in a service model. | |
modelName | N | 1 | String | A model name as defined in a service model. | |
modelType | N | 1 | String | A model type as defined in a service model. | |
modelVersion | N | 1 | String | A model version as defined in a service model. | |
modelCustomizationName | N | 1 | String | A model customization name as defined in a service model. |
...
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"transactionId": "xxx-xxx-xxxx",
"requestId": "yyy-yyy-yyyy",
"requestStatus": "completed",
"statusMessage": "Success!",
"solutions": {
"placementSolutions": [
{
"resourceModuleName": "vGMuxInfra",
"serviceResourceId": "some_resource_id",
"solution": {
"identifier_type": "service_instance_id",
"identifiers": ["gjhd-098-fhd-987"]
}
"assignmentInfo": [
{ "key": "cloudOwner", "value": "amazon" },
{ "key": "vnfHostName", "value": "ahr344gh" },
{ "key": "isRehome", "value": "False" },
{ "key": "cloud_region_id", "value": "1ac71fb8-ad43-4e16-9459-c3f372b8236d" }
]
},
{
"resourceModuleName": "vG",
"serviceResourceId": "some_resource_id",
"solution": {
"identifier_type": "cloud_region_id",
"cloud_owner": "amazon",
"identifiers": ["gjhd-098-fhd-987"]
}
"assignmentInfo": [
{ "key": "cloudOwner", "value": "amazon" },
{ "key": "cloud_region_id", "value": "1ac71fb8-ad43-4e16-9459-c3f372b8236d" }
]
}
],
"licenseSolutions": [
{
"resourceModuleName": "vGMuxInfra",
"serviceResourceId": "some_resource_id",
"entitlementPoolUUID": ["1ac71fb8-ad43-4e16-9459-c3f372b8236d", "834fc71fb8-ad43-4fh7-9459-c3f372b8236f"],
"licenseKeyGroupUUID": ["1ac71fb8-ad43-4e16-9459-c3f372b8236d", "834fc71fb8-ad43-4fh7-9459-c3f372b8236f"],
"entitlementPoolInvariantUUID": ["1ac71fb8-ad43-4e16-9459-c3f372b8236d", "834fc71fb8-ad43-4fh7-9459-c3f372b8236f"],
"licenseKeyGroupInvariantUUID": ["1ac71fb8-ad43-4e16-9459-c3f372b8236d", "834fc71fb8-ad43-4fh7-9459-c3f372b8236f"]
}
]
}
} |
Optimization Query Policies
The requestParameters object is of type JSON blob. An OOF/HAS client is expected to send service-specific and customer-specific information in a JSON format. The API allows a client to define any object structure in a JSON blob; however, the naming conventions used in the JSON blob must be the same as defined in a service model or customer order. Which information of a JSON blob is relevant for a service and where the information is located in the JSON blob should be captured through query policies. The location of an object in a JSON blob can be specified using an xpath with dot notations as shown in the following example. These optimization query policies can be configured by either a service provider or a client.
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"service": "optimizationQueryPolicy",
"policyName": "oofBeijing.queryPolicy_vCPE",
"description": "Optimization query policy for vCPE",
"templateVersion": "0.0.1",
"version": "oofBeijing",
"priority": "3",
"riskType": "test",
"riskLevel": "2",
"guard": "False",
"content": {
"queryProperties": [
{"attribute":"locationId", "value": "orderInfo.customerLocation"},
{"attribute":"id", "value": "orderInfo.vpnInfo"},
{"attribute":"upstreamBW", "value": "orderInfo,vpnInfo"}
],
"policyScope": ["vCPE", "US", "INTERNATIONAL", "ip", "vGMuxInfra", "vG"],
"type": "optimizationQueryPolicy"
}
} |
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"orderInfo": {
"customerLocation": {
"latitude": "30.98",
"longitude": "34.23",
"locationId": "NJBD34"
},
"vpnInfo": {
[
"id": 200,
"upsteamBW": "10Gbps",
"downstreamBW": "100Gbps"
],
[
"id": 200,
"upsteamBW": "10Gbps",
"downstreamBW": "100Gbps"
]
}
}
} |
OOF/HAS API document (pdf format)
...