seshukm | eab83ce | 2019-01-10 07:15:01 +0100 | [diff] [blame^] | 1 | .. This work is licensed under a Creative Commons Attribution 4.0 International License. |
| 2 | .. http://creativecommons.org/licenses/by/4.0 |
| 3 | .. Copyright 2018 Huawei Technologies Co., Ltd. |
| 4 | |
| 5 | SO Interfaces |
| 6 | ================================ |
| 7 | |
| 8 | .. image:: ../images/SO_1.png |
| 9 | |
| 10 | SO APIs |
| 11 | ---------------- |
| 12 | |
| 13 | North Bound APIs |
| 14 | ---------------- |
| 15 | Create service instance |
| 16 | ++++++++++++++++++++++++ |
| 17 | |
| 18 | +--------------------+-------------------------------------+ |
| 19 | |Interface Definition|Description | |
| 20 | +====================+=====================================+ |
| 21 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6 | |
| 22 | +--------------------+-------------------------------------+ |
| 23 | |Operation Type |POST | |
| 24 | +--------------------+-------------------------------------+ |
| 25 | |Content-Type |application/json | |
| 26 | +--------------------+-------------------------------------+ |
| 27 | |
| 28 | Request Body: |
| 29 | |
| 30 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 31 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 32 | +================+=========+===========+==========================+===========================================+ |
| 33 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 34 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 35 | |
| 36 | RequestDetails Object |
| 37 | |
| 38 | +-------------------+--------------------------+-------------------------------------------------+ |
| 39 | |Attribute |Content |Description | |
| 40 | +===================+==========================+=================================================+ |
| 41 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 42 | +-------------------+--------------------------+-------------------------------------------------+ |
| 43 | |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | |
| 44 | +-------------------+--------------------------+-------------------------------------------------+ |
| 45 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 46 | +-------------------+--------------------------+-------------------------------------------------+ |
| 47 | |requestParameters |requestParameters Object |Content of requestParameters object. | |
| 48 | +-------------------+--------------------------+-------------------------------------------------+ |
| 49 | |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | |
| 50 | +-------------------+--------------------------+-------------------------------------------------+ |
| 51 | |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | |
| 52 | +-------------------+--------------------------+-------------------------------------------------+ |
| 53 | |project |project Object |Content of project object. | |
| 54 | +-------------------+--------------------------+-------------------------------------------------+ |
| 55 | |owningEntity |owningEntity Object |Content of owningEntity object. | |
| 56 | +-------------------+--------------------------+-------------------------------------------------+ |
| 57 | |platform |platform Object |Content of platform object. | |
| 58 | +-------------------+--------------------------+-------------------------------------------------+ |
| 59 | |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | |
| 60 | +-------------------+--------------------------+-------------------------------------------------+ |
| 61 | |
| 62 | ModelInfo Object |
| 63 | |
| 64 | +-------------------------+------------------+-------------------------------------------------+ |
| 65 | |Attribute |Content |Description | |
| 66 | +=========================+==================+=================================================+ |
| 67 | |ModelType |String |Type of model | |
| 68 | +-------------------------+------------------+-------------------------------------------------+ |
| 69 | |ModelInvariantId |String |The Model Invariant Id. | |
| 70 | +-------------------------+------------------+-------------------------------------------------+ |
| 71 | |ModelNameVersionId |String |The modelname Version Id | |
| 72 | +-------------------------+------------------+-------------------------------------------------+ |
| 73 | |ModelName |String |Name of the Model | |
| 74 | +-------------------------+------------------+-------------------------------------------------+ |
| 75 | |ModelVersion |String |Version of the model | |
| 76 | +-------------------------+------------------+-------------------------------------------------+ |
| 77 | |ModelCustomization Name |String |The Model Customization name | |
| 78 | +-------------------------+------------------+-------------------------------------------------+ |
| 79 | |modelCustomizationUuid |String |The Model Customization UUid | |
| 80 | +-------------------------+------------------+-------------------------------------------------+ |
| 81 | |modelVersionId |String |The Model version id | |
| 82 | +-------------------------+------------------+-------------------------------------------------+ |
| 83 | |modelUuid |String |The Model UUid | |
| 84 | +-------------------------+------------------+-------------------------------------------------+ |
| 85 | |modelInvariantUuid |String |The Model Invariant UUid | |
| 86 | +-------------------------+------------------+-------------------------------------------------+ |
| 87 | |modelInstanceName |String |The Model Instance name | |
| 88 | +-------------------------+------------------+-------------------------------------------------+ |
| 89 | |
| 90 | |
| 91 | SubscriberInfo Object |
| 92 | |
| 93 | +-------------------------+------------------+-------------------------------------------------+ |
| 94 | |Attribute |Content |Description | |
| 95 | +=========================+==================+=================================================+ |
| 96 | |GlobalSubscriberId |String |Global customer Id (in A&AI) | |
| 97 | +-------------------------+------------------+-------------------------------------------------+ |
| 98 | |SubscriberName |String |Name of the Subscriber | |
| 99 | +-------------------------+------------------+-------------------------------------------------+ |
| 100 | |
| 101 | RequestInfo Object |
| 102 | |
| 103 | +-------------------------+------------------+-------------------------------------------------+ |
| 104 | |Attribute |Content |Description | |
| 105 | +=========================+==================+=================================================+ |
| 106 | |Source |String |source of the request | |
| 107 | +-------------------------+------------------+-------------------------------------------------+ |
| 108 | |billingAccountNumber |String |billingAccountNumber of the request | |
| 109 | +-------------------------+------------------+-------------------------------------------------+ |
| 110 | |callbackUrl |String |callbackUrl of the request | |
| 111 | +-------------------------+------------------+-------------------------------------------------+ |
| 112 | |correlator |String |correlator of the request | |
| 113 | +-------------------------+------------------+-------------------------------------------------+ |
| 114 | |orderNumber |String |orderNumber of the request | |
| 115 | +-------------------------+------------------+-------------------------------------------------+ |
| 116 | |productFamilyId |String |productFamilyId of the request | |
| 117 | +-------------------------+------------------+-------------------------------------------------+ |
| 118 | |orderVersion |String |orderVersion of the request | |
| 119 | +-------------------------+------------------+-------------------------------------------------+ |
| 120 | |instanceName |String |instanceName of the request | |
| 121 | +-------------------------+------------------+-------------------------------------------------+ |
| 122 | |suppressRollback |String |suppressRollback of the request | |
| 123 | +-------------------------+------------------+-------------------------------------------------+ |
| 124 | |requestorId |String |requestorId of the request | |
| 125 | +-------------------------+------------------+-------------------------------------------------+ |
| 126 | |
| 127 | RequestParameters Object |
| 128 | |
| 129 | +-------------------------+------------------+-------------------------------------------------+ |
| 130 | |Attribute |Content |Description | |
| 131 | +=========================+==================+=================================================+ |
| 132 | |SubscriptionServiceType |String |The service type of the Subscription | |
| 133 | +-------------------------+------------------+-------------------------------------------------+ |
| 134 | |UserParams |Array |The product family Id. | |
| 135 | +-------------------------+------------------+-------------------------------------------------+ |
| 136 | |aLaCarte |Boolean | aLaCarte | |
| 137 | +-------------------------+------------------+-------------------------------------------------+ |
| 138 | |autoBuildVfModules |Boolean |autoBuildVfModules | |
| 139 | +-------------------------+------------------+-------------------------------------------------+ |
| 140 | |cascadeDelete |Boolean |cascadeDelete | |
| 141 | +-------------------------+------------------+-------------------------------------------------+ |
| 142 | |usePreload |Boolean |usePreload | |
| 143 | +-------------------------+------------------+-------------------------------------------------+ |
| 144 | |rebuildVolumeGroups |Boolean |rebuildVolumeGroups | |
| 145 | +-------------------------+------------------+-------------------------------------------------+ |
| 146 | |payload |String |payload | |
| 147 | +-------------------------+------------------+-------------------------------------------------+ |
| 148 | |controllerType |String |controllerType | |
| 149 | +-------------------------+------------------+-------------------------------------------------+ |
| 150 | |
| 151 | UserParams Object |
| 152 | |
| 153 | +-------------------------+------------------+-------------------------------------------------+ |
| 154 | |Attribute |Content |Description | |
| 155 | +=========================+==================+=================================================+ |
| 156 | |name |String |Tag name of attribute | |
| 157 | +-------------------------+------------------+-------------------------------------------------+ |
| 158 | |value |String |Value of the tag | |
| 159 | +-------------------------+------------------+-------------------------------------------------+ |
| 160 | |
| 161 | CloudConfiguration Object |
| 162 | |
| 163 | +-------------------------+------------------+-------------------------------------------------+ |
| 164 | |Attribute |Content |Description | |
| 165 | +=========================+==================+=================================================+ |
| 166 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 167 | +-------------------------+------------------+-------------------------------------------------+ |
| 168 | |tenantId |String |Name of the Subscriber | |
| 169 | +-------------------------+------------------+-------------------------------------------------+ |
| 170 | |aicNodeClli |String |aicNodeClli property | |
| 171 | +-------------------------+------------------+-------------------------------------------------+ |
| 172 | |
| 173 | Project Object |
| 174 | |
| 175 | +-------------------------+------------------+-------------------------------------------------+ |
| 176 | |Attribute |Content |Description | |
| 177 | +=========================+==================+=================================================+ |
| 178 | |projectName |String |Name of the project | |
| 179 | +-------------------------+------------------+-------------------------------------------------+ |
| 180 | |
| 181 | OwningEntity Object |
| 182 | |
| 183 | +-------------------------+------------------+-------------------------------------------------+ |
| 184 | |Attribute |Content |Description | |
| 185 | +=========================+==================+=================================================+ |
| 186 | |owningEntityId |String |owningEntityId of the owingEntity | |
| 187 | +-------------------------+------------------+-------------------------------------------------+ |
| 188 | |owningEntityName |String |owningEntityName of the owingEntity | |
| 189 | +-------------------------+------------------+-------------------------------------------------+ |
| 190 | |
| 191 | Platform Object |
| 192 | |
| 193 | +-------------------------+------------------+-------------------------------------------------+ |
| 194 | |Attribute |Content |Description | |
| 195 | +=========================+==================+=================================================+ |
| 196 | |platformName |String |Platform Name | |
| 197 | +-------------------------+------------------+-------------------------------------------------+ |
| 198 | |
| 199 | LineOfBusiness Object |
| 200 | |
| 201 | +-------------------------+------------------+-------------------------------------------------+ |
| 202 | |Attribute |Content |Description | |
| 203 | +=========================+==================+=================================================+ |
| 204 | |lineOfBusinessName |String |Line Of Business Name | |
| 205 | +-------------------------+------------------+-------------------------------------------------+ |
| 206 | |
| 207 | Delete service instance |
| 208 | ++++++++++++++++++++++++ |
| 209 | |
| 210 | +--------------------+---------------------------------------------------------+ |
| 211 | |Interface Definition|Description | |
| 212 | +====================+=========================================================+ |
| 213 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId} | |
| 214 | +--------------------+---------------------------------------------------------+ |
| 215 | |Operation Type |DELETE | |
| 216 | +--------------------+---------------------------------------------------------+ |
| 217 | |Content-Type |application/json | |
| 218 | +--------------------+---------------------------------------------------------+ |
| 219 | |
| 220 | Request Body: |
| 221 | |
| 222 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 223 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 224 | +================+=========+===========+==========================+===========================================+ |
| 225 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 226 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 227 | |
| 228 | RequestDetails Object |
| 229 | |
| 230 | +-------------------+-------------------------+-------------------------------------------------+ |
| 231 | |Attribute |Content |Description | |
| 232 | +===================+=========================+=================================================+ |
| 233 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 234 | +-------------------+-------------------------+-------------------------------------------------+ |
| 235 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 236 | +-------------------+-------------------------+-------------------------------------------------+ |
| 237 | |
| 238 | ModelInfo Object |
| 239 | |
| 240 | +-------------------------+------------------+-------------------------------------------------+ |
| 241 | |Attribute |Content |Description | |
| 242 | +=========================+==================+=================================================+ |
| 243 | |ModelType |String |Type of model | |
| 244 | +-------------------------+------------------+-------------------------------------------------+ |
| 245 | |ModelInvariantId |String |The Model Invariant Id. | |
| 246 | +-------------------------+------------------+-------------------------------------------------+ |
| 247 | |ModelName |String |Name of the Model | |
| 248 | +-------------------------+------------------+-------------------------------------------------+ |
| 249 | |ModelVersion |String |Version of the model | |
| 250 | +-------------------------+------------------+-------------------------------------------------+ |
| 251 | |
| 252 | RequestInfo Object |
| 253 | |
| 254 | +-------------------------+------------------+-------------------------------------------------+ |
| 255 | |Attribute |Content |Description | |
| 256 | +=========================+==================+=================================================+ |
| 257 | |Source |String |source of the request | |
| 258 | +-------------------------+------------------+-------------------------------------------------+ |
| 259 | |
| 260 | Create Volume Group |
| 261 | ++++++++++++++++++++++++ |
| 262 | |
| 263 | +--------------------+-------------------------------------------------------------------------------------------+ |
| 264 | |Interface Definition|Description | |
| 265 | +====================+===========================================================================================+ |
| 266 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups | |
| 267 | +--------------------+-------------------------------------------------------------------------------------------+ |
| 268 | |Operation Type |POST | |
| 269 | +--------------------+-------------------------------------------------------------------------------------------+ |
| 270 | |Content-Type |application/json | |
| 271 | +--------------------+-------------------------------------------------------------------------------------------+ |
| 272 | |
| 273 | Request Body: |
| 274 | |
| 275 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 276 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 277 | +================+=========+===========+==========================+===========================================+ |
| 278 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 279 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 280 | |
| 281 | RequestDetails Object |
| 282 | |
| 283 | +-------------------+--------------------------+-------------------------------------------------+ |
| 284 | |Attribute |Content |Description | |
| 285 | +===================+==========================+=================================================+ |
| 286 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 287 | +-------------------+--------------------------+-------------------------------------------------+ |
| 288 | |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | |
| 289 | +-------------------+--------------------------+-------------------------------------------------+ |
| 290 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 291 | +-------------------+--------------------------+-------------------------------------------------+ |
| 292 | |requestParameters |requestParameters Object |Content of requestParameters object. | |
| 293 | +-------------------+--------------------------+-------------------------------------------------+ |
| 294 | |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | |
| 295 | +-------------------+--------------------------+-------------------------------------------------+ |
| 296 | |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | |
| 297 | +-------------------+--------------------------+-------------------------------------------------+ |
| 298 | |project |project Object |Content of project object. | |
| 299 | +-------------------+--------------------------+-------------------------------------------------+ |
| 300 | |owningEntity |owningEntity Object |Content of owningEntity object. | |
| 301 | +-------------------+--------------------------+-------------------------------------------------+ |
| 302 | |platform |platform Object |Content of platform object. | |
| 303 | +-------------------+--------------------------+-------------------------------------------------+ |
| 304 | |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | |
| 305 | +-------------------+--------------------------+-------------------------------------------------+ |
| 306 | |
| 307 | ModelInfo Object |
| 308 | |
| 309 | +-------------------------+------------------+-------------------------------------------------+ |
| 310 | |Attribute |Content |Description | |
| 311 | +=========================+==================+=================================================+ |
| 312 | |ModelType |String |Type of model | |
| 313 | +-------------------------+------------------+-------------------------------------------------+ |
| 314 | |ModelInvariantId |String |The Model Invariant Id. | |
| 315 | +-------------------------+------------------+-------------------------------------------------+ |
| 316 | |ModelNameVersionId |String |The modelname Version Id | |
| 317 | +-------------------------+------------------+-------------------------------------------------+ |
| 318 | |ModelName |String |Name of the Model | |
| 319 | +-------------------------+------------------+-------------------------------------------------+ |
| 320 | |ModelVersion |String |Version of the model | |
| 321 | +-------------------------+------------------+-------------------------------------------------+ |
| 322 | |ModelCustomization Name |String |The Model Customization name | |
| 323 | +-------------------------+------------------+-------------------------------------------------+ |
| 324 | |modelCustomizationUuid |String |The Model Customization UUid | |
| 325 | +-------------------------+------------------+-------------------------------------------------+ |
| 326 | |modelVersionId |String |The Model version id | |
| 327 | +-------------------------+------------------+-------------------------------------------------+ |
| 328 | |modelUuid |String |The Model UUid | |
| 329 | +-------------------------+------------------+-------------------------------------------------+ |
| 330 | |modelInvariantUuid |String |The Model Invariant UUid | |
| 331 | +-------------------------+------------------+-------------------------------------------------+ |
| 332 | |modelInstanceName |String |The Model Instance name | |
| 333 | +-------------------------+------------------+-------------------------------------------------+ |
| 334 | |
| 335 | CloudConfiguration Object |
| 336 | |
| 337 | +-------------------------+------------------+-------------------------------------------------+ |
| 338 | |Attribute |Content |Description | |
| 339 | +=========================+==================+=================================================+ |
| 340 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 341 | +-------------------------+------------------+-------------------------------------------------+ |
| 342 | |tenantId |String |Name of the Subscriber | |
| 343 | +-------------------------+------------------+-------------------------------------------------+ |
| 344 | |aicNodeClli |String |aicNodeClli property | |
| 345 | +-------------------------+------------------+-------------------------------------------------+ |
| 346 | |
| 347 | RequestInfo Object |
| 348 | |
| 349 | +-------------------------+------------------+-------------------------------------------------+ |
| 350 | |Attribute |Content |Description | |
| 351 | +=========================+==================+=================================================+ |
| 352 | |Source |String |source of the request | |
| 353 | +-------------------------+------------------+-------------------------------------------------+ |
| 354 | |billingAccountNumber |String |billingAccountNumber of the request | |
| 355 | +-------------------------+------------------+-------------------------------------------------+ |
| 356 | |callbackUrl |String |callbackUrl of the request | |
| 357 | +-------------------------+------------------+-------------------------------------------------+ |
| 358 | |correlator |String |correlator of the request | |
| 359 | +-------------------------+------------------+-------------------------------------------------+ |
| 360 | |orderNumber |String |orderNumber of the request | |
| 361 | +-------------------------+------------------+-------------------------------------------------+ |
| 362 | |productFamilyId |String |productFamilyId of the request | |
| 363 | +-------------------------+------------------+-------------------------------------------------+ |
| 364 | |orderVersion |String |orderVersion of the request | |
| 365 | +-------------------------+------------------+-------------------------------------------------+ |
| 366 | |instanceName |String |instanceName of the request | |
| 367 | +-------------------------+------------------+-------------------------------------------------+ |
| 368 | |suppressRollback |String |suppressRollback of the request | |
| 369 | +-------------------------+------------------+-------------------------------------------------+ |
| 370 | |requestorId |String |requestorId of the request | |
| 371 | +-------------------------+------------------+-------------------------------------------------+ |
| 372 | |
| 373 | relatedInstance List |
| 374 | |
| 375 | +-------------------------+------------------+-------------------------------------------------+ |
| 376 | |Attribute |Content |Description | |
| 377 | +=========================+==================+=================================================+ |
| 378 | |relatedInstance |Object |relatedInstance Object | |
| 379 | +-------------------------+------------------+-------------------------------------------------+ |
| 380 | |
| 381 | relatedInstance List |
| 382 | |
| 383 | +-------------------------+------------------+-------------------------------------------------+ |
| 384 | |Attribute |Content |Description | |
| 385 | +=========================+==================+=================================================+ |
| 386 | |instanceId |String |instanceId | |
| 387 | +-------------------------+------------------+-------------------------------------------------+ |
| 388 | |modelInfo |Object |Content of modelInfo object. | |
| 389 | +-------------------------+------------------+-------------------------------------------------+ |
| 390 | |
| 391 | Delete Volume Group |
| 392 | ++++++++++++++++++++++++ |
| 393 | |
| 394 | +--------------------+---------------------------------------------------------------------------------------------------------------------+ |
| 395 | |Interface Definition|Description | |
| 396 | +====================+=====================================================================================================================+ |
| 397 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id} | |
| 398 | +--------------------+---------------------------------------------------------------------------------------------------------------------+ |
| 399 | |Operation Type |DELETE | |
| 400 | +--------------------+---------------------------------------------------------------------------------------------------------------------+ |
| 401 | |Content-Type |application/json | |
| 402 | +--------------------+---------------------------------------------------------------------------------------------------------------------+ |
| 403 | |
| 404 | Request Body: |
| 405 | |
| 406 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 407 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 408 | +================+=========+===========+==========================+===========================================+ |
| 409 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 410 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 411 | |
| 412 | RequestDetails Object |
| 413 | |
| 414 | +---------------------+-------------------------+-------------------------------------------------+ |
| 415 | |Attribute |Content |Description | |
| 416 | +=====================+=========================+=================================================+ |
| 417 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 418 | +---------------------+-------------------------+-------------------------------------------------+ |
| 419 | |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | |
| 420 | +---------------------+-------------------------+-------------------------------------------------+ |
| 421 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 422 | +---------------------+-------------------------+-------------------------------------------------+ |
| 423 | |
| 424 | ModelInfo Object |
| 425 | |
| 426 | +-------------------------+------------------+-------------------------------------------------+ |
| 427 | |Attribute |Content |Description | |
| 428 | +=========================+==================+=================================================+ |
| 429 | |ModelType |String |Type of model | |
| 430 | +-------------------------+------------------+-------------------------------------------------+ |
| 431 | |ModelName |String |Name of the Model | |
| 432 | +-------------------------+------------------+-------------------------------------------------+ |
| 433 | |
| 434 | CloudConfiguration Object |
| 435 | |
| 436 | +-------------------------+------------------+-------------------------------------------------+ |
| 437 | |Attribute |Content |Description | |
| 438 | +=========================+==================+=================================================+ |
| 439 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 440 | +-------------------------+------------------+-------------------------------------------------+ |
| 441 | |tenantId |String |Name of the Subscriber | |
| 442 | +-------------------------+------------------+-------------------------------------------------+ |
| 443 | |
| 444 | RequestInfo Object |
| 445 | |
| 446 | +-------------------------+------------------+-------------------------------------------------+ |
| 447 | |Attribute |Content |Description | |
| 448 | +=========================+==================+=================================================+ |
| 449 | |Source |String |source of the request | |
| 450 | +-------------------------+------------------+-------------------------------------------------+ |
| 451 | |
| 452 | Create VF Module |
| 453 | +++++++++++++++++ |
| 454 | |
| 455 | +--------------------+----------------------------------------------------------------------------------------+ |
| 456 | |Interface Definition|Description | |
| 457 | +====================+========================================================================================+ |
| 458 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules | |
| 459 | +--------------------+----------------------------------------------------------------------------------------+ |
| 460 | |Operation Type |POST | |
| 461 | +--------------------+----------------------------------------------------------------------------------------+ |
| 462 | |Content-Type |application/json | |
| 463 | +--------------------+----------------------------------------------------------------------------------------+ |
| 464 | |
| 465 | Request Body: |
| 466 | |
| 467 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 468 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 469 | +================+=========+===========+==========================+===========================================+ |
| 470 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 471 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 472 | |
| 473 | RequestDetails Object |
| 474 | |
| 475 | +---------------------+-------------------------+-------------------------------------------------+ |
| 476 | |Attribute |Content |Description | |
| 477 | +=====================+=========================+=================================================+ |
| 478 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 479 | +---------------------+-------------------------+-------------------------------------------------+ |
| 480 | |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | |
| 481 | +---------------------+-------------------------+-------------------------------------------------+ |
| 482 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 483 | +---------------------+-------------------------+-------------------------------------------------+ |
| 484 | |relatedInstanceList |List |Content of relatedInstanceList. | |
| 485 | +---------------------+-------------------------+-------------------------------------------------+ |
| 486 | |
| 487 | ModelInfo Object |
| 488 | |
| 489 | +-------------------------+------------------+-------------------------------------------------+ |
| 490 | |Attribute |Content |Description | |
| 491 | +=========================+==================+=================================================+ |
| 492 | |ModelType |String |Type of model | |
| 493 | +-------------------------+------------------+-------------------------------------------------+ |
| 494 | |ModelInvariantId |String |The Model Invariant Id. | |
| 495 | +-------------------------+------------------+-------------------------------------------------+ |
| 496 | |ModelNameVersionId |String |The modelname Version Id | |
| 497 | +-------------------------+------------------+-------------------------------------------------+ |
| 498 | |ModelName |String |Name of the Model | |
| 499 | +-------------------------+------------------+-------------------------------------------------+ |
| 500 | |ModelVersion |String |Version of the model | |
| 501 | +-------------------------+------------------+-------------------------------------------------+ |
| 502 | |ModelCustomization Name |String |The Model Customization name | |
| 503 | +-------------------------+------------------+-------------------------------------------------+ |
| 504 | |
| 505 | CloudConfiguration Object |
| 506 | |
| 507 | +-------------------------+------------------+-------------------------------------------------+ |
| 508 | |Attribute |Content |Description | |
| 509 | +=========================+==================+=================================================+ |
| 510 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 511 | +-------------------------+------------------+-------------------------------------------------+ |
| 512 | |tenantId |String |Name of the Subscriber | |
| 513 | +-------------------------+------------------+-------------------------------------------------+ |
| 514 | |
| 515 | RequestInfo Object |
| 516 | |
| 517 | +-------------------------+------------------+-------------------------------------------------+ |
| 518 | |Attribute |Content |Description | |
| 519 | +=========================+==================+=================================================+ |
| 520 | |InstanceName |String |The instance Name | |
| 521 | +-------------------------+------------------+-------------------------------------------------+ |
| 522 | |Source |String |source of the request | |
| 523 | +-------------------------+------------------+-------------------------------------------------+ |
| 524 | |SuppressRollback |Boolean |SuppressRollback | |
| 525 | +-------------------------+------------------+-------------------------------------------------+ |
| 526 | |
| 527 | relatedInstance List |
| 528 | |
| 529 | +-------------------------+------------------+-------------------------------------------------+ |
| 530 | |Attribute |Content |Description | |
| 531 | +=========================+==================+=================================================+ |
| 532 | |relatedInstance |Object |relatedInstance Object | |
| 533 | +-------------------------+------------------+-------------------------------------------------+ |
| 534 | |
| 535 | relatedInstance List |
| 536 | |
| 537 | +-------------------------+------------------+-------------------------------------------------+ |
| 538 | |Attribute |Content |Description | |
| 539 | +=========================+==================+=================================================+ |
| 540 | |instanceId |String |instanceId | |
| 541 | +-------------------------+------------------+-------------------------------------------------+ |
| 542 | |modelInfo |Object |Content of modelInfo object. | |
| 543 | +-------------------------+------------------+-------------------------------------------------+ |
| 544 | |instanceName |String |Name of the instance | |
| 545 | +-------------------------+------------------+-------------------------------------------------+ |
| 546 | |
| 547 | Delete VF Module |
| 548 | ++++++++++++++++++++++++ |
| 549 | |
| 550 | +--------------------+--------------------------------------------------------------------------------------------------------------+ |
| 551 | |Interface Definition|Description | |
| 552 | +====================+==============================================================================================================+ |
| 553 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} | |
| 554 | +--------------------+--------------------------------------------------------------------------------------------------------------+ |
| 555 | |Operation Type |DELETE | |
| 556 | +--------------------+--------------------------------------------------------------------------------------------------------------+ |
| 557 | |Content-Type |application/json | |
| 558 | +--------------------+--------------------------------------------------------------------------------------------------------------+ |
| 559 | |
| 560 | Request Body: |
| 561 | |
| 562 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 563 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 564 | +================+=========+===========+==========================+===========================================+ |
| 565 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 566 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 567 | |
| 568 | RequestDetails Object |
| 569 | |
| 570 | +---------------------+-------------------------+-------------------------------------------------+ |
| 571 | |Attribute |Content |Description | |
| 572 | +=====================+=========================+=================================================+ |
| 573 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 574 | +---------------------+-------------------------+-------------------------------------------------+ |
| 575 | |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | |
| 576 | +---------------------+-------------------------+-------------------------------------------------+ |
| 577 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 578 | +---------------------+-------------------------+-------------------------------------------------+ |
| 579 | |
| 580 | ModelInfo Object |
| 581 | |
| 582 | +-------------------------+------------------+-------------------------------------------------+ |
| 583 | |Attribute |Content |Description | |
| 584 | +=========================+==================+=================================================+ |
| 585 | |ModelType |String |Type of model | |
| 586 | +-------------------------+------------------+-------------------------------------------------+ |
| 587 | |ModelInvariantId |String |The Model Invariant Id. | |
| 588 | +-------------------------+------------------+-------------------------------------------------+ |
| 589 | |ModelNameVersionId |String |The modelname Version Id | |
| 590 | +-------------------------+------------------+-------------------------------------------------+ |
| 591 | |ModelName |String |Name of the Model | |
| 592 | +-------------------------+------------------+-------------------------------------------------+ |
| 593 | |ModelVersion |String |Version of the model | |
| 594 | +-------------------------+------------------+-------------------------------------------------+ |
| 595 | |ModelCustomization Name |String |The Model Customization name | |
| 596 | +-------------------------+------------------+-------------------------------------------------+ |
| 597 | |
| 598 | CloudConfiguration Object |
| 599 | |
| 600 | +-------------------------+------------------+-------------------------------------------------+ |
| 601 | |Attribute |Content |Description | |
| 602 | +=========================+==================+=================================================+ |
| 603 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 604 | +-------------------------+------------------+-------------------------------------------------+ |
| 605 | |tenantId |String |Name of the Subscriber | |
| 606 | +-------------------------+------------------+-------------------------------------------------+ |
| 607 | |
| 608 | RequestInfo Object |
| 609 | |
| 610 | +-------------------------+------------------+-------------------------------------------------+ |
| 611 | |Attribute |Content |Description | |
| 612 | +=========================+==================+=================================================+ |
| 613 | |Source |String |source of the request | |
| 614 | +-------------------------+------------------+-------------------------------------------------+ |
| 615 | |
| 616 | Create VNF |
| 617 | +++++++++++++++ |
| 618 | |
| 619 | +--------------------+--------------------------------------------------------------+ |
| 620 | |Interface Definition|Description | |
| 621 | +====================+==============================================================+ |
| 622 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs | |
| 623 | +--------------------+--------------------------------------------------------------+ |
| 624 | |Operation Type |POST | |
| 625 | +--------------------+--------------------------------------------------------------+ |
| 626 | |Content-Type |application/json | |
| 627 | +--------------------+--------------------------------------------------------------+ |
| 628 | |
| 629 | Request Body: |
| 630 | |
| 631 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 632 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 633 | +================+=========+===========+==========================+===========================================+ |
| 634 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 635 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 636 | |
| 637 | RequestDetails Object |
| 638 | |
| 639 | +-------------------+--------------------------+-------------------------------------------------+ |
| 640 | |Attribute |Content |Description | |
| 641 | +===================+==========================+=================================================+ |
| 642 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 643 | +-------------------+--------------------------+-------------------------------------------------+ |
| 644 | |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | |
| 645 | +-------------------+--------------------------+-------------------------------------------------+ |
| 646 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 647 | +-------------------+--------------------------+-------------------------------------------------+ |
| 648 | |requestParameters |requestParameters Object |Content of requestParameters object. | |
| 649 | +-------------------+--------------------------+-------------------------------------------------+ |
| 650 | |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | |
| 651 | +-------------------+--------------------------+-------------------------------------------------+ |
| 652 | |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | |
| 653 | +-------------------+--------------------------+-------------------------------------------------+ |
| 654 | |project |project Object |Content of project object. | |
| 655 | +-------------------+--------------------------+-------------------------------------------------+ |
| 656 | |owningEntity |owningEntity Object |Content of owningEntity object. | |
| 657 | +-------------------+--------------------------+-------------------------------------------------+ |
| 658 | |platform |platform Object |Content of platform object. | |
| 659 | +-------------------+--------------------------+-------------------------------------------------+ |
| 660 | |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | |
| 661 | +-------------------+--------------------------+-------------------------------------------------+ |
| 662 | |
| 663 | ModelInfo Object |
| 664 | |
| 665 | +-------------------------+------------------+-------------------------------------------------+ |
| 666 | |Attribute |Content |Description | |
| 667 | +=========================+==================+=================================================+ |
| 668 | |ModelType |String |Type of model | |
| 669 | +-------------------------+------------------+-------------------------------------------------+ |
| 670 | |ModelInvariantId |String |The Model Invariant Id. | |
| 671 | +-------------------------+------------------+-------------------------------------------------+ |
| 672 | |ModelNameVersionId |String |The modelname Version Id | |
| 673 | +-------------------------+------------------+-------------------------------------------------+ |
| 674 | |ModelName |String |Name of the Model | |
| 675 | +-------------------------+------------------+-------------------------------------------------+ |
| 676 | |ModelVersion |String |Version of the model | |
| 677 | +-------------------------+------------------+-------------------------------------------------+ |
| 678 | |ModelCustomization Name |String |The Model Customization name | |
| 679 | +-------------------------+------------------+-------------------------------------------------+ |
| 680 | |modelCustomizationUuid |String |The Model Customization UUid | |
| 681 | +-------------------------+------------------+-------------------------------------------------+ |
| 682 | |modelVersionId |String |The Model version id | |
| 683 | +-------------------------+------------------+-------------------------------------------------+ |
| 684 | |modelUuid |String |The Model UUid | |
| 685 | +-------------------------+------------------+-------------------------------------------------+ |
| 686 | |modelInvariantUuid |String |The Model Invariant UUid | |
| 687 | +-------------------------+------------------+-------------------------------------------------+ |
| 688 | |modelInstanceName |String |The Model Instance name | |
| 689 | +-------------------------+------------------+-------------------------------------------------+ |
| 690 | |
| 691 | CloudConfiguration Object |
| 692 | |
| 693 | +-------------------------+------------------+-------------------------------------------------+ |
| 694 | |Attribute |Content |Description | |
| 695 | +=========================+==================+=================================================+ |
| 696 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 697 | +-------------------------+------------------+-------------------------------------------------+ |
| 698 | |tenantId |String |Name of the Subscriber | |
| 699 | +-------------------------+------------------+-------------------------------------------------+ |
| 700 | |
| 701 | RequestInfo Object |
| 702 | |
| 703 | +-------------------------+------------------+-------------------------------------------------+ |
| 704 | |Attribute |Content |Description | |
| 705 | +=========================+==================+=================================================+ |
| 706 | |Source |String |source of the request | |
| 707 | +-------------------------+------------------+-------------------------------------------------+ |
| 708 | |billingAccountNumber |String |billingAccountNumber of the request | |
| 709 | +-------------------------+------------------+-------------------------------------------------+ |
| 710 | |callbackUrl |String |callbackUrl of the request | |
| 711 | +-------------------------+------------------+-------------------------------------------------+ |
| 712 | |correlator |String |correlator of the request | |
| 713 | +-------------------------+------------------+-------------------------------------------------+ |
| 714 | |orderNumber |String |orderNumber of the request | |
| 715 | +-------------------------+------------------+-------------------------------------------------+ |
| 716 | |productFamilyId |String |productFamilyId of the request | |
| 717 | +-------------------------+------------------+-------------------------------------------------+ |
| 718 | |orderVersion |String |orderVersion of the request | |
| 719 | +-------------------------+------------------+-------------------------------------------------+ |
| 720 | |instanceName |String |instanceName of the request | |
| 721 | +-------------------------+------------------+-------------------------------------------------+ |
| 722 | |suppressRollback |String |suppressRollback of the request | |
| 723 | +-------------------------+------------------+-------------------------------------------------+ |
| 724 | |requestorId |String |requestorId of the request | |
| 725 | +-------------------------+------------------+-------------------------------------------------+ |
| 726 | |
| 727 | relatedInstance List |
| 728 | |
| 729 | +-------------------------+------------------+-------------------------------------------------+ |
| 730 | |Attribute |Content |Description | |
| 731 | +=========================+==================+=================================================+ |
| 732 | |relatedInstance |Object |relatedInstance Object | |
| 733 | +-------------------------+------------------+-------------------------------------------------+ |
| 734 | |
| 735 | relatedInstance List |
| 736 | |
| 737 | +-------------------------+------------------+-------------------------------------------------+ |
| 738 | |Attribute |Content |Description | |
| 739 | +=========================+==================+=================================================+ |
| 740 | |instanceId |String |instanceId | |
| 741 | +-------------------------+------------------+-------------------------------------------------+ |
| 742 | |modelInfo |Object |Content of modelInfo object. | |
| 743 | +-------------------------+------------------+-------------------------------------------------+ |
| 744 | |
| 745 | RequestParameters Object |
| 746 | |
| 747 | +-------------------------+------------------+-------------------------------------------------+ |
| 748 | |Attribute |Content |Description | |
| 749 | +=========================+==================+=================================================+ |
| 750 | |UserParams |Array |The product family Id. | |
| 751 | +-------------------------+------------------+-------------------------------------------------+ |
| 752 | |
| 753 | UserParams Object |
| 754 | |
| 755 | +-------------------------+------------------+-------------------------------------------------+ |
| 756 | |Attribute |Content |Description | |
| 757 | +=========================+==================+=================================================+ |
| 758 | |name |String |Tag name of attribute | |
| 759 | +-------------------------+------------------+-------------------------------------------------+ |
| 760 | |value |String |Value of the tag | |
| 761 | +-------------------------+------------------+-------------------------------------------------+ |
| 762 | |
| 763 | Delete VNF |
| 764 | +++++++++++++++ |
| 765 | |
| 766 | +--------------------+------------------------------------------------------------------------------+ |
| 767 | |Interface Definition|Description | |
| 768 | +====================+==============================================================================+ |
| 769 | |URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId} | |
| 770 | +--------------------+------------------------------------------------------------------------------+ |
| 771 | |Operation Type |DELETE | |
| 772 | +--------------------+------------------------------------------------------------------------------+ |
| 773 | |Content-Type |application/json | |
| 774 | +--------------------+------------------------------------------------------------------------------+ |
| 775 | |
| 776 | Request Body: |
| 777 | |
| 778 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 779 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 780 | +================+=========+===========+==========================+===========================================+ |
| 781 | |requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | |
| 782 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 783 | |
| 784 | RequestDetails Object |
| 785 | |
| 786 | +---------------------+-------------------------+-------------------------------------------------+ |
| 787 | |Attribute |Content |Description | |
| 788 | +=====================+=========================+=================================================+ |
| 789 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 790 | +---------------------+-------------------------+-------------------------------------------------+ |
| 791 | |cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | |
| 792 | +---------------------+-------------------------+-------------------------------------------------+ |
| 793 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 794 | +---------------------+-------------------------+-------------------------------------------------+ |
| 795 | |requestParameters |requestParameters Object |Content of requestParameters object. | |
| 796 | +---------------------+-------------------------+-------------------------------------------------+ |
| 797 | |
| 798 | ModelInfo Object |
| 799 | |
| 800 | +-------------------------+------------------+-------------------------------------------------+ |
| 801 | |Attribute |Content |Description | |
| 802 | +=========================+==================+=================================================+ |
| 803 | |ModelType |String |Type of model | |
| 804 | +-------------------------+------------------+-------------------------------------------------+ |
| 805 | |ModelName |String |Name of the Model | |
| 806 | +-------------------------+------------------+-------------------------------------------------+ |
| 807 | |
| 808 | CloudConfiguration Object |
| 809 | |
| 810 | +-------------------------+------------------+-------------------------------------------------+ |
| 811 | |Attribute |Content |Description | |
| 812 | +=========================+==================+=================================================+ |
| 813 | |lcpCloudRegionId |String |CloudRegion Id (in A&AI) | |
| 814 | +-------------------------+------------------+-------------------------------------------------+ |
| 815 | |tenantId |String |Name of the Subscriber | |
| 816 | +-------------------------+------------------+-------------------------------------------------+ |
| 817 | |
| 818 | RequestInfo Object |
| 819 | |
| 820 | +-------------------------+------------------+-------------------------------------------------+ |
| 821 | |Attribute |Content |Description | |
| 822 | +=========================+==================+=================================================+ |
| 823 | |Source |String |source of the request | |
| 824 | +-------------------------+------------------+-------------------------------------------------+ |
| 825 | |
| 826 | RequestParameters Object |
| 827 | |
| 828 | +-------------------------+------------------+-------------------------------------------------+ |
| 829 | |Attribute |Content |Description | |
| 830 | +=========================+==================+=================================================+ |
| 831 | |UserParams |Array |The product family Id. | |
| 832 | +-------------------------+------------------+-------------------------------------------------+ |
| 833 | |
| 834 | UserParams Object |
| 835 | |
| 836 | +-------------------------+------------------+-------------------------------------------------+ |
| 837 | |Attribute |Content |Description | |
| 838 | +=========================+==================+=================================================+ |
| 839 | |name |String |Tag name of attribute | |
| 840 | +-------------------------+------------------+-------------------------------------------------+ |
| 841 | |value |String |Value of the tag | |
| 842 | +-------------------------+------------------+-------------------------------------------------+ |
| 843 | |
| 844 | GET Orchestration Request |
| 845 | ++++++++++++++++++++++++++ |
| 846 | |
| 847 | +--------------------+--------------------------------------------------------------+ |
| 848 | |Interface Definition|Description | |
| 849 | +====================+==============================================================+ |
| 850 | |URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6/{request-id} | |
| 851 | +--------------------+--------------------------------------------------------------+ |
| 852 | |Operation Type |GET | |
| 853 | +--------------------+--------------------------------------------------------------+ |
| 854 | |Content-Type |application/json | |
| 855 | +--------------------+--------------------------------------------------------------+ |
| 856 | |
| 857 | Response Body: |
| 858 | |
| 859 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 860 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 861 | +================+=========+===========+==========================+===========================================+ |
| 862 | |request |M |1 |request Object |Content of request object. | |
| 863 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 864 | |
| 865 | Request Object |
| 866 | |
| 867 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 868 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 869 | +===================+=========+===========+==========================+===========================================+ |
| 870 | |requestId |M |1 |String |Request Id | |
| 871 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 872 | |startTime |M |1 |request Object |Start time. | |
| 873 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 874 | |requestScope |M |1 |request Object |Scope of the request. | |
| 875 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 876 | |requestType |M |1 |request Object |Type of the request. | |
| 877 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 878 | |requestDetails |M |1 |requestDetails Object |Type of the request. | |
| 879 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 880 | |requestStatus |M |1 |requestStatus Object |Type of the request. | |
| 881 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 882 | |
| 883 | RequestDetails Object |
| 884 | |
| 885 | +-------------------+--------------------------+-------------------------------------------------+ |
| 886 | |Attribute |Content |Description | |
| 887 | +===================+==========================+=================================================+ |
| 888 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 889 | +-------------------+--------------------------+-------------------------------------------------+ |
| 890 | |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | |
| 891 | +-------------------+--------------------------+-------------------------------------------------+ |
| 892 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 893 | +-------------------+--------------------------+-------------------------------------------------+ |
| 894 | |requestParameters |requestParameters Object |Content of requestParameters object. | |
| 895 | +-------------------+--------------------------+-------------------------------------------------+ |
| 896 | |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | |
| 897 | +-------------------+--------------------------+-------------------------------------------------+ |
| 898 | |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | |
| 899 | +-------------------+--------------------------+-------------------------------------------------+ |
| 900 | |project |project Object |Content of project object. | |
| 901 | +-------------------+--------------------------+-------------------------------------------------+ |
| 902 | |owningEntity |owningEntity Object |Content of owningEntity object. | |
| 903 | +-------------------+--------------------------+-------------------------------------------------+ |
| 904 | |platform |platform Object |Content of platform object. | |
| 905 | +-------------------+--------------------------+-------------------------------------------------+ |
| 906 | |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | |
| 907 | +-------------------+--------------------------+-------------------------------------------------+ |
| 908 | |
| 909 | ModelInfo Object |
| 910 | |
| 911 | +-------------------------+------------------+-------------------------------------------------+ |
| 912 | |Attribute |Content |Description | |
| 913 | +=========================+==================+=================================================+ |
| 914 | |ModelType |String |Type of model | |
| 915 | +-------------------------+------------------+-------------------------------------------------+ |
| 916 | |ModelInvariantId |String |The Model Invariant Id. | |
| 917 | +-------------------------+------------------+-------------------------------------------------+ |
| 918 | |ModelNameVersionId |String |The modelname Version Id | |
| 919 | +-------------------------+------------------+-------------------------------------------------+ |
| 920 | |ModelName |String |Name of the Model | |
| 921 | +-------------------------+------------------+-------------------------------------------------+ |
| 922 | |ModelVersion |String |Version of the model | |
| 923 | +-------------------------+------------------+-------------------------------------------------+ |
| 924 | |ModelCustomization Name |String |The Model Customization name | |
| 925 | +-------------------------+------------------+-------------------------------------------------+ |
| 926 | |modelCustomizationUuid |String |The Model Customization UUid | |
| 927 | +-------------------------+------------------+-------------------------------------------------+ |
| 928 | |modelVersionId |String |The Model version id | |
| 929 | +-------------------------+------------------+-------------------------------------------------+ |
| 930 | |modelUuid |String |The Model UUid | |
| 931 | +-------------------------+------------------+-------------------------------------------------+ |
| 932 | |modelInvariantUuid |String |The Model Invariant UUid | |
| 933 | +-------------------------+------------------+-------------------------------------------------+ |
| 934 | |modelInstanceName |String |The Model Instance name | |
| 935 | +-------------------------+------------------+-------------------------------------------------+ |
| 936 | |
| 937 | SubscriberInfo Object |
| 938 | |
| 939 | +-------------------------+------------------+-------------------------------------------------+ |
| 940 | |Attribute |Content |Description | |
| 941 | +=========================+==================+=================================================+ |
| 942 | |GlobalSubscriberId |String |Global customer Id (in A&AI) | |
| 943 | +-------------------------+------------------+-------------------------------------------------+ |
| 944 | |SubscriberName |String |Name of the Subscriber | |
| 945 | +-------------------------+------------------+-------------------------------------------------+ |
| 946 | |
| 947 | RequestInfo Object |
| 948 | |
| 949 | +-------------------------+------------------+-------------------------------------------------+ |
| 950 | |Attribute |Content |Description | |
| 951 | +=========================+==================+=================================================+ |
| 952 | |Source |String |source of the request | |
| 953 | +-------------------------+------------------+-------------------------------------------------+ |
| 954 | |billingAccountNumber |String |billingAccountNumber of the request | |
| 955 | +-------------------------+------------------+-------------------------------------------------+ |
| 956 | |callbackUrl |String |callbackUrl of the request | |
| 957 | +-------------------------+------------------+-------------------------------------------------+ |
| 958 | |correlator |String |correlator of the request | |
| 959 | +-------------------------+------------------+-------------------------------------------------+ |
| 960 | |orderNumber |String |orderNumber of the request | |
| 961 | +-------------------------+------------------+-------------------------------------------------+ |
| 962 | |productFamilyId |String |productFamilyId of the request | |
| 963 | +-------------------------+------------------+-------------------------------------------------+ |
| 964 | |orderVersion |String |orderVersion of the request | |
| 965 | +-------------------------+------------------+-------------------------------------------------+ |
| 966 | |instanceName |String |instanceName of the request | |
| 967 | +-------------------------+------------------+-------------------------------------------------+ |
| 968 | |suppressRollback |String |suppressRollback of the request | |
| 969 | +-------------------------+------------------+-------------------------------------------------+ |
| 970 | |requestorId |String |requestorId of the request | |
| 971 | +-------------------------+------------------+-------------------------------------------------+ |
| 972 | |
| 973 | RequestParameters Object |
| 974 | |
| 975 | +-------------------------+------------------+-------------------------------------------------+ |
| 976 | |Attribute |Content |Description | |
| 977 | +=========================+==================+=================================================+ |
| 978 | |SubscriptionServiceType |String |The service type of the Subscription | |
| 979 | +-------------------------+------------------+-------------------------------------------------+ |
| 980 | |
| 981 | RequestStatus Object |
| 982 | |
| 983 | +-------------------------+------------------+-------------------------------------------------+ |
| 984 | |Attribute |Content |Description | |
| 985 | +=========================+==================+=================================================+ |
| 986 | |finishTime |String |Time | |
| 987 | +-------------------------+------------------+-------------------------------------------------+ |
| 988 | |requestState |String |state of the request | |
| 989 | +-------------------------+------------------+-------------------------------------------------+ |
| 990 | |statusMessage |String |statusMessage | |
| 991 | +-------------------------+------------------+-------------------------------------------------+ |
| 992 | |percentProgress |String |percentage of progress | |
| 993 | +-------------------------+------------------+-------------------------------------------------+ |
| 994 | |
| 995 | GET Orchestration Requests |
| 996 | ++++++++++++++++++++++++++ |
| 997 | |
| 998 | +--------------------+--------------------------------------------------------------+ |
| 999 | |Interface Definition|Description | |
| 1000 | +====================+==============================================================+ |
| 1001 | |URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 | |
| 1002 | +--------------------+--------------------------------------------------------------+ |
| 1003 | |Operation Type |GET | |
| 1004 | +--------------------+--------------------------------------------------------------+ |
| 1005 | |Content-Type |application/json | |
| 1006 | +--------------------+--------------------------------------------------------------+ |
| 1007 | |
| 1008 | Response Body: |
| 1009 | |
| 1010 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1011 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1012 | +================+=========+===========+==========================+===========================================+ |
| 1013 | |requestList |M |1 |Array |Content of request List. | |
| 1014 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1015 | |
| 1016 | RequestList : |
| 1017 | |
| 1018 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1019 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1020 | +================+=========+===========+==========================+===========================================+ |
| 1021 | |request |M |1 |request Object |Content of request object. | |
| 1022 | +----------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1023 | |
| 1024 | Request Object |
| 1025 | |
| 1026 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1027 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1028 | +===================+=========+===========+==========================+===========================================+ |
| 1029 | |requestId |M |1 |String |Request Id. | |
| 1030 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1031 | |startTime |M |1 |request Object |Start time. | |
| 1032 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1033 | |requestScope |M |1 |request Object |Scope of the request. | |
| 1034 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1035 | |requestType |M |1 |request Object |Type of the request. | |
| 1036 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1037 | |requestDetails |M |1 |requestDetails Object |Type of the request. | |
| 1038 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1039 | |requestStatus |M |1 |requestStatus Object |Type of the request. | |
| 1040 | +-------------------+---------+-----------+--------------------------+-------------------------------------------+ |
| 1041 | |
| 1042 | RequestDetails Object |
| 1043 | |
| 1044 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1045 | |Attribute |Content |Description | |
| 1046 | +===================+==========================+=================================================+ |
| 1047 | |modelInfo |modelInfo Object |Content of modelInfo object. | |
| 1048 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1049 | |subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | |
| 1050 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1051 | |requestInfo |requestInfo Object |Content of requestInfo object. | |
| 1052 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1053 | |requestParameters |requestParameters Object |Content of requestParameters object. | |
| 1054 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1055 | |relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | |
| 1056 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1057 | |cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | |
| 1058 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1059 | |project |project Object |Content of project object. | |
| 1060 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1061 | |owningEntity |owningEntity Object |Content of owningEntity object. | |
| 1062 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1063 | |platform |platform Object |Content of platform object. | |
| 1064 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1065 | |lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | |
| 1066 | +-------------------+--------------------------+-------------------------------------------------+ |
| 1067 | |
| 1068 | ModelInfo Object |
| 1069 | |
| 1070 | +-------------------------+------------------+-------------------------------------------------+ |
| 1071 | |Attribute |Content |Description | |
| 1072 | +=========================+==================+=================================================+ |
| 1073 | |ModelType |String |Type of model | |
| 1074 | +-------------------------+------------------+-------------------------------------------------+ |
| 1075 | |ModelInvariantId |String |The Model Invariant Id. | |
| 1076 | +-------------------------+------------------+-------------------------------------------------+ |
| 1077 | |ModelNameVersionId |String |The modelname Version Id | |
| 1078 | +-------------------------+------------------+-------------------------------------------------+ |
| 1079 | |ModelName |String |Name of the Model | |
| 1080 | +-------------------------+------------------+-------------------------------------------------+ |
| 1081 | |ModelVersion |String |Version of the model | |
| 1082 | +-------------------------+------------------+-------------------------------------------------+ |
| 1083 | |ModelCustomization Name |String |The Model Customization name | |
| 1084 | +-------------------------+------------------+-------------------------------------------------+ |
| 1085 | |modelCustomizationUuid |String |The Model Customization UUid | |
| 1086 | +-------------------------+------------------+-------------------------------------------------+ |
| 1087 | |modelVersionId |String |The Model version id | |
| 1088 | +-------------------------+------------------+-------------------------------------------------+ |
| 1089 | |modelUuid |String |The Model UUid | |
| 1090 | +-------------------------+------------------+-------------------------------------------------+ |
| 1091 | |modelInvariantUuid |String |The Model Invariant UUid | |
| 1092 | +-------------------------+------------------+-------------------------------------------------+ |
| 1093 | |modelInstanceName |String |The Model Instance name | |
| 1094 | +-------------------------+------------------+-------------------------------------------------+ |
| 1095 | |
| 1096 | SubscriberInfo Object |
| 1097 | |
| 1098 | +-------------------------+------------------+-------------------------------------------------+ |
| 1099 | |Attribute |Content |Description | |
| 1100 | +=========================+==================+=================================================+ |
| 1101 | |GlobalSubscriberId |String |Global customer Id (in A&AI) | |
| 1102 | +-------------------------+------------------+-------------------------------------------------+ |
| 1103 | |SubscriberName |String |Name of the Subscriber | |
| 1104 | +-------------------------+------------------+-------------------------------------------------+ |
| 1105 | |
| 1106 | RequestInfo Object |
| 1107 | |
| 1108 | +-------------------------+------------------+-------------------------------------------------+ |
| 1109 | |Attribute |Content |Description | |
| 1110 | +=========================+==================+=================================================+ |
| 1111 | |Source |String |source of the request | |
| 1112 | +-------------------------+------------------+-------------------------------------------------+ |
| 1113 | |billingAccountNumber |String |billingAccountNumber of the request | |
| 1114 | +-------------------------+------------------+-------------------------------------------------+ |
| 1115 | |callbackUrl |String |callbackUrl of the request | |
| 1116 | +-------------------------+------------------+-------------------------------------------------+ |
| 1117 | |correlator |String |correlator of the request | |
| 1118 | +-------------------------+------------------+-------------------------------------------------+ |
| 1119 | |orderNumber |String |orderNumber of the request | |
| 1120 | +-------------------------+------------------+-------------------------------------------------+ |
| 1121 | |productFamilyId |String |productFamilyId of the request | |
| 1122 | +-------------------------+------------------+-------------------------------------------------+ |
| 1123 | |orderVersion |String |orderVersion of the request | |
| 1124 | +-------------------------+------------------+-------------------------------------------------+ |
| 1125 | |instanceName |String |instanceName of the request | |
| 1126 | +-------------------------+------------------+-------------------------------------------------+ |
| 1127 | |suppressRollback |String |suppressRollback of the request | |
| 1128 | +-------------------------+------------------+-------------------------------------------------+ |
| 1129 | |requestorId |String |requestorId of the request | |
| 1130 | +-------------------------+------------------+-------------------------------------------------+ |
| 1131 | |
| 1132 | RequestParameters Object |
| 1133 | |
| 1134 | +-------------------------+------------------+-------------------------------------------------+ |
| 1135 | |Attribute |Content |Description | |
| 1136 | +=========================+==================+=================================================+ |
| 1137 | |SubscriptionServiceType |String |The service type of the Subscription | |
| 1138 | +-------------------------+------------------+-------------------------------------------------+ |
| 1139 | |
| 1140 | RequestStatus Object |
| 1141 | |
| 1142 | +-------------------------+------------------+-------------------------------------------------+ |
| 1143 | |Attribute |Content |Description | |
| 1144 | +=========================+==================+=================================================+ |
| 1145 | |finishTime |String |Time | |
| 1146 | +-------------------------+------------------+-------------------------------------------------+ |
| 1147 | |requestState |String |state of the request | |
| 1148 | +-------------------------+------------------+-------------------------------------------------+ |
| 1149 | |statusMessage |String |statusMessage | |
| 1150 | +-------------------------+------------------+-------------------------------------------------+ |
| 1151 | |percentProgress |String |percentage of progress | |
| 1152 | +-------------------------+------------------+-------------------------------------------------+ |
| 1153 | |
| 1154 | SDC Client API |
| 1155 | ------------------ |
| 1156 | |
| 1157 | Get List of Existing Catalog Assets |
| 1158 | +++++++++++++++++++++++++++++++++++ |
| 1159 | |
| 1160 | +--------------------+--------------------------+ |
| 1161 | |Interface Definition|Description | |
| 1162 | +====================+==========================+ |
| 1163 | |URI |sdc/v1/catalog/{assetType}| |
| 1164 | +--------------------+--------------------------+ |
| 1165 | |Operation Type |GET | |
| 1166 | +--------------------+--------------------------+ |
| 1167 | |
| 1168 | Request Parameters: |
| 1169 | |
| 1170 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 1171 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1172 | +===================+=========+===========+=======+=============================================================+ |
| 1173 | |assetType |M |1 |String |The requested asset type.valid values are resources/services.| |
| 1174 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 1175 | |service-type |M |1 |String |Service Type | |
| 1176 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 1177 | |service-instance-id|M |1 |String |Service Instance ID | |
| 1178 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 1179 | |
| 1180 | Request Headers: |
| 1181 | |
| 1182 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1183 | |Header Name |Qualifier|Description | |
| 1184 | +===================+=========+=========================================================================================+ |
| 1185 | |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt| |
| 1186 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1187 | |X-ECOMP-InstanceID |Y |Instance ID | |
| 1188 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1189 | |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”| |
| 1190 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1191 | |Authorization |Y |Base64 encoded username:password | |
| 1192 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1193 | |
| 1194 | Response: |
| 1195 | |
| 1196 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1197 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1198 | +==================+=========+===========+=======+======================================================================================+ |
| 1199 | |uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. | |
| 1200 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1201 | |invariantUUID |M |1 |String |UUID generated by SDC per each asset. | |
| 1202 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1203 | |name |M |1 |String |The name of the asset | |
| 1204 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1205 | |version |M |1 |String |The asset version in SDC catalog. | |
| 1206 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1207 | |toscaModelURL |M |1 |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. | |
| 1208 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1209 | |category |M |1 |String |Category of the asset. | |
| 1210 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1211 | |subcategory |M |1 |String |Sub-category of the asset | |
| 1212 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1213 | |resourceType |M |1 |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF. | |
| 1214 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1215 | |lifecycleState |M |1 |String |The lifecycle state of the asset | |
| 1216 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1217 | |lastUpdaterUserId |M |1 |String |UserID of the SDC designer who was the last to update the asset for this major version| |
| 1218 | +------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+ |
| 1219 | |
| 1220 | Get Specific Asset Detailed Metadata |
| 1221 | ++++++++++++++++++++++++++++++++++++ |
| 1222 | |
| 1223 | +--------------------+-------------------------------------------+ |
| 1224 | |Interface Definition|Description | |
| 1225 | +====================+===========================================+ |
| 1226 | |URI |/sdc/v1/catalog/{assetType}/{uuid}/metadata| |
| 1227 | +--------------------+-------------------------------------------+ |
| 1228 | |Operation Type |GET | |
| 1229 | +--------------------+-------------------------------------------+ |
| 1230 | |
| 1231 | Request Parameters: |
| 1232 | |
| 1233 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1234 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1235 | +===================+=========+===========+=======+=====================================================================================+ |
| 1236 | |assetType |M |1 |String |The requested asset type.valid values are resources/services. | |
| 1237 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1238 | |uuid |M |1 |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.| |
| 1239 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1240 | |
| 1241 | Request Headers: |
| 1242 | |
| 1243 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1244 | |Header Name |Qualifier|Description | |
| 1245 | +===================+=========+=========================================================================================+ |
| 1246 | |X-ECOMP-RequestID |N |request ID.If it is not sent it will be automatically generated by SDC on request receipt| |
| 1247 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1248 | |X-ECOMP-InstanceID |Y |Instance ID | |
| 1249 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1250 | |Accept |N |Determines the format of the body of the response. Valid values are : “application/json”| |
| 1251 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1252 | |Authorization |Y |Base64 encoded username:password | |
| 1253 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 1254 | |
| 1255 | Response: |
| 1256 | |
| 1257 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1258 | |Attribute |Qualifier|Content|Description | |
| 1259 | +====================+=========+=======+======================================================================================+ |
| 1260 | |uuid |M |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. | |
| 1261 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1262 | |invariantUUID |M |String |UUID generated by SDC per each asset. | |
| 1263 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1264 | |name |M |String |The name of the asset | |
| 1265 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1266 | |version |M |String |The asset version in SDC catalog. | |
| 1267 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1268 | |toscaModelURL |M |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR. | |
| 1269 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1270 | |description |M |String |Short description of the resource | |
| 1271 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1272 | |lastUpdaterUserId |M |String |UserID of the SDC designer who was the last to update the asset for this major version| |
| 1273 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1274 | |lastUpdaterFullName |M |String |UserID of the SDC designer who was the last to update the asset for this major version| |
| 1275 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1276 | |category |M |String |Category of the asset | |
| 1277 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1278 | |subCategory |M |String |Sub-category of the asset. | |
| 1279 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1280 | |toscaResourceName |M |String |The full name of the asset | |
| 1281 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1282 | |resourceType |M |String |The type of resource. | |
| 1283 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1284 | |lifecycleState |M |String |The lifecycle state of the asset | |
| 1285 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1286 | |resources |N |Object |Category of the asset | |
| 1287 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1288 | |artifacts |M |Object |Category of the asset | |
| 1289 | +--------------------+---------+-------+--------------------------------------------------------------------------------------+ |
| 1290 | |
| 1291 | Resource Object: |
| 1292 | |
| 1293 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1294 | |Attribute |Qualifier|Content|Description | | |
| 1295 | +=====================+=========+=======+===================================================================================================================+ |
| 1296 | |resourceInstanceName |M |String |Logical Resource Instance Name.Unique Identifier of the instance of the specific resource in the service context.| |
| 1297 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1298 | |resourceName |M |String |Resource Name | |
| 1299 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1300 | |resourceInvariantUUID|M |String |The invariant UUID of the resource | |
| 1301 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1302 | |resourceVersion |M |String |Resource Version | |
| 1303 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1304 | |resoucreType |M |String |Resource Type | |
| 1305 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1306 | |resourceUUID |M |String |Global UUID of the resource that specific artifact belongs to | |
| 1307 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1308 | |artifacts |M |Object |Array of resource instance deployment artifacts. | |
| 1309 | +---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+ |
| 1310 | |
| 1311 | Artifact Metadata Object: |
| 1312 | |
| 1313 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1314 | |Attribute |Qualifier|Content |Description | |
| 1315 | +=====================+=========+========+===================================================================================================================+ |
| 1316 | |artifactName |M |String |Artifact File name | |
| 1317 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1318 | |artifactLabel |M |String |Identifier of the artifact within the VF / Service. | |
| 1319 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1320 | |artifactType |M |String |Artifact Type | |
| 1321 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1322 | |artifactGroupType |M |String |Whether the artifact is informational or deployment. | |
| 1323 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1324 | |artifactURL |M |String |Relative artifact’s URL. | |
| 1325 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1326 | |artifactDescription |M |String |Artifact Description | |
| 1327 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1328 | |artifactTimeout |N |Integer |Artifact Description | |
| 1329 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1330 | |artifactChecksum |M |String |Base-64 encoded MD5 checksum of the artifact’s payload. | |
| 1331 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1332 | |artifactUUID |M |String |Global UUID generated by SDC each time when artifact payload is updated. | |
| 1333 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1334 | |artifactVersion |M |String |Service Version | |
| 1335 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1336 | |generatedFromUUID |N |String |This attribute will be sent only in the case of an artifact generated on basis of other artifact | |
| 1337 | +---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+ |
| 1338 | |
| 1339 | Download (CSAR of) Specific Asset |
| 1340 | +++++++++++++++++++++++++++++++++ |
| 1341 | |
| 1342 | +--------------------+-----------------------------------------------------------+ |
| 1343 | |Interface Definition|Description | |
| 1344 | +====================+===========================================================+ |
| 1345 | |URI |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}| |
| 1346 | +--------------------+-----------------------------------------------------------+ |
| 1347 | |Operation Type |GET | |
| 1348 | +--------------------+-----------------------------------------------------------+ |
| 1349 | |
| 1350 | Request Parameters: |
| 1351 | |
| 1352 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1353 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1354 | +===================+=========+===========+=======+=====================================================================================+ |
| 1355 | |assetType |M |1 |String |The requested asset type.valid values are resources/services. | |
| 1356 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1357 | |Uuid |M |1 |String |The uuid of the asset as published in the metadata | |
| 1358 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1359 | |artifactUUID |M |1 |String |The artifactUUID of the asset as published in the metadata | |
| 1360 | +-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+ |
| 1361 | |
| 1362 | Response: |
| 1363 | |
| 1364 | +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+ |
| 1365 | |Header name |Qualifier|Description | |
| 1366 | +====================+=========+==========================================================================================================================+ |
| 1367 | |Content-Type |M |Specifies the downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream | |
| 1368 | +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+ |
| 1369 | |Content-Length |M |Streamed artifact payload size | |
| 1370 | +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+ |
| 1371 | |Content-Disposition |M |Specifies the name of file to store the downloaded artifact’s payload ( RFC 2183) . | |
| 1372 | +--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+ |
| 1373 | |
| 1374 | E2E Service API |
| 1375 | ---------------- |
| 1376 | |
| 1377 | Create E2E service instance |
| 1378 | ++++++++++++++++++++++++++++ |
| 1379 | |
| 1380 | +--------------------+-------------------------------------+ |
| 1381 | |Interface Definition|Description | |
| 1382 | +====================+=====================================+ |
| 1383 | |URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3 | |
| 1384 | +--------------------+-------------------------------------+ |
| 1385 | |Operation Type |POST | |
| 1386 | +--------------------+-------------------------------------+ |
| 1387 | |Content-Type |application/json | |
| 1388 | +--------------------+-------------------------------------+ |
| 1389 | |
| 1390 | Request Body: |
| 1391 | |
| 1392 | +---------+---------+-----------+--------------------------+-----------------------------+ |
| 1393 | |Attribute|Qualifier|Cardinality|Content |Description | |
| 1394 | +=========+=========+===========+==========================+=============================+ |
| 1395 | |service |M |1 |Service Object |Content of service object. | |
| 1396 | +---------+---------+-----------+--------------------------+-----------------------------+ |
| 1397 | |
| 1398 | Service Object |
| 1399 | |
| 1400 | +------------------------------+-----------------+------------------------------------+ |
| 1401 | |Attribute |Content |Description | |
| 1402 | +==============================+=================+====================================+ |
| 1403 | |name |String |Service instance name. | |
| 1404 | +------------------------------+-----------------+------------------------------------+ |
| 1405 | |description |String |Service instance description | |
| 1406 | +------------------------------+-----------------+------------------------------------+ |
| 1407 | |serviceUuid |String |Model UUID | |
| 1408 | +------------------------------+-----------------+------------------------------------+ |
| 1409 | |serviceInvariantUuid |String |Model Invariant UUID | |
| 1410 | +------------------------------+-----------------+------------------------------------+ |
| 1411 | |gloabalSubscriberId |String |Customer Id | |
| 1412 | +------------------------------+-----------------+------------------------------------+ |
| 1413 | |serviceType |String |service Type | |
| 1414 | +------------------------------+-----------------+------------------------------------+ |
| 1415 | |parameters |Object |Parameter Object | |
| 1416 | +------------------------------+-----------------+------------------------------------+ |
| 1417 | |
| 1418 | Parameter Object |
| 1419 | |
| 1420 | +------------------------------+-----------------+------------------------------------+ |
| 1421 | |Attribute |Content |Description | |
| 1422 | +==============================+=================+====================================+ |
| 1423 | |locationConstraints |List of object |location infor for each vnf | |
| 1424 | +------------------------------+-----------------+------------------------------------+ |
| 1425 | |resource |List of Resource |resource of service/resource | |
| 1426 | +------------------------------+-----------------+------------------------------------+ |
| 1427 | |requestInputs |key-value map |input of service/resource |
| 1428 | +------------------------------+-----------------+------------------------------------+ |
| 1429 | |
| 1430 | LocationConstraint Object |
| 1431 | |
| 1432 | +------------------------------+-----------------+------------------------------------+ |
| 1433 | |Attribute |Content |Description | |
| 1434 | +==============================+=================+====================================+ |
| 1435 | |vnfProfileId |String |Customization id for VNF | |
| 1436 | +------------------------------+-----------------+------------------------------------+ |
| 1437 | |locationConstraints |Object |DC location info of VNF | |
| 1438 | +------------------------------+-----------------+------------------------------------+ |
| 1439 | |
| 1440 | VnfLocationConstraint Object |
| 1441 | |
| 1442 | +------------------------------+-----------------+------------------------------------+ |
| 1443 | |Attribute |Content |Description | |
| 1444 | +==============================+=================+====================================+ |
| 1445 | |vimId |String |VIM id from ESR definition | |
| 1446 | +------------------------------+-----------------+------------------------------------+ |
| 1447 | |
| 1448 | Resource Object |
| 1449 | |
| 1450 | +------------------------------+-----------------+------------------------------------+ |
| 1451 | |Attribute |Content |Description | |
| 1452 | +==============================+=================+====================================+ |
| 1453 | |resourceName |String |The resource name | |
| 1454 | +------------------------------+-----------------+------------------------------------+ |
| 1455 | |resourceInvariantUuid |String |The resource invariant UUID. | |
| 1456 | +------------------------------+-----------------+------------------------------------+ |
| 1457 | |resourceUuid |String |The resource UUID. | |
| 1458 | +------------------------------+-----------------+------------------------------------+ |
| 1459 | |resourceCustomizationUuid |String |The resource customization UUID. | |
| 1460 | +------------------------------+-----------------+------------------------------------+ |
| 1461 | |parameters |Object |Parameter of resource | |
| 1462 | +------------------------------+-----------------+------------------------------------+ |
| 1463 | |
| 1464 | Response: |
| 1465 | |
| 1466 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1467 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1468 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1469 | |serviceId |M |1 |String |Service instance ID. | |
| 1470 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1471 | |operationId |M |1 |String |Service Operation ID. | |
| 1472 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1473 | |
| 1474 | Delete E2E service instance |
| 1475 | ++++++++++++++++++++++++++++ |
| 1476 | |
| 1477 | +--------------------+-----------------------------------------------+ |
| 1478 | |Interface Definition|Description | |
| 1479 | +====================+===============================================+ |
| 1480 | |URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}| |
| 1481 | +--------------------+-----------------------------------------------+ |
| 1482 | |Operation Type |DELETE | |
| 1483 | +--------------------+-----------------------------------------------+ |
| 1484 | |
| 1485 | Request Parameters: |
| 1486 | |
| 1487 | +-------------------+---------+-----------+-------+----------------------------------------+ |
| 1488 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1489 | +===================+=========+===========+=======+========================================+ |
| 1490 | |globalSubscriberId |M |1 |String |The subscriber id. It is defined in AAI | |
| 1491 | +-------------------+---------+-----------+-------+----------------------------------------+ |
| 1492 | |serviceType |M |1 |String |The service type. It is defined in AAI | |
| 1493 | +-------------------+---------+-----------+-------+----------------------------------------+ |
| 1494 | |
| 1495 | Response: |
| 1496 | |
| 1497 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1498 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1499 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1500 | |operationId |M |1 |String |The operation id. | |
| 1501 | +-------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1502 | |
| 1503 | Query E2E service operation result |
| 1504 | ++++++++++++++++++++++++++ |
| 1505 | |
| 1506 | +--------------------+------------------------------------------------------------------------+ |
| 1507 | |Interface Definition|Description | |
| 1508 | +====================+========================================================================+ |
| 1509 | |URI |/onap/so/infra/serviceInstantiation/e2eServiceInstances/v3/{serviceId}/operations/{operationId}| |
| 1510 | +--------------------+------------------------------------------------------------------------+ |
| 1511 | |Operation Type |GET | |
| 1512 | +--------------------+------------------------------------------------------------------------+ |
| 1513 | |
| 1514 | Request Parameters: |
| 1515 | |
| 1516 | +--------------+---------+-----------+-------+--------------+ |
| 1517 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1518 | +==============+=========+===========+=======+==============+ |
| 1519 | |serviceId |M |1 |Service instance ID. | |
| 1520 | +--------------+---------+-----------+-------+--------------+ |
| 1521 | |operationId |M |1 |Service Operation ID. | |
| 1522 | +--------------+---------+-----------+-------+--------------+ |
| 1523 | |
| 1524 | Response: |
| 1525 | |
| 1526 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1527 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1528 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1529 | |operation |M |1 |String |Operation object identify. | |
| 1530 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1531 | |operationId |M |1 |String |Operation ID. | |
| 1532 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1533 | |operation |M |1 |String |Operation type, create|delete. | |
| 1534 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1535 | |result |M |1 |String |Operation result: finished, error, processing. | |
| 1536 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1537 | |reason |M |1 |String |If failing, need to write fail reason. | |
| 1538 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1539 | |userId |M |1 |String |Operation user ID. | |
| 1540 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1541 | |operationContent |M |1 |String |The status detail of current operation which is being executing. | |
| 1542 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1543 | |progress |M |1 |String |Current operation progress. | |
| 1544 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1545 | |operateAt |M |1 |String |Time that it starts to execute operation. | |
| 1546 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1547 | |finishedAt |M |1 |String |Time that it finished executing operation. | |
| 1548 | +------------------+---------+-----------+-------+------------------------------------------------------------------------+ |
| 1549 | |
| 1550 | Inventory APIs |
| 1551 | ---------------- |
| 1552 | |
| 1553 | create or update an existing service-instance |
| 1554 | +++++++++++++++++++++++++++++++++++++++++++++ |
| 1555 | |
| 1556 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1557 | |Interface Definition|Description | |
| 1558 | +====================+====================================================================================================================================================================+ |
| 1559 | |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}| |
| 1560 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1561 | |Operation Type |PUT | |
| 1562 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1563 | |
| 1564 | Request Parameters: |
| 1565 | |
| 1566 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1567 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1568 | +===================+=========+===========+=======+=======================+ |
| 1569 | |global-customer-id |M |1 |String |Global Customer ID | |
| 1570 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1571 | |service-type |M |1 |String |Service Type | |
| 1572 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1573 | |service-instance-id|M |1 |String |Service Instance ID | |
| 1574 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1575 | |
| 1576 | Response: |
| 1577 | |
| 1578 | +---------+---------+-----------+-------+-------------------+ |
| 1579 | |Attribute|Qualifier|Cardinality|Content|Description | |
| 1580 | +---------+---------+-----------+-------+-------------------+ |
| 1581 | |HTTP code|M |1 |Integer|HTTP response code | |
| 1582 | +---------+---------+-----------+-------+-------------------+ |
| 1583 | |
| 1584 | delete an existing service-instance |
| 1585 | +++++++++++++++++++++++++++++++++++ |
| 1586 | |
| 1587 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1588 | |Interface Definition|Description | |
| 1589 | +====================+====================================================================================================================================================================+ |
| 1590 | |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}| |
| 1591 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1592 | |Operation Type |DELETE | |
| 1593 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1594 | |
| 1595 | Request Parameters: |
| 1596 | |
| 1597 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1598 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1599 | +===================+=========+===========+=======+=======================+ |
| 1600 | |global-customer-id |M |1 |String |Global Customer ID | |
| 1601 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1602 | |service-type |M |1 |String |Service Type | |
| 1603 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1604 | |service-instance-id|M |1 |String |Service Instance ID | |
| 1605 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1606 | |
| 1607 | Response: |
| 1608 | |
| 1609 | +---------+---------+-----------+-------+-------------------+ |
| 1610 | |Attribute|Qualifier|Cardinality|Content|Description | |
| 1611 | +---------+---------+-----------+-------+-------------------+ |
| 1612 | |HTTP code|M |1 |Integer|HTTP response code | |
| 1613 | +---------+---------+-----------+-------+-------------------+ |
| 1614 | |
| 1615 | get service-instances |
| 1616 | +++++++++++++++++++++ |
| 1617 | |
| 1618 | +--------------------+-----------------------------------------------------------------------------------------------------------------------------+ |
| 1619 | |Interface Definition|Description | |
| 1620 | +====================+=============================================================================================================================+ |
| 1621 | |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances| |
| 1622 | +--------------------+-----------------------------------------------------------------------------------------------------------------------------+ |
| 1623 | |Operation Type |GET | |
| 1624 | +--------------------+-----------------------------------------------------------------------------------------------------------------------------+ |
| 1625 | |
| 1626 | Request Parameters: |
| 1627 | |
| 1628 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1629 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1630 | +===================+=========+===========+=======+=======================+ |
| 1631 | |global-customer-id |M |1 |String |Global Customer ID | |
| 1632 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1633 | |service-type |M |1 |String |Service Type | |
| 1634 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1635 | |subscriber-name |O |1 |String |Subscriber name | |
| 1636 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1637 | |subscriber-type |O |1 |String |Subscriber type | |
| 1638 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1639 | |
| 1640 | Response: |
| 1641 | |
| 1642 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1643 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1644 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1645 | |service-instances|M |1 |ServiceInstances|Service Instances | |
| 1646 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1647 | |
| 1648 | get service-instance |
| 1649 | ++++++++++++++++++++ |
| 1650 | |
| 1651 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1652 | |Interface Definition|Description | |
| 1653 | +====================+====================================================================================================================================================================+ |
| 1654 | |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}| |
| 1655 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1656 | |Operation Type |GET | |
| 1657 | +--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1658 | |
| 1659 | Request Parameters: |
| 1660 | |
| 1661 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1662 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1663 | +===================+=========+===========+=======+=======================+ |
| 1664 | |global-customer-id |M |1 |String |Global Customer ID | |
| 1665 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1666 | |service-type |M |1 |String |Service Type | |
| 1667 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1668 | |service-instance-id|M |1 |String |Service instance ID | |
| 1669 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1670 | |
| 1671 | Response: |
| 1672 | |
| 1673 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1674 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1675 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1676 | |service-instance |M |1 |ServiceInstance |Service Instance | |
| 1677 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1678 | |
| 1679 | see node definition for valid relationships |
| 1680 | +++++++++++++++++++++++++++++++++++++++++++ |
| 1681 | |
| 1682 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1683 | |Interface Definition|Description | |
| 1684 | +====================+===================================================================================================================================================================================================+ |
| 1685 | |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship| |
| 1686 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1687 | |Operation Type |PUT | |
| 1688 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1689 | |
| 1690 | Request Parameters: |
| 1691 | |
| 1692 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1693 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1694 | +===================+=========+===========+=======+=======================+ |
| 1695 | |global-customer-id |M |1 |String |Global Customer ID | |
| 1696 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1697 | |service-type |M |1 |String |Service Type | |
| 1698 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1699 | |service-instance-id|M |1 |String |Service instance ID | |
| 1700 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1701 | |
| 1702 | Response: |
| 1703 | |
| 1704 | +---------+---------+-----------+-------+-------------------+ |
| 1705 | |Attribute|Qualifier|Cardinality|Content|Description | |
| 1706 | +---------+---------+-----------+-------+-------------------+ |
| 1707 | |HTTP code|M |1 |Integer|HTTP response code | |
| 1708 | +---------+---------+-----------+-------+-------------------+ |
| 1709 | |
| 1710 | delete an existing relationship |
| 1711 | +++++++++++++++++++++++++++++++ |
| 1712 | |
| 1713 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1714 | |Interface Definition|Description | |
| 1715 | +====================+===================================================================================================================================================================================================+ |
| 1716 | |URI |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship| |
| 1717 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1718 | |Operation Type |DELETE | |
| 1719 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1720 | |
| 1721 | Request Parameters: |
| 1722 | |
| 1723 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1724 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1725 | +===================+=========+===========+=======+=======================+ |
| 1726 | |global-customer-id |M |1 |String |Global Customer ID | |
| 1727 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1728 | |service-type |M |1 |String |Service Type | |
| 1729 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1730 | |service-instance-id|M |1 |String |Service instance ID | |
| 1731 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1732 | |
| 1733 | Response: |
| 1734 | |
| 1735 | +---------+---------+-----------+-------+-------------------+ |
| 1736 | |Attribute|Qualifier|Cardinality|Content|Description | |
| 1737 | +---------+---------+-----------+-------+-------------------+ |
| 1738 | |HTTP code|M |1 |Integer|HTTP response code | |
| 1739 | +---------+---------+-----------+-------+-------------------+ |
| 1740 | |
| 1741 | |
| 1742 | VFC APIs |
| 1743 | --------- |
| 1744 | |
| 1745 | Create NS |
| 1746 | +++++++++++ |
| 1747 | |
| 1748 | +--------------------+-------------------+ |
| 1749 | |Interface Definition|Description | |
| 1750 | +====================+===================+ |
| 1751 | |URI |/ns | |
| 1752 | +--------------------+-------------------+ |
| 1753 | |Operation Type |POST | |
| 1754 | +--------------------+-------------------+ |
| 1755 | |Content-Type |application/json | |
| 1756 | +--------------------+-------------------+ |
| 1757 | |
| 1758 | Request Parameters: |
| 1759 | |
| 1760 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1761 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1762 | +===================+=========+===========+=======+=======================+ |
| 1763 | |context |M |1 |Object |Context | |
| 1764 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1765 | |csarId |M |1 |String |csarId | |
| 1766 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1767 | |nsName |M |1 |String |Name of the NS | |
| 1768 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1769 | |description |M |1 |String |description | |
| 1770 | +-------------------+---------+-----------+-------+-----------------------+ |
| 1771 | |
| 1772 | Response: |
| 1773 | |
| 1774 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1775 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1776 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1777 | |nsInstanceId |M |1 |String |nsInstanceId | |
| 1778 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1779 | |
| 1780 | Get NS |
| 1781 | +++++++ |
| 1782 | |
| 1783 | +--------------------+-------------------+ |
| 1784 | |Interface Definition|Description | |
| 1785 | +====================+===================+ |
| 1786 | |URI |/ns | |
| 1787 | +--------------------+-------------------+ |
| 1788 | |Operation Type |GET | |
| 1789 | +--------------------+-------------------+ |
| 1790 | |Content-Type |application/json | |
| 1791 | +--------------------+-------------------+ |
| 1792 | |
| 1793 | Response: |
| 1794 | |
| 1795 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1796 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1797 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1798 | |nsInstanceId |M |1 |String |nsInstanceId | |
| 1799 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1800 | |nsName |M |1 |String |The name of ns | |
| 1801 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1802 | |description |M |1 |String |description | |
| 1803 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1804 | |nsdId |M |1 |String |ID of ns | |
| 1805 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1806 | |vnfInfo |M |1 |Array |Vnf information | |
| 1807 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1808 | |vlInfo |M |1 |Array |vl information | |
| 1809 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1810 | |vnffgInfo |M |1 |Array |vnffg information | |
| 1811 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1812 | |nsState |M |1 |String |state of ns | |
| 1813 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1814 | |
| 1815 | vnfInfo Object: |
| 1816 | |
| 1817 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1818 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1819 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1820 | |vnfInstanceId |M |1 |String |vnfInstanceId | |
| 1821 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1822 | |vnfInstanceName |M |1 |String |vnfInstanceName | |
| 1823 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1824 | |vnfdId |M |1 |String |vnfdId | |
| 1825 | +-----------------+---------+-----------+----------------+-------------------+ |
| 1826 | |
| 1827 | vlInfo Object: |
| 1828 | |
| 1829 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1830 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1831 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1832 | |vlInstanceId |M |1 |String |vlInstanceId | |
| 1833 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1834 | |vlInstanceName |M |1 |String |vlInstanceName | |
| 1835 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1836 | |vldId |M |1 |String |vldId | |
| 1837 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1838 | |relatedCpInstanceId |M |1 |Array |relatedCpInstanceId| |
| 1839 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1840 | |
| 1841 | relatedCpInstanceId Array: |
| 1842 | |
| 1843 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1844 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1845 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1846 | |cpInstanceId |M |1 |String |cpInstanceId | |
| 1847 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1848 | |cpInstanceName |M |1 |String |cpInstanceName | |
| 1849 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1850 | |cpdId |M |1 |String |cpdId | |
| 1851 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1852 | |
| 1853 | vnffgInfo Array: |
| 1854 | |
| 1855 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1856 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1857 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1858 | |vnffgInstanceId |M |1 |String |vnffgInstanceId | |
| 1859 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1860 | |vnfId |M |1 |String |vnfId | |
| 1861 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1862 | |pnfId |M |1 |String |pnfId | |
| 1863 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1864 | |virtualLinkId |M |1 |Array |virtualLinkId | |
| 1865 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1866 | |cpId |M |1 |Array |cpId | |
| 1867 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1868 | |nfp |M |1 |Array |nfp | |
| 1869 | +----------------------+---------+-----------+----------------+-------------------+ |
| 1870 | |
| 1871 | Instantiate NS |
| 1872 | +++++++++++++++ |
| 1873 | |
| 1874 | +--------------------+-------------------------------------+ |
| 1875 | |Interface Definition|Description | |
| 1876 | +====================+=====================================+ |
| 1877 | |URI |/ns/{nsInstanceId}/Instantiate | |
| 1878 | +--------------------+-------------------------------------+ |
| 1879 | |Operation Type |POST | |
| 1880 | +--------------------+-------------------------------------+ |
| 1881 | |Content-Type |application/json | |
| 1882 | +--------------------+-------------------------------------+ |
| 1883 | |
| 1884 | Request Parameters: |
| 1885 | |
| 1886 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1887 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1888 | +======================+=========+===========+=======+=======================+ |
| 1889 | |LocationConstraints |M |1 |Array |LocationConstraints | |
| 1890 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1891 | |additionalParamForNs |M |1 |String |additionalParamForNs | |
| 1892 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1893 | |nsInstanceId |M |1 |String |nsInstanceId | |
| 1894 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1895 | |
| 1896 | LocationConstraints Array: |
| 1897 | |
| 1898 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1899 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1900 | +======================+=========+===========+=======+=======================+ |
| 1901 | |vnfProfileId |M |1 |String |vnfProfileId | |
| 1902 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1903 | |vimid |M |1 |String |vimid | |
| 1904 | +----------------------+---------+-----------+-------+-----------------------+ |
| 1905 | |
| 1906 | Response: |
| 1907 | |
| 1908 | +--------------+---------+-----------+-------+-----------------------+ |
| 1909 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1910 | +==============+=========+===========+=======+=======================+ |
| 1911 | |jobId |M |1 |String |jobId | |
| 1912 | +--------------+---------+-----------+-------+-----------------------+ |
| 1913 | |
| 1914 | Terminate NS |
| 1915 | +++++++++++++++ |
| 1916 | |
| 1917 | +--------------------+-------------------------------------+ |
| 1918 | |Interface Definition|Description | |
| 1919 | +====================+=====================================+ |
| 1920 | |URI |/ns/{ns_instance_id}/terminate | |
| 1921 | +--------------------+-------------------------------------+ |
| 1922 | |Operation Type |POST | |
| 1923 | +--------------------+-------------------------------------+ |
| 1924 | |Content-Type |application/json | |
| 1925 | +--------------------+-------------------------------------+ |
| 1926 | |
| 1927 | Request Parameters: |
| 1928 | |
| 1929 | +----------------------------+---------+-----------+-------+-----------------------------+ |
| 1930 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1931 | +============================+=========+===========+=======+=============================+ |
| 1932 | |terminationType |M |1 |String |terminationType | |
| 1933 | +----------------------------+---------+-----------+-------+-----------------------------+ |
| 1934 | |gracefulTerminationTimeout |M |1 |String |gracefulTerminationTimeout | |
| 1935 | +----------------------------+---------+-----------+-------+-----------------------------+ |
| 1936 | |nsInstanceId |M |1 |String |nsInstanceId | |
| 1937 | +----------------------------+---------+-----------+-------+-----------------------------+ |
| 1938 | |
| 1939 | Response: |
| 1940 | |
| 1941 | +--------------+---------+-----------+-------+-----------------------+ |
| 1942 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1943 | +==============+=========+===========+=======+=======================+ |
| 1944 | |jobId |M |1 |String |jobId | |
| 1945 | +--------------+---------+-----------+-------+-----------------------+ |
| 1946 | |
| 1947 | Delete NS |
| 1948 | +++++++++++++++ |
| 1949 | |
| 1950 | +--------------------+-------------------------------------+ |
| 1951 | |Interface Definition|Description | |
| 1952 | +====================+=====================================+ |
| 1953 | |URI |/ns/{ns_instance_id} | |
| 1954 | +--------------------+-------------------------------------+ |
| 1955 | |Operation Type |DELETE | |
| 1956 | +--------------------+-------------------------------------+ |
| 1957 | |
| 1958 | Request Parameters: |
| 1959 | |
| 1960 | +----------------------------+---------+-----------+-------+-----------------------------+ |
| 1961 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 1962 | +============================+=========+===========+=======+=============================+ |
| 1963 | |nsInstanceId |M |1 |String |nsInstanceId | |
| 1964 | +----------------------------+---------+-----------+-------+-----------------------------+ |
| 1965 | |
| 1966 | MultiVIM API |
| 1967 | ---------------- |
| 1968 | Get token |
| 1969 | ++++++++++ |
| 1970 | |
| 1971 | https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization |
| 1972 | |
| 1973 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 1974 | |Interface Definition|Description | |
| 1975 | +====================+===============================================================================================+ |
| 1976 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens | |
| 1977 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 1978 | |Operation Type |POST | |
| 1979 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 1980 | |Content-Type |application/json | |
| 1981 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 1982 | |
| 1983 | Request Body: |
| 1984 | |
| 1985 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1986 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 1987 | +================+=========+===========+==========================+================================================================================================================================================+ |
| 1988 | |nocatalog |O |1 |string |The authentication response excludes the service catalog. By default, the response includes the service catalog. | |
| 1989 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1990 | |name |O |1 |string |The user name. Required if you do not specify the ID of the user. If you specify the user name, you must also specify the domain, by ID or name.| |
| 1991 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1992 | |auth |M |1 |object |An auth object. | |
| 1993 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1994 | |user |M |1 |object |A user object. | |
| 1995 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1996 | |scope |O |1 |string |The authorization scope, including either a project or a domain | |
| 1997 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 1998 | |password |M |1 |object |The password object, contains the authentication information. | |
| 1999 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 2000 | |id |O |1 |string |The ID of the user. Required if you do not specify the user name. | |
| 2001 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 2002 | |identity |M |1 |object |An identity object. | |
| 2003 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 2004 | |methods |M |1 |array |The authentication method. For password authentication, specify password. | |
| 2005 | +----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 2006 | |
| 2007 | Response: |
| 2008 | |
| 2009 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2010 | |Attribute |Content |Description | |
| 2011 | +=========================+==================+==========================================================================+ |
| 2012 | |X-Subject-Token |String |The authentication token. | |
| 2013 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2014 | |domain |object |A domain object, containing: | |
| 2015 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2016 | |region_id |String |The ID of the region that contains the service endpoint. | |
| 2017 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2018 | |methods |array |The authentication method. For password authentication, specify password. | |
| 2019 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2020 | |roles |array |A list of role objects, each containing: | |
| 2021 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2022 | |url |String |The endpoint URL. | |
| 2023 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2024 | |region |String |The geographic location of the service endpoint. | |
| 2025 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2026 | |token |object |A token object. | |
| 2027 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2028 | |expires_at |String |The date and time when the token expires. | |
| 2029 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2030 | |project |object |A project object, containing: | |
| 2031 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2032 | |issued_at |String |The date and time when the token was issued. | |
| 2033 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2034 | |catalog |array |A catalog object. | |
| 2035 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2036 | |extras |object |A set of metadata key and value pairs, if any. | |
| 2037 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2038 | |user |object |A user object. | |
| 2039 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2040 | |audit_ids |array |A list of one or two audit IDs. | |
| 2041 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2042 | |interface |String |The interface type, which describes the visibility of the endpoint. | |
| 2043 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2044 | |endpoints |array |A list of endpoint objects. | |
| 2045 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2046 | |type |String |The endpoint type. | |
| 2047 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2048 | |id |String |The ID of the user. Required if you do not specify the user name. | |
| 2049 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2050 | |name |String |The user name. | |
| 2051 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2052 | |
| 2053 | Create stack |
| 2054 | +++++++++++++ |
| 2055 | |
| 2056 | https://developer.openstack.org/api-ref/orchestration/v1/#create-stack |
| 2057 | |
| 2058 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 2059 | |Interface Definition|Description | |
| 2060 | +====================+===============================================================================================+ |
| 2061 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks | |
| 2062 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 2063 | |Operation Type |POST | |
| 2064 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 2065 | |Content-Type |application/json | |
| 2066 | +--------------------+-----------------------------------------------------------------------------------------------+ |
| 2067 | |
| 2068 | Request Body: |
| 2069 | |
| 2070 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2071 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2072 | +==================+=========+===========+==========================+=================================================================================================+ |
| 2073 | |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. | |
| 2074 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2075 | |disable_rollback |O |1 |boolean |Enables or disables deletion of all stack resources when stack creation fails. | |
| 2076 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2077 | |environment |O |1 |object |A JSON environment for the stack. | |
| 2078 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2079 | |files |O |1 |object |Supplies the contents of files referenced in the template or the environment. | |
| 2080 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2081 | |parameters |O |1 |object |Supplies arguments for parameters defined in the stack template. | |
| 2082 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2083 | |stack_name |M |1 |string |A name for the stack. | |
| 2084 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2085 | |tags |O |1 |string |One or more simple string tags to associate with the stack. | |
| 2086 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2087 | |template |O |1 |object |The stack template on which to perform the operation. | |
| 2088 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2089 | |template_url |O |1 |string |A URI to the location containing the stack template on which to perform the operation. | |
| 2090 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2091 | |timeout_mins |O |1 |integer |The timeout for stack creation in minutes. | |
| 2092 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2093 | |
| 2094 | Response: |
| 2095 | |
| 2096 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2097 | |Attribute |Content |Description | |
| 2098 | +=========================+==================+==========================================================================+ |
| 2099 | |location |String |For asynchronous resource operations. | |
| 2100 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2101 | |X-Openstack-Reqeuest-Id |object |A domain object, containing: | |
| 2102 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2103 | |stack |String |The ID of the region that contains the service endpoint. | |
| 2104 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2105 | |id |String |The authentication method. For password authentication, specify password. | |
| 2106 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2107 | |links |String |The authentication method. For password authentication, specify password. | |
| 2108 | +-------------------------+------------------+--------------------------------------------------------------------------+ |
| 2109 | |
| 2110 | Get stack |
| 2111 | +++++++++++++ |
| 2112 | |
| 2113 | https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details |
| 2114 | |
| 2115 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2116 | |Interface Definition|Description | |
| 2117 | +====================+=======================================================================================================================+ |
| 2118 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} | |
| 2119 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2120 | |Operation Type |GET | |
| 2121 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2122 | |Content-Type |application/json | |
| 2123 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2124 | |
| 2125 | Request Body: |
| 2126 | |
| 2127 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2128 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2129 | +==================+=========+===========+==========================+=================================================================================================+ |
| 2130 | |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. | |
| 2131 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2132 | |stack_name |M |1 |string |The name of a stack. | |
| 2133 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2134 | |stack_id |M |1 |string |The UUID of the stack. | |
| 2135 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2136 | |resolve_outputs |O |1 |boolean |A boolean indicating whether the outputs section of a stack should be resolved. | |
| 2137 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2138 | |
| 2139 | Response: |
| 2140 | |
| 2141 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2142 | |Attribute |Content |Description | |
| 2143 | +=========================+==================+==============================================================================+ |
| 2144 | |X-Openstack-Reqeuest-Id |String |A unique ID for tracking service request. | |
| 2145 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2146 | |stack |Object |The stack object. | |
| 2147 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2148 | |capabilities |array |List of stack capabilities for stack. | |
| 2149 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2150 | |creation_time |String |The date and time when the resource was created. | |
| 2151 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2152 | |deletion_time |String |The date and time when the resource was (soft-) deleted. | |
| 2153 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2154 | |description |String |The description of the stack resource. | |
| 2155 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2156 | |disable_rollback |boolean |Whether deletion of all stack resources when stack creation fails is enabled. | |
| 2157 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2158 | |id |String |The UUID of the stack. | |
| 2159 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2160 | |links |array |A list of URLs for the stack. | |
| 2161 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2162 | |notification_topics |array |List of notification topics for stack. | |
| 2163 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2164 | |outputs |array |A list of stack outputs. | |
| 2165 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2166 | |parameters |object | A group of key-value pairs | |
| 2167 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2168 | |parent |String |The stack ID of the parent stack, if this is a nested stack. | |
| 2169 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2170 | |stack_name |String |A name for the stack. | |
| 2171 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2172 | |stack_owner |String |The owner of the stack. | |
| 2173 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2174 | |stack_status |String |The status of the stack. | |
| 2175 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2176 | |stack_status_reason |String |The reason for the current status of the stack. | |
| 2177 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2178 | |stack_user_project_id |String |The project UUID of the stack user. | |
| 2179 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2180 | |tags |array |The stack tags. | |
| 2181 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2182 | |template_description |String |The description of the stack template. | |
| 2183 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2184 | |timeout_mins |integer |The timeout for stack creation in minutes. | |
| 2185 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2186 | |updated_time |String |The date and time when the object was updated. | |
| 2187 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2188 | |
| 2189 | Delete stack |
| 2190 | +++++++++++++ |
| 2191 | |
| 2192 | https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details |
| 2193 | |
| 2194 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2195 | |Interface Definition|Description | |
| 2196 | +====================+=======================================================================================================================+ |
| 2197 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id} | |
| 2198 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2199 | |Operation Type |DELETE | |
| 2200 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2201 | |Content-Type |application/json | |
| 2202 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2203 | |
| 2204 | Request Body: |
| 2205 | |
| 2206 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2207 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2208 | +==================+=========+===========+==========================+=================================================================================================+ |
| 2209 | |tenant_id |M |1 |string |The UUID of the tenant. A tenant is also known as a project. | |
| 2210 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2211 | |stack_name |M |1 |string |The name of a stack. | |
| 2212 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2213 | |stack_id |M |1 |string |The UUID of the stack. | |
| 2214 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2215 | |
| 2216 | Create server |
| 2217 | +++++++++++++ |
| 2218 | |
| 2219 | https://developer.openstack.org/api-ref/compute/#create-server |
| 2220 | |
| 2221 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2222 | |Interface Definition|Description | |
| 2223 | +====================+=======================================================================================================================+ |
| 2224 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.37/{tenant_id}/servers | |
| 2225 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2226 | |Operation Type |POST | |
| 2227 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2228 | |Content-Type |application/json | |
| 2229 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2230 | |
| 2231 | Request Body: |
| 2232 | |
| 2233 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2234 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2235 | +================================================+=========+===========+==========================+=================================================================================================+ |
| 2236 | |server |M |1 |object |A server object. | |
| 2237 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2238 | |name |M |1 |string |The server name. | |
| 2239 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2240 | |flavorRef |M |1 |string |The flavor reference, as an ID (including a UUID) or full URL | |
| 2241 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2242 | |imageRef |M |1 |string |The UUID of the image to use for your server instance | |
| 2243 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2244 | |security_groups |O |1 |array |One or more security groups. | |
| 2245 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2246 | |metadata |O |1 |object |Metadata key and value pairs. | |
| 2247 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2248 | |accessIPv4 |O |1 |string |IPv4 address that should be used to access this server. | |
| 2249 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2250 | |accessIPv6 |O |1 |string |IPv6 address that should be used to access this server. | |
| 2251 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2252 | |adminPass |O |1 |string |The administrative password of the server. | |
| 2253 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2254 | |user_data |O |1 |string |Configuration information or scripts to use upon launch. | |
| 2255 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2256 | |availability_zone |O |1 |string |The availability zone from which to launch the server. | |
| 2257 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2258 | |networks |M |1 |object |A networks object. | |
| 2259 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2260 | |networks.uuid |O |1 |string |To provision the server instance with a NIC for a network | |
| 2261 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2262 | |networks.port |O |1 |string |To provision the server instance with a NIC for an already existing port | |
| 2263 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2264 | |networks.fixed_ip |O |1 |string |A fixed IPv4 address for the NIC | |
| 2265 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2266 | |networks.tag |O |1 |string |A device role tag that can be applied to a network interface. | |
| 2267 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2268 | |personality |O |1 |array |The file path and contents, text only, to inject into the server at launch. | |
| 2269 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2270 | |block_device_mapping_v2 |O |1 |array |Enables fine grained control of the block device mapping for an instance. | |
| 2271 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2272 | |block_device_mapping_v2.device_name |M |1 |string |A path to the device for the volume that you want to use to boot the server. | |
| 2273 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2274 | |block_device_mapping_v2.source_type |M |1 |string |The source type of the volume. | |
| 2275 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2276 | |block_device_mapping_v2.destination_type |O |1 |string |Defines where the volume comes from. | |
| 2277 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2278 | |block_device_mapping_v2.delete_on_termination |O |1 |string |To delete the boot volume when the server is destroyed, specify true. | |
| 2279 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2280 | |block_device_mapping_v2.guest_format |M |1 |string |Specifies the guest server disk file system format, such as ephemeral or swap. | |
| 2281 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2282 | |block_device_mapping_v2.boot_index |M |1 |string |Defines the order in which a hypervisor tries devices | |
| 2283 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2284 | |block_device_mapping_v2.uuid |O |1 |string |This is the uuid of source resource. | |
| 2285 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2286 | |block_device_mapping_v2.tag |O |1 |string |A device role tag that can be applied to a block device. | |
| 2287 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2288 | |block_device_mapping_v2.disk_bus |O |1 |string |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter | |
| 2289 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2290 | |config_drive |O |1 |boolean |Indicates whether a configuration drive enables metadata injection. | |
| 2291 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2292 | |key_name |O |1 |string |Key pair name. | |
| 2293 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2294 | |os:scheduler_hints |O |1 |object |The dictionary of data to send to the scheduler. | |
| 2295 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2296 | |OS-DCF:diskConfig |O |1 |string |Controls how the API partitions the disk when you create, rebuild, or resize servers. | |
| 2297 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2298 | |description |O |1 |string |A free form description of the server. | |
| 2299 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2300 | |tags |O |1 |array |A list of tags. | |
| 2301 | +------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2302 | |
| 2303 | Response: |
| 2304 | |
| 2305 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2306 | |Attribute |Content |Description | |
| 2307 | +=========================+==================+==============================================================================+ |
| 2308 | |Location |String |The location URL of the server. | |
| 2309 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2310 | |server |object |A server object. | |
| 2311 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2312 | |id |String |The UUID of the server. | |
| 2313 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2314 | |links |array |Links to the resources in question. | |
| 2315 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2316 | |OS-DCF:diskConfig |String |Disk configuration. | |
| 2317 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2318 | |security_groups |array |One or more security groups objects. | |
| 2319 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2320 | |security_groups.name |String |The security group name. | |
| 2321 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2322 | |adminPass |String |The administrative password for the server. | |
| 2323 | +-------------------------+------------------+------------------------------------------------------------------------------+ |
| 2324 | |
| 2325 | Delete server |
| 2326 | +++++++++++++ |
| 2327 | |
| 2328 | https://developer.openstack.org/api-ref/compute/#delete-server |
| 2329 | |
| 2330 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2331 | |Interface Definition|Description | |
| 2332 | +====================+=======================================================================================================================+ |
| 2333 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id} | |
| 2334 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2335 | |Operation Type |DELETE | |
| 2336 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2337 | |Content-Type |application/json | |
| 2338 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2339 | |
| 2340 | Request Body: |
| 2341 | |
| 2342 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2343 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2344 | +==================+=========+===========+==========================+=================================================================================================+ |
| 2345 | |server_id |M |1 |string |The UUID of the server. | |
| 2346 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2347 | |
| 2348 | Create Keypair |
| 2349 | +++++++++++++++ |
| 2350 | |
| 2351 | https://developer.openstack.org/api-ref/compute/#create-or-import-keypair |
| 2352 | |
| 2353 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2354 | |Interface Definition|Description | |
| 2355 | +====================+=======================================================================================================================+ |
| 2356 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs | |
| 2357 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2358 | |Operation Type |POST | |
| 2359 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2360 | |Content-Type |application/json | |
| 2361 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2362 | |
| 2363 | Request Body: |
| 2364 | |
| 2365 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2366 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2367 | +==================+=========+===========+==========================+=================================================================================================+ |
| 2368 | |keypair |M |1 |Object |Keypair object | |
| 2369 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2370 | |name |M |1 |string |A name for the keypair which will be used to reference it later. | |
| 2371 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2372 | |public_key |O |1 |string |The public ssh key to import. If you omit this value, a keypair is generated for you. | |
| 2373 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2374 | |type |O |1 |string |The type of the keypair. | |
| 2375 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2376 | |user_id |O |1 |string |The user_id for a keypair. | |
| 2377 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2378 | |
| 2379 | Response: |
| 2380 | |
| 2381 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2382 | |Attribute |Content |Description | |
| 2383 | +=================+==================+==============================================================================+ |
| 2384 | |keypair |object |Keypair object | |
| 2385 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2386 | |name |String |A name for the keypair which will be used to reference it later. | |
| 2387 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2388 | |public_key |String |The keypair public key. | |
| 2389 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2390 | |fingerprint |String |The fingerprint for the keypair. | |
| 2391 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2392 | |user_id |String |The user_id for a keypair. | |
| 2393 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2394 | |private_key |String |If you do not provide a public key on create | |
| 2395 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2396 | |type |String |The type of the keypair. | |
| 2397 | +-----------------+------------------+------------------------------------------------------------------------------+ |
| 2398 | |
| 2399 | Delete Keypair |
| 2400 | +++++++++++++++ |
| 2401 | |
| 2402 | https://developer.openstack.org/api-ref/compute/#delete-keypair |
| 2403 | |
| 2404 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2405 | |Interface Definition|Description | |
| 2406 | +====================+=======================================================================================================================+ |
| 2407 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id} | |
| 2408 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2409 | |Operation Type |DELETE | |
| 2410 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2411 | |Content-Type |application/json | |
| 2412 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2413 | |
| 2414 | Request Body: |
| 2415 | |
| 2416 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2417 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2418 | +==================+=========+===========+==========================+=================================================================================================+ |
| 2419 | |keypair_name |M |1 |String |The keypair name. | |
| 2420 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2421 | |user_id |O |1 |String |This allows administrative users to operate key-pairs of specified user ID. | |
| 2422 | +------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2423 | |
| 2424 | Create Network |
| 2425 | +++++++++++++++ |
| 2426 | |
| 2427 | https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network |
| 2428 | |
| 2429 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2430 | |Interface Definition|Description | |
| 2431 | +====================+=======================================================================================================================+ |
| 2432 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks | |
| 2433 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2434 | |Operation Type |POST | |
| 2435 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2436 | |Content-Type |application/json | |
| 2437 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2438 | |
| 2439 | Request Body: |
| 2440 | |
| 2441 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2442 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2443 | +============================+=========+===========+==========================+=================================================================================================+ |
| 2444 | |network |M |1 |Object |A network object. | |
| 2445 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2446 | |admin_state_up |O |1 |boolean |The administrative state of the network, which is up (true) or down (false). | |
| 2447 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2448 | |dns_domain |O |1 |string |A valid DNS domain. | |
| 2449 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2450 | |mtu |O |1 |integer |The maximum transmission unit (MTU) value to address fragmentation. | |
| 2451 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2452 | |name |O |1 |string |Human-readable name of the network. | |
| 2453 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2454 | |port_security_enabled |O |1 |boolean |The port security status of the network. | |
| 2455 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2456 | |project_id |O |1 |string |The ID of the project that owns the resource. | |
| 2457 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2458 | |provider:network_type |O |1 |string |The type of physical network that this network should be mapped to. | |
| 2459 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2460 | |provider:physical_network |O |1 |string |The physical network where this network should be implemented. | |
| 2461 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2462 | |provider:segmentation_id |O |1 |integer |The ID of the isolated segment on the physical network. | |
| 2463 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2464 | |qos_policy_id |O |1 |string |The ID of the QoS policy. | |
| 2465 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2466 | |router:external |O |1 |boolean |Indicates whether this network can provide floating IPs via a router. | |
| 2467 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2468 | |segments |O |1 |array |A list of provider segment objects. | |
| 2469 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2470 | |shared |O |1 |boolean |Indicates whether this network is shared across all tenants. | |
| 2471 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2472 | |tenant_id |O |1 |string |The ID of the project that owns the resource. | |
| 2473 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2474 | |vlan_transparent |O |1 |boolean |Indicates the VLAN transparency mode of the network, | |
| 2475 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2476 | |description |O |1 |string |A human-readable description for the resource. | |
| 2477 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2478 | |is_default |O |1 |boolean |The network is default or not. | |
| 2479 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2480 | |availability_zone_hints |O |1 |array |The availability zone candidate for the network. | |
| 2481 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2482 | |
| 2483 | Response: |
| 2484 | |
| 2485 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2486 | |Attribute |Content |Description | |
| 2487 | +=============================+==================+==============================================================================+ |
| 2488 | |network |object |A network object. | |
| 2489 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2490 | |admin_state_up |boolean |The administrative state of the network, which is up (true) or down (false). | |
| 2491 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2492 | |availability_zone_hints |array |The availability zone candidate for the network. | |
| 2493 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2494 | |availability_zones |array |The availability zone for the network. | |
| 2495 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2496 | |created_at |String |Time at which the resource has been created (in UTC ISO8601 format). | |
| 2497 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2498 | |dns_domain |String |A valid DNS domain. | |
| 2499 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2500 | |id |String |The ID of the network. | |
| 2501 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2502 | |ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. | |
| 2503 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2504 | |ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. | |
| 2505 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2506 | |mtu |integer |The maximum transmission unit (MTU) value to address fragmentation. | |
| 2507 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2508 | |name |String |Human-readable name of the network. | |
| 2509 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2510 | |port_security_enabled |boolean |The port security status of the network. | |
| 2511 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2512 | |project_id |String |The ID of the project. | |
| 2513 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2514 | |provider:network_type |String |The type of physical network that this network is mapped to. | |
| 2515 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2516 | |provider:physical_network |String |The physical network where this network is implemented. | |
| 2517 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2518 | |provider:segmentation_id |integer |The ID of the isolated segment on the physical network. | |
| 2519 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2520 | |qos_policy_id |String |The ID of the QoS policy. | |
| 2521 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2522 | |revision_number |integer |The revision number of the resource. | |
| 2523 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2524 | |router:external |boolean |Indicates whether this network can provide floating IPs via a router. | |
| 2525 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2526 | |segments |array |A list of provider segment objects. | |
| 2527 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2528 | |shared |boolean |Indicates whether this network is shared across all tenants. | |
| 2529 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2530 | |status |String |The network status. Values are ACTIVE, DOWN, BUILD or ERROR. | |
| 2531 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2532 | |subnets |array |The associated subnets. | |
| 2533 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2534 | |tenant_id |String |The ID of the project. | |
| 2535 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2536 | |updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). | |
| 2537 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2538 | |vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. | |
| 2539 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2540 | |description |String |A human-readable description for the resource. | |
| 2541 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2542 | |is_default |boolean |The network is default pool or not. | |
| 2543 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2544 | |
| 2545 | Delete Network |
| 2546 | +++++++++++++++ |
| 2547 | |
| 2548 | https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network |
| 2549 | |
| 2550 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2551 | |Interface Definition|Description | |
| 2552 | +====================+=======================================================================================================================+ |
| 2553 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id} | |
| 2554 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2555 | |Operation Type |DELETE | |
| 2556 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2557 | |Content-Type |application/json | |
| 2558 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2559 | |
| 2560 | Request Body: |
| 2561 | |
| 2562 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2563 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2564 | +============================+=========+===========+==========================+==============================================================+ |
| 2565 | |network_id |M |1 |String |The ID of the network. | |
| 2566 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2567 | |
| 2568 | Create Subnet |
| 2569 | +++++++++++++++ |
| 2570 | |
| 2571 | https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet |
| 2572 | |
| 2573 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2574 | |Interface Definition|Description | |
| 2575 | +====================+=======================================================================================================================+ |
| 2576 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets | |
| 2577 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2578 | |Operation Type |POST | |
| 2579 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2580 | |Content-Type |application/json | |
| 2581 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2582 | |
| 2583 | Request Body: |
| 2584 | |
| 2585 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2586 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2587 | +============================+=========+===========+==========================+=================================================================================================+ |
| 2588 | |subnet |M |1 |string |A subnet object. | |
| 2589 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2590 | |tenant_id |O |1 |string |The ID of the project that owns the resource. | |
| 2591 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2592 | |project_id |O |1 |string |The ID of the project that owns the resource. | |
| 2593 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2594 | |name |O |1 |string |Human-readable name of the resource. | |
| 2595 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2596 | |enable_dhcp |O |1 |boolean |Indicates whether dhcp is enabled or disabled for the subnet. | |
| 2597 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2598 | |network_id |M |1 |string |The ID of the network to which the subnet belongs. | |
| 2599 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2600 | |dns_nameservers |O |1 |array |List of dns name servers associated with the subnet. | |
| 2601 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2602 | |allocation_pools |O |1 |array |Allocation pools with start and end IP addresses for this subnet. | |
| 2603 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2604 | |host_routes |O |1 |array |Additional routes for the subnet. | |
| 2605 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2606 | |ip_version |M |1 |integer |The IP protocol version. Value is 4 or 6. | |
| 2607 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2608 | |gateway_ip |O |1 |string |Gateway IP of this subnet. | |
| 2609 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2610 | |cidr |M |1 |string |The CIDR of the subnet. | |
| 2611 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2612 | |description |O |1 |string |A human-readable description for the resource. | |
| 2613 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2614 | |ipv6_address_mode |O |1 |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. | |
| 2615 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2616 | |ipv6_ra_mode |O |1 |string |The IPv6 router advertisement specifies whether the networking service | |
| 2617 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2618 | |segment_id |O |1 |string |The ID of a network segment the subnet is associated with. | |
| 2619 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2620 | |subnetpool_id |O |1 |string |The ID of the subnet pool associated with the subnet. | |
| 2621 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2622 | |use_default_subnetpool |O |1 |boolean |Whether to allocate this subnet from the default subnet pool. | |
| 2623 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2624 | |service_types |O |1 |array |The service types associated with the subnet. | |
| 2625 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2626 | |
| 2627 | Response: |
| 2628 | |
| 2629 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2630 | |Attribute |Content |Description | |
| 2631 | +=============================+==================+==============================================================================+ |
| 2632 | |subnet |string |A subnet object. | |
| 2633 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2634 | |id |string |The ID of the subnet. | |
| 2635 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2636 | |tenant_id |string |The ID of the project. | |
| 2637 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2638 | |project_id |string |The ID of the project. | |
| 2639 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2640 | |name |String |Human-readable name of the resource. | |
| 2641 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2642 | |enable_dhcp |boolean |Indicates whether dhcp is enabled or disabled for the subnet. | |
| 2643 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2644 | |network_id |String |The ID of the network to which the subnet belongs. | |
| 2645 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2646 | |dns_nameservers |array |List of dns name servers associated with the subnet. | |
| 2647 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2648 | |allocation_pools |array |Allocation pools with start and end IP addresses for this subnet. | |
| 2649 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2650 | |host_routes |array |Additional routes for the subnet. | |
| 2651 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2652 | |ip_version |integer |The IP protocol version. Value is 4 or 6. | |
| 2653 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2654 | |gateway_ip |string |Gateway IP of this subnet. | |
| 2655 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2656 | |cidr |string |The CIDR of the subnet. | |
| 2657 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2658 | |created_at |string |Time at which the subnet has been created. | |
| 2659 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2660 | |description |string |A human-readable description for the resource. | |
| 2661 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2662 | |ipv6_address_mode |string |The IPv6 address modes specifies mechanisms for assigning IP addresses. | |
| 2663 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2664 | |ipv6_ra_mode |string |The IPv6 router advertisement specifies whether the networking service | |
| 2665 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2666 | |revision_number |integer |The revision number of the resource. | |
| 2667 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2668 | |service_types |string |The service types associated with the subnet. | |
| 2669 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2670 | |subnetpool_id |string |The ID of the subnet pool associated with the subnet. | |
| 2671 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2672 | |segment_id |string |The ID of a network segment the subnet is associated with. | |
| 2673 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2674 | |updated_at |string |Time at which the subnet has been updated. | |
| 2675 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2676 | |
| 2677 | Delete Subnet |
| 2678 | +++++++++++++++ |
| 2679 | |
| 2680 | https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet |
| 2681 | |
| 2682 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2683 | |Interface Definition|Description | |
| 2684 | +====================+=======================================================================================================================+ |
| 2685 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id} | |
| 2686 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2687 | |Operation Type |DELETE | |
| 2688 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2689 | |Content-Type |application/json | |
| 2690 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2691 | |
| 2692 | Request Body: |
| 2693 | |
| 2694 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2695 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2696 | +============================+=========+===========+==========================+==============================================================+ |
| 2697 | |subnet_id |M |1 |String |The ID of the subnet. | |
| 2698 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2699 | |
| 2700 | Create Port |
| 2701 | +++++++++++++++ |
| 2702 | |
| 2703 | https://developer.openstack.org/api-ref/networking/v2/#create-port |
| 2704 | |
| 2705 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2706 | |Interface Definition|Description | |
| 2707 | +====================+=======================================================================================================================+ |
| 2708 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports | |
| 2709 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2710 | |Operation Type |POST | |
| 2711 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2712 | |Content-Type |application/json | |
| 2713 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2714 | |
| 2715 | Request Body: |
| 2716 | |
| 2717 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2718 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2719 | +============================+=========+===========+==========================+=================================================================================================+ |
| 2720 | |port |M |1 |object |A port object. | |
| 2721 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2722 | |admin_state_up |O |1 |boolean |The administrative state of the resource. | |
| 2723 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2724 | |allowed_address_pairs |O |1 |array |A set of zero or more allowed address pairs. | |
| 2725 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2726 | |binding:host_id |O |1 |string |The ID of the host where the port resides. | |
| 2727 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2728 | |binding:profile |O |1 |string |A dictionary that enables the application running on the specific host | |
| 2729 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2730 | |binding:vnic_type |O |1 |string |The type of vNIC which this port should be attached to. | |
| 2731 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2732 | |description |O |1 |string |A human-readable description for the resource. | |
| 2733 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2734 | |device_id |O |1 |string |The ID of the device that uses this port. | |
| 2735 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2736 | |device_owner |O |1 |string |The entity type that uses this port. | |
| 2737 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2738 | |dns_domain |O |1 |string |A valid DNS domain. | |
| 2739 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2740 | |dns_name |O |1 |string |A valid DNS name. | |
| 2741 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2742 | |extra_dhcp_opts |O |1 |array |A set of zero or more extra DHCP option pairs. | |
| 2743 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2744 | |fixed_ips |O |1 |array |The IP addresses for the port. | |
| 2745 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2746 | |mac_address |O |1 |string |The MAC address of the port. | |
| 2747 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2748 | |name |O |1 |string |Human-readable name of the resource. | |
| 2749 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2750 | |network_id |M |1 |string |The ID of the attached network. | |
| 2751 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2752 | |port_security_enabled |O |1 |boolean |The port security status. | |
| 2753 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2754 | |project_id |O |1 |string |The ID of the project that owns the resource. | |
| 2755 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2756 | |qos_policy_id |O |1 |string |QoS policy associated with the port. | |
| 2757 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2758 | |security_groups |O |1 |array |The IDs of security groups applied to the port. | |
| 2759 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2760 | |tenant_id |O |1 |string |The ID of the project that owns the resource. | |
| 2761 | +----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ |
| 2762 | |
| 2763 | Response: |
| 2764 | |
| 2765 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2766 | |Attribute |Content |Description | |
| 2767 | +=============================+==================+==============================================================================+ |
| 2768 | |port |object |A port object. | |
| 2769 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2770 | |admin_state_up |boolean |The administrative state of the resource. | |
| 2771 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2772 | |allowed_address_pairs |array |A set of zero or more allowed address pairs. | |
| 2773 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2774 | |binding:host_id |string |The ID of the host where the port resides. | |
| 2775 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2776 | |binding:profile |String |A dictionary that enables the application running on the specific host | |
| 2777 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2778 | |binding:vif_details |object |A dictionary which contains additional information on the port. | |
| 2779 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2780 | |binding:vif_type |String |The type of which mechanism is used for the port. | |
| 2781 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2782 | |binding:vnic_type |string |The type of vNIC which this port should be attached to. | |
| 2783 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2784 | |created_at |string |Time at which port has been created. | |
| 2785 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2786 | |data_plane_status |string |Status of the underlying data plane of a port. | |
| 2787 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2788 | |description |string |A human-readable description for the resource. | |
| 2789 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2790 | |device_id |string |The ID of the device that uses this port. | |
| 2791 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2792 | |device_owner |string |The entity type that uses this port. | |
| 2793 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2794 | |dns_assignment |object |Data assigned to a port by the Networking internal DNS | |
| 2795 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2796 | |dns_domain |string |A valid DNS domain. | |
| 2797 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2798 | |dns_name |string |A valid DNS name. | |
| 2799 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2800 | |extra_dhcp_opts |array |A set of zero or more extra DHCP option pairs. | |
| 2801 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2802 | |fixed_ips |array |The IP addresses for the port. | |
| 2803 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2804 | |id |string |The ID of the resource. | |
| 2805 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2806 | |ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)| |
| 2807 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2808 | |mac_address |string |The MAC address of the port. | |
| 2809 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2810 | |name |string |Human-readable name of the resource. | |
| 2811 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2812 | |network_id |string |The ID of the attached network. | |
| 2813 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2814 | |port_security_enabled |boolean |The port security status. | |
| 2815 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2816 | |project_id |string |The ID of the project. | |
| 2817 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2818 | |revision_number |integer |The revision number of the resource. | |
| 2819 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2820 | |qos_policy_id |string |The ID of the QoS policy associated with the port. | |
| 2821 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2822 | |security_groups |array |The IDs of security groups applied to the port. | |
| 2823 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2824 | |status |string |The port status. Values are ACTIVE, DOWN, BUILD and ERROR. | |
| 2825 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2826 | |tenant_id |string |The ID of the project. | |
| 2827 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2828 | |updated_at |string |Time at which port has been updated. | |
| 2829 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2830 | |
| 2831 | Delete Port |
| 2832 | +++++++++++++++ |
| 2833 | |
| 2834 | https://developer.openstack.org/api-ref/network/v2/#delete-port |
| 2835 | |
| 2836 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2837 | |Interface Definition|Description | |
| 2838 | +====================+=======================================================================================================================+ |
| 2839 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id} | |
| 2840 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2841 | |Operation Type |DELETE | |
| 2842 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2843 | |Content-Type |application/json | |
| 2844 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2845 | |
| 2846 | Request Body: |
| 2847 | |
| 2848 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2849 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2850 | +============================+=========+===========+==========================+==============================================================+ |
| 2851 | |port_id |M |1 |String |The ID of the port. | |
| 2852 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2853 | |
| 2854 | Create Security Group |
| 2855 | ++++++++++++++++++++++ |
| 2856 | |
| 2857 | https://developer.openstack.org/api-ref/network/v2/#create-security-group |
| 2858 | |
| 2859 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2860 | |Interface Definition|Description | |
| 2861 | +====================+=======================================================================================================================+ |
| 2862 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups | |
| 2863 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2864 | |Operation Type |POST | |
| 2865 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2866 | |Content-Type |application/json | |
| 2867 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2868 | |
| 2869 | Request Body: |
| 2870 | |
| 2871 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2872 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2873 | +============================+=========+===========+==========================+==============================================================+ |
| 2874 | |security_group |M |1 |object |A security_group object. | |
| 2875 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2876 | |tenant_id |M |1 |string |The ID of the project. | |
| 2877 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2878 | |project_id |M |1 |string |The ID of the project. | |
| 2879 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2880 | |description |O |1 |string |A human-readable description for the resource. | |
| 2881 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2882 | |name |M |1 |string |Human-readable name of the resource. | |
| 2883 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2884 | |
| 2885 | Response: |
| 2886 | |
| 2887 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2888 | |Attribute |Content |Description | |
| 2889 | +=============================+==================+==============================================================================+ |
| 2890 | |security_group |object |A security_group object. | |
| 2891 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2892 | |id |string |The ID of the security group. | |
| 2893 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2894 | |tenant_id |string |The ID of the project. | |
| 2895 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2896 | |project_id |string |The ID of the project. | |
| 2897 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2898 | |created_at |string |Time at which the resource has been created (in UTC ISO8601 format). | |
| 2899 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2900 | |updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). | |
| 2901 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2902 | |revision_number |integer |The revision number of the resource. | |
| 2903 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2904 | |name |string |Human-readable name of the resource. | |
| 2905 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2906 | |description |string |A human-readable description for the resource. | |
| 2907 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2908 | |security_group_rules |array |A list of security_group_rule objects. | |
| 2909 | +-----------------------------+------------------+------------------------------------------------------------------------------+ |
| 2910 | |
| 2911 | Delete security group |
| 2912 | ++++++++++++++++++++++ |
| 2913 | |
| 2914 | https://developer.openstack.org/api-ref/network/v2/#delete-security-group |
| 2915 | |
| 2916 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2917 | |Interface Definition|Description | |
| 2918 | +====================+=======================================================================================================================+ |
| 2919 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id} | |
| 2920 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2921 | |Operation Type |DELETE | |
| 2922 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2923 | |Content-Type |application/json | |
| 2924 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2925 | |
| 2926 | Request Body: |
| 2927 | |
| 2928 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2929 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2930 | +============================+=========+===========+==========================+==============================================================+ |
| 2931 | |security_group_id |M |1 |String |The ID of the security group. | |
| 2932 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 2933 | |
| 2934 | Create Security Group Rule |
| 2935 | ++++++++++++++++++++++++++ |
| 2936 | |
| 2937 | https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule |
| 2938 | |
| 2939 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2940 | |Interface Definition|Description | |
| 2941 | +====================+=======================================================================================================================+ |
| 2942 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules | |
| 2943 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2944 | |Operation Type |POST | |
| 2945 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2946 | |Content-Type |application/json | |
| 2947 | +--------------------+-----------------------------------------------------------------------------------------------------------------------+ |
| 2948 | |
| 2949 | Request Body: |
| 2950 | |
| 2951 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2952 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 2953 | +============================+=========+===========+==========================+================================================================================================+ |
| 2954 | |security_group_rule |M |1 |object |A security_group_rule object. | |
| 2955 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2956 | |remote_group_id |O |1 |string |The remote group UUID to associate with this security group rule. | |
| 2957 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2958 | |direction |M |1 |string |Ingress or egress, which is the direction in which the metering rule is applied. | |
| 2959 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2960 | |protocol |M |1 |string |The IP protocol can be represented by a string, an integer, or null. | |
| 2961 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2962 | |ethertype |O |1 |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. | |
| 2963 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2964 | |port_range_max |O |1 |integer |The maximum port number in the range that is matched by the security group rule. | |
| 2965 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2966 | |security_group_id |M |1 |string |The security group ID to associate with this security group rule. | |
| 2967 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2968 | |port_range_min |O |1 |integer |The minimum port number in the range that is matched by the security group rule. | |
| 2969 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2970 | |remote_ip_prefix |M |1 |string |The remote IP prefix to associate with this metering rule packet. | |
| 2971 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2972 | |description |O |1 |string |A human-readable description for the resource. Default is an empty string. | |
| 2973 | +----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+ |
| 2974 | |
| 2975 | Response: |
| 2976 | |
| 2977 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2978 | |Attribute |Content |Description | |
| 2979 | +=============================+==================+=================================================================================================+ |
| 2980 | |security_group_rule |object |A security_group_rule object. | |
| 2981 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2982 | |remote_group_id |string |The remote group UUID to associate with this security group rule. | |
| 2983 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2984 | |direction |string |Ingress or egress, which is the direction in which the metering rule is applied. | |
| 2985 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2986 | |protocol |string |The IP protocol can be represented by a string, an integer, or null. | |
| 2987 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2988 | |ethertype |string |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. | |
| 2989 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2990 | |port_range_max |integer |The maximum port number in the range that is matched by the security group rule. | |
| 2991 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2992 | |security_group_id |string |The security group ID to associate with this security group rule. | |
| 2993 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2994 | |tenant_id |string |The ID of the project. | |
| 2995 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2996 | |project_id |string |The ID of the project. | |
| 2997 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 2998 | |port_range_min |integer |The minimum port number in the range that is matched by the security group rule. | |
| 2999 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 3000 | |remote_ip_prefix |string |The remote IP prefix to associate with this metering rule packet. | |
| 3001 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 3002 | |revision_number |integer |The revision number of the resource. | |
| 3003 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 3004 | |id |string |The ID of the security group rule. | |
| 3005 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 3006 | |description |string |A human-readable description for the resource. | |
| 3007 | +-----------------------------+------------------+-------------------------------------------------------------------------------------------------+ |
| 3008 | |
| 3009 | Delete security group |
| 3010 | ++++++++++++++++++++++ |
| 3011 | |
| 3012 | https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule |
| 3013 | |
| 3014 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------+ |
| 3015 | |Interface Definition|Description | |
| 3016 | +====================+=================================================================================================================================+ |
| 3017 | |URI |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id} | |
| 3018 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------+ |
| 3019 | |Operation Type |DELETE | |
| 3020 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------+ |
| 3021 | |Content-Type |application/json | |
| 3022 | +--------------------+---------------------------------------------------------------------------------------------------------------------------------+ |
| 3023 | |
| 3024 | Request Body: |
| 3025 | |
| 3026 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 3027 | |Attribute |Qualifier|Cardinality|Content |Description | |
| 3028 | +============================+=========+===========+==========================+==============================================================+ |
| 3029 | |security_group_rule_id |M |1 |String |The ID of the security group rule. | |
| 3030 | +----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+ |
| 3031 | |
| 3032 | Policy API |
| 3033 | ---------- |
| 3034 | |
| 3035 | Create a dictionary item |
| 3036 | ++++++++++++++++++++++++ |
| 3037 | |
| 3038 | +--------------------+--------------------------+ |
| 3039 | |Interface Definition|Description | |
| 3040 | +====================+==========================+ |
| 3041 | |URI |/createDictionaryItem | |
| 3042 | +--------------------+--------------------------+ |
| 3043 | |Operation Type |PUT | |
| 3044 | +--------------------+--------------------------+ |
| 3045 | |
| 3046 | Request Parameters: |
| 3047 | |
| 3048 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3049 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3050 | +===================+=========+===========+=======+=============================================================+ |
| 3051 | |dictionory |M |1 |String | | |
| 3052 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3053 | |dictionaryJson |M |1 |String | | |
| 3054 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3055 | |dictionaryType |M |1 |String | | |
| 3056 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3057 | |requestId |M |1 |String | | |
| 3058 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3059 | |
| 3060 | Request Headers: |
| 3061 | |
| 3062 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3063 | |Header Name |Qualifier|Description | |
| 3064 | +===================+=========+=========================================================================================+ |
| 3065 | |ClientAuth |Y |encoded client authentication details | |
| 3066 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3067 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3068 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3069 | |Environment |Y |execution environments | |
| 3070 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3071 | |Authorization |Y |Base64 encoded username:password | |
| 3072 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3073 | |
| 3074 | HTTP Response Code: |
| 3075 | |
| 3076 | +------------------+---------------------+ |
| 3077 | |HTTP CODE |Description | |
| 3078 | +==================+=====================+ |
| 3079 | |200 |successful | |
| 3080 | +------------------+---------------------+ |
| 3081 | |400 |Invalid Request | |
| 3082 | +------------------+---------------------+ |
| 3083 | |401 |Unauthorized | |
| 3084 | +------------------+---------------------+ |
| 3085 | |500 |Error | |
| 3086 | +------------------+---------------------+ |
| 3087 | |
| 3088 | Create Policy |
| 3089 | +++++++++++++ |
| 3090 | |
| 3091 | +--------------------+--------------------------+ |
| 3092 | |Interface Definition|Description | |
| 3093 | +====================+==========================+ |
| 3094 | |URI |/createPolicy | |
| 3095 | +--------------------+--------------------------+ |
| 3096 | |Operation Type |PUT | |
| 3097 | +--------------------+--------------------------+ |
| 3098 | |
| 3099 | Request Parameters: |
| 3100 | |
| 3101 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3102 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3103 | +===================+=========+===========+=======+=============================================================+ |
| 3104 | |attributes |M |1 |Object |set of attributes in key value pair | |
| 3105 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3106 | |configBody |M |1 |String | | |
| 3107 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3108 | |configBodyType |M |1 |String | | |
| 3109 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3110 | |configName |M |1 |String | | |
| 3111 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3112 | |ecompName |M |1 |String | | |
| 3113 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3114 | |policyClass |M |1 |String | | |
| 3115 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3116 | |policyConfigType |M |1 |String | | |
| 3117 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3118 | |policyDescription |M |1 |String | | |
| 3119 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3120 | |policyName |M |1 |String | | |
| 3121 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3122 | |requestID |M |1 |String |request ID | |
| 3123 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3124 | |
| 3125 | Request Headers: |
| 3126 | |
| 3127 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3128 | |Header Name |Qualifier|Description | |
| 3129 | +===================+=========+=========================================================================================+ |
| 3130 | |ClientAuth |Y |encoded client authentication details | |
| 3131 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3132 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3133 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3134 | |Environment |Y |execution environments | |
| 3135 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3136 | |Authorization |Y |Base64 encoded username:password | |
| 3137 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3138 | |
| 3139 | HTTP Response Code: |
| 3140 | |
| 3141 | +------------------+---------------------+ |
| 3142 | |HTTP CODE |Description | |
| 3143 | +==================+=====================+ |
| 3144 | |200 |successful | |
| 3145 | +------------------+---------------------+ |
| 3146 | |400 |Invalid Request | |
| 3147 | +------------------+---------------------+ |
| 3148 | |401 |Unauthorized | |
| 3149 | +------------------+---------------------+ |
| 3150 | |500 |Error | |
| 3151 | +------------------+---------------------+ |
| 3152 | |
| 3153 | Delete Policy |
| 3154 | +++++++++++++ |
| 3155 | |
| 3156 | +--------------------+--------------------------+ |
| 3157 | |Interface Definition|Description | |
| 3158 | +====================+==========================+ |
| 3159 | |URI |/deletePolicy | |
| 3160 | +--------------------+--------------------------+ |
| 3161 | |Operation Type |DELETE | |
| 3162 | +--------------------+--------------------------+ |
| 3163 | |
| 3164 | Request Parameters: |
| 3165 | |
| 3166 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3167 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3168 | +===================+=========+===========+=======+=============================================================+ |
| 3169 | |deleteCondition |M |1 |String | | |
| 3170 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3171 | |pdpGroup |M |1 |String | | |
| 3172 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3173 | |policyComponent |M |1 |String | | |
| 3174 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3175 | |policyName |M |1 |String | | |
| 3176 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3177 | |policyType |M |1 |String | | |
| 3178 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3179 | |requestID |M |1 |String |request ID | |
| 3180 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3181 | |
| 3182 | Request Headers: |
| 3183 | |
| 3184 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3185 | |Header Name |Qualifier|Description | |
| 3186 | +===================+=========+=========================================================================================+ |
| 3187 | |ClientAuth |Y |encoded client authentication details | |
| 3188 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3189 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3190 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3191 | |Environment |Y |execution environments | |
| 3192 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3193 | |Authorization |Y |Base64 encoded username:password | |
| 3194 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3195 | |
| 3196 | HTTP Response Code: |
| 3197 | |
| 3198 | +------------------+---------------------+ |
| 3199 | |HTTP CODE |Description | |
| 3200 | +==================+=====================+ |
| 3201 | |200 |successful | |
| 3202 | +------------------+---------------------+ |
| 3203 | |400 |Invalid Request | |
| 3204 | +------------------+---------------------+ |
| 3205 | |401 |Unauthorized | |
| 3206 | +------------------+---------------------+ |
| 3207 | |500 |Error | |
| 3208 | +------------------+---------------------+ |
| 3209 | |
| 3210 | Get Configuration |
| 3211 | +++++++++++++++++ |
| 3212 | |
| 3213 | +--------------------+--------------------------+ |
| 3214 | |Interface Definition|Description | |
| 3215 | +====================+==========================+ |
| 3216 | |URI |/getConfig | |
| 3217 | +--------------------+--------------------------+ |
| 3218 | |Operation Type |POST | |
| 3219 | +--------------------+--------------------------+ |
| 3220 | |
| 3221 | Request Parameters: |
| 3222 | |
| 3223 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3224 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3225 | +===================+=========+===========+=======+=============================================================+ |
| 3226 | |configAttributes |M |1 |String | | |
| 3227 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3228 | |configName |M |1 |String | | |
| 3229 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3230 | |ecompName |M |1 |String | | |
| 3231 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3232 | |policyName |M |1 |String | | |
| 3233 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3234 | |unique |M |1 |Boolean| | |
| 3235 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3236 | |requestID |M |1 |String |request ID | |
| 3237 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3238 | |
| 3239 | Request Headers: |
| 3240 | |
| 3241 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3242 | |Header Name |Qualifier|Description | |
| 3243 | +===================+=========+=========================================================================================+ |
| 3244 | |ClientAuth |Y |encoded client authentication details | |
| 3245 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3246 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3247 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3248 | |Environment |Y |execution environments | |
| 3249 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3250 | |Authorization |Y |Base64 encoded username:password | |
| 3251 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3252 | |
| 3253 | HTTP Response Code: |
| 3254 | |
| 3255 | +------------------+---------------------+ |
| 3256 | |HTTP CODE |Description | |
| 3257 | +==================+=====================+ |
| 3258 | |200 |successful | |
| 3259 | +------------------+---------------------+ |
| 3260 | |400 |Invalid Request | |
| 3261 | +------------------+---------------------+ |
| 3262 | |401 |Unauthorized | |
| 3263 | +------------------+---------------------+ |
| 3264 | |500 |Error | |
| 3265 | +------------------+---------------------+ |
| 3266 | |
| 3267 | Get Decision |
| 3268 | ++++++++++++ |
| 3269 | |
| 3270 | +--------------------+--------------------------+ |
| 3271 | |Interface Definition|Description | |
| 3272 | +====================+==========================+ |
| 3273 | |URI |/getDecision | |
| 3274 | +--------------------+--------------------------+ |
| 3275 | |Operation Type |POST | |
| 3276 | +--------------------+--------------------------+ |
| 3277 | |
| 3278 | Request Parameters: |
| 3279 | |
| 3280 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3281 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3282 | +===================+=========+===========+=======+=============================================================+ |
| 3283 | |decisionAttributes |M |1 |Object | | |
| 3284 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3285 | |ecompComponentName |M |1 |String | | |
| 3286 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3287 | |requestID |M |1 |String |request ID | |
| 3288 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3289 | |
| 3290 | Request Headers: |
| 3291 | |
| 3292 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3293 | |Header Name |Qualifier|Description | |
| 3294 | +===================+=========+=========================================================================================+ |
| 3295 | |ClientAuth |Y |encoded client authentication details | |
| 3296 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3297 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3298 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3299 | |Environment |Y |execution environments | |
| 3300 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3301 | |Authorization |Y |Base64 encoded username:password | |
| 3302 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3303 | |
| 3304 | HTTP Response Code: |
| 3305 | |
| 3306 | +------------------+---------------------+ |
| 3307 | |HTTP CODE |Description | |
| 3308 | +==================+=====================+ |
| 3309 | |200 |successful | |
| 3310 | +------------------+---------------------+ |
| 3311 | |400 |Invalid Request | |
| 3312 | +------------------+---------------------+ |
| 3313 | |401 |Unauthorized | |
| 3314 | +------------------+---------------------+ |
| 3315 | |500 |Error | |
| 3316 | +------------------+---------------------+ |
| 3317 | |
| 3318 | Response Parameters: |
| 3319 | |
| 3320 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3321 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3322 | +===================+=========+===========+=======+=============================================================+ |
| 3323 | |decision |N |1 |String | | |
| 3324 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3325 | |details |N |1 |String | | |
| 3326 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3327 | |
| 3328 | Get Dictionary Items |
| 3329 | ++++++++++++++++++++ |
| 3330 | |
| 3331 | +--------------------+--------------------------+ |
| 3332 | |Interface Definition|Description | |
| 3333 | +====================+==========================+ |
| 3334 | |URI |/getDictionaryItems | |
| 3335 | +--------------------+--------------------------+ |
| 3336 | |Operation Type |POST | |
| 3337 | +--------------------+--------------------------+ |
| 3338 | |
| 3339 | Request Parameters: |
| 3340 | |
| 3341 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3342 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3343 | +===================+=========+===========+=======+=============================================================+ |
| 3344 | |dictionary |N |1 |String | | |
| 3345 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3346 | |dictionaryJson |N |1 |String | | |
| 3347 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3348 | |dictionaryType |N |1 |String | | |
| 3349 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3350 | |requestID |M |1 |String |request ID | |
| 3351 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3352 | |
| 3353 | Request Headers: |
| 3354 | |
| 3355 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3356 | |Header Name |Qualifier|Description | |
| 3357 | +===================+=========+=========================================================================================+ |
| 3358 | |ClientAuth |Y |encoded client authentication details | |
| 3359 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3360 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3361 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3362 | |Environment |Y |execution environments | |
| 3363 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3364 | |Authorization |Y |Base64 encoded username:password | |
| 3365 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3366 | |
| 3367 | HTTP Response Code: |
| 3368 | |
| 3369 | +------------------+---------------------+ |
| 3370 | |HTTP CODE |Description | |
| 3371 | +==================+=====================+ |
| 3372 | |200 |successful | |
| 3373 | +------------------+---------------------+ |
| 3374 | |400 |Invalid Request | |
| 3375 | +------------------+---------------------+ |
| 3376 | |401 |Unauthorized | |
| 3377 | +------------------+---------------------+ |
| 3378 | |500 |Error | |
| 3379 | +------------------+---------------------+ |
| 3380 | |
| 3381 | Response Parameters: |
| 3382 | |
| 3383 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3384 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3385 | +===================+=========+===========+=======+=============================================================+ |
| 3386 | |dictionaryData |N |1 |Object | | |
| 3387 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3388 | |dictionaryJson |N |1 |Object | | |
| 3389 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3390 | |responseCode |N |1 |Integer| | |
| 3391 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3392 | |responseMessage |N |1 |Object | | |
| 3393 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3394 | |
| 3395 | Get Metrics |
| 3396 | +++++++++++ |
| 3397 | |
| 3398 | +--------------------+--------------------------+ |
| 3399 | |Interface Definition|Description | |
| 3400 | +====================+==========================+ |
| 3401 | |URI |/getMetrics | |
| 3402 | +--------------------+--------------------------+ |
| 3403 | |Operation Type |GET | |
| 3404 | +--------------------+--------------------------+ |
| 3405 | |
| 3406 | Request Headers: |
| 3407 | |
| 3408 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3409 | |Header Name |Qualifier|Description | |
| 3410 | +===================+=========+=========================================================================================+ |
| 3411 | |ClientAuth |Y |encoded client authentication details | |
| 3412 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3413 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3414 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3415 | |Environment |Y |execution environments | |
| 3416 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3417 | |Authorization |Y |Base64 encoded username:password | |
| 3418 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3419 | |
| 3420 | HTTP Response Code: |
| 3421 | |
| 3422 | +------------------+---------------------+ |
| 3423 | |HTTP CODE |Description | |
| 3424 | +==================+=====================+ |
| 3425 | |200 |successful | |
| 3426 | +------------------+---------------------+ |
| 3427 | |400 |Invalid Request | |
| 3428 | +------------------+---------------------+ |
| 3429 | |401 |Unauthorized | |
| 3430 | +------------------+---------------------+ |
| 3431 | |500 |Error | |
| 3432 | +------------------+---------------------+ |
| 3433 | |
| 3434 | Response Parameters: |
| 3435 | |
| 3436 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3437 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3438 | +===================+=========+===========+=======+=============================================================+ |
| 3439 | |metricsTotal |N |1 |Integer| | |
| 3440 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3441 | |papMetrics |N |1 |Integer| | |
| 3442 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3443 | |pdpMetrics |N |1 |Integer| | |
| 3444 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3445 | |responseCode |N |1 |Object | | |
| 3446 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3447 | |responseMessage |N |1 |String | | |
| 3448 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3449 | |
| 3450 | Get Notification |
| 3451 | ++++++++++++++++ |
| 3452 | |
| 3453 | +--------------------+--------------------------+ |
| 3454 | |Interface Definition|Description | |
| 3455 | +====================+==========================+ |
| 3456 | |URI |/getNotification | |
| 3457 | +--------------------+--------------------------+ |
| 3458 | |Operation Type |POST | |
| 3459 | +--------------------+--------------------------+ |
| 3460 | |
| 3461 | Request Headers: |
| 3462 | |
| 3463 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3464 | |Header Name |Qualifier|Description | |
| 3465 | +===================+=========+=========================================================================================+ |
| 3466 | |ClientAuth |Y |encoded client authentication details | |
| 3467 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3468 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3469 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3470 | |Environment |Y |execution environments | |
| 3471 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3472 | |Authorization |Y |Base64 encoded username:password | |
| 3473 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3474 | |
| 3475 | HTTP Response Code: |
| 3476 | |
| 3477 | +------------------+---------------------+ |
| 3478 | |HTTP CODE |Description | |
| 3479 | +==================+=====================+ |
| 3480 | |200 |successful | |
| 3481 | +------------------+---------------------+ |
| 3482 | |400 |Invalid Request | |
| 3483 | +------------------+---------------------+ |
| 3484 | |401 |Unauthorized | |
| 3485 | +------------------+---------------------+ |
| 3486 | |500 |Error | |
| 3487 | +------------------+---------------------+ |
| 3488 | |
| 3489 | Response Parameters: |
| 3490 | |
| 3491 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3492 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3493 | +===================+=========+===========+=======+=============================================================+ |
| 3494 | |metricsTotal |N |1 |Integer| | |
| 3495 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3496 | |papMetrics |N |1 |Integer| | |
| 3497 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3498 | |pdpMetrics |N |1 |Integer| | |
| 3499 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3500 | |responseCode |N |1 |Object | | |
| 3501 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3502 | |responseMessage |N |1 |String | | |
| 3503 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3504 | |
| 3505 | List Configuration |
| 3506 | ++++++++++++++++++ |
| 3507 | |
| 3508 | +--------------------+--------------------------+ |
| 3509 | |Interface Definition|Description | |
| 3510 | +====================+==========================+ |
| 3511 | |URI |/listConfiguration | |
| 3512 | +--------------------+--------------------------+ |
| 3513 | |Operation Type |POST | |
| 3514 | +--------------------+--------------------------+ |
| 3515 | |
| 3516 | Request Headers: |
| 3517 | |
| 3518 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3519 | |Header Name |Qualifier|Description | |
| 3520 | +===================+=========+=========================================================================================+ |
| 3521 | |ClientAuth |Y |encoded client authentication details | |
| 3522 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3523 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3524 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3525 | |Environment |Y |execution environments | |
| 3526 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3527 | |Authorization |Y |Base64 encoded username:password | |
| 3528 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3529 | |
| 3530 | Request Parameters: |
| 3531 | |
| 3532 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3533 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3534 | +===================+=========+===========+=======+=============================================================+ |
| 3535 | |configAttributes |N |1 |Object | | |
| 3536 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3537 | |configName |N |1 |String | | |
| 3538 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3539 | |ecompName |N |1 |String | | |
| 3540 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3541 | |policyName |N |1 |String | | |
| 3542 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3543 | |requestID |N |1 |String | | |
| 3544 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3545 | |unique |N |1 |Boolean| | |
| 3546 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3547 | |
| 3548 | HTTP Response Code: |
| 3549 | |
| 3550 | +------------------+---------------------+ |
| 3551 | |HTTP CODE |Description | |
| 3552 | +==================+=====================+ |
| 3553 | |200 |successful | |
| 3554 | +------------------+---------------------+ |
| 3555 | |400 |Invalid Request | |
| 3556 | +------------------+---------------------+ |
| 3557 | |401 |Unauthorized | |
| 3558 | +------------------+---------------------+ |
| 3559 | |500 |Error | |
| 3560 | +------------------+---------------------+ |
| 3561 | |
| 3562 | Import policy |
| 3563 | +++++++++++++ |
| 3564 | |
| 3565 | +--------------------+--------------------------+ |
| 3566 | |Interface Definition|Description | |
| 3567 | +====================+==========================+ |
| 3568 | |URI |/policyEngineImport | |
| 3569 | +--------------------+--------------------------+ |
| 3570 | |Operation Type |POST | |
| 3571 | +--------------------+--------------------------+ |
| 3572 | |
| 3573 | Request Headers: |
| 3574 | |
| 3575 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3576 | |Header Name |Qualifier|Description | |
| 3577 | +===================+=========+=========================================================================================+ |
| 3578 | |ClientAuth |Y |encoded client authentication details | |
| 3579 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3580 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3581 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3582 | |Environment |Y |execution environments | |
| 3583 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3584 | |Authorization |Y |Base64 encoded username:password | |
| 3585 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3586 | |
| 3587 | Request Parameters: |
| 3588 | |
| 3589 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3590 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3591 | +===================+=========+===========+=======+=============================================================+ |
| 3592 | |importParameterJson|Y |1 |String | | |
| 3593 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3594 | |file |Y |1 |File | | |
| 3595 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3596 | |
| 3597 | HTTP Response Code: |
| 3598 | |
| 3599 | +------------------+---------------------+ |
| 3600 | |HTTP CODE |Description | |
| 3601 | +==================+=====================+ |
| 3602 | |200 |successful | |
| 3603 | +------------------+---------------------+ |
| 3604 | |400 |Invalid Request | |
| 3605 | +------------------+---------------------+ |
| 3606 | |401 |Unauthorized | |
| 3607 | +------------------+---------------------+ |
| 3608 | |500 |Error | |
| 3609 | +------------------+---------------------+ |
| 3610 | |
| 3611 | Push Policy |
| 3612 | +++++++++++ |
| 3613 | |
| 3614 | +--------------------+--------------------------+ |
| 3615 | |Interface Definition|Description | |
| 3616 | +====================+==========================+ |
| 3617 | |URI |/pushPolicy | |
| 3618 | +--------------------+--------------------------+ |
| 3619 | |Operation Type |PUT | |
| 3620 | +--------------------+--------------------------+ |
| 3621 | |
| 3622 | Request Headers: |
| 3623 | |
| 3624 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3625 | |Header Name |Qualifier|Description | |
| 3626 | +===================+=========+=========================================================================================+ |
| 3627 | |ClientAuth |Y |encoded client authentication details | |
| 3628 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3629 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3630 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3631 | |Environment |Y |execution environments | |
| 3632 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3633 | |Authorization |Y |Base64 encoded username:password | |
| 3634 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3635 | |
| 3636 | Request Parameters: |
| 3637 | |
| 3638 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3639 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3640 | +===================+=========+===========+=======+=============================================================+ |
| 3641 | |pdpGroup |N |1 |String | | |
| 3642 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3643 | |policyName |N |1 |String | | |
| 3644 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3645 | |policyType |N |1 |String | | |
| 3646 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3647 | |
| 3648 | HTTP Response Code: |
| 3649 | |
| 3650 | +------------------+---------------------+ |
| 3651 | |HTTP CODE |Description | |
| 3652 | +==================+=====================+ |
| 3653 | |200 |successful | |
| 3654 | +------------------+---------------------+ |
| 3655 | |400 |Invalid Request | |
| 3656 | +------------------+---------------------+ |
| 3657 | |401 |Unauthorized | |
| 3658 | +------------------+---------------------+ |
| 3659 | |500 |Error | |
| 3660 | +------------------+---------------------+ |
| 3661 | |
| 3662 | Send Event |
| 3663 | ++++++++++ |
| 3664 | |
| 3665 | +--------------------+--------------------------+ |
| 3666 | |Interface Definition|Description | |
| 3667 | +====================+==========================+ |
| 3668 | |URI |/sendEvent | |
| 3669 | +--------------------+--------------------------+ |
| 3670 | |Operation Type |POST | |
| 3671 | +--------------------+--------------------------+ |
| 3672 | |
| 3673 | Request Headers: |
| 3674 | |
| 3675 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3676 | |Header Name |Qualifier|Description | |
| 3677 | +===================+=========+=========================================================================================+ |
| 3678 | |ClientAuth |Y |encoded client authentication details | |
| 3679 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3680 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3681 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3682 | |Environment |Y |execution environments | |
| 3683 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3684 | |Authorization |Y |Base64 encoded username:password | |
| 3685 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3686 | |
| 3687 | Request Parameters: |
| 3688 | |
| 3689 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3690 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3691 | +===================+=========+===========+=======+=============================================================+ |
| 3692 | |eventAttributes |N |1 |Object | | |
| 3693 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3694 | |requestID |N |1 |String | | |
| 3695 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3696 | |
| 3697 | HTTP Response Code: |
| 3698 | |
| 3699 | +------------------+---------------------+ |
| 3700 | |HTTP CODE |Description | |
| 3701 | +==================+=====================+ |
| 3702 | |200 |successful | |
| 3703 | +------------------+---------------------+ |
| 3704 | |400 |Invalid Request | |
| 3705 | +------------------+---------------------+ |
| 3706 | |401 |Unauthorized | |
| 3707 | +------------------+---------------------+ |
| 3708 | |500 |Error | |
| 3709 | +------------------+---------------------+ |
| 3710 | |
| 3711 | Send Heartbeat |
| 3712 | ++++++++++++++ |
| 3713 | |
| 3714 | +--------------------+--------------------------+ |
| 3715 | |Interface Definition|Description | |
| 3716 | +====================+==========================+ |
| 3717 | |URI |/sendEvent | |
| 3718 | +--------------------+--------------------------+ |
| 3719 | |Operation Type |POST | |
| 3720 | +--------------------+--------------------------+ |
| 3721 | |
| 3722 | Request Headers: |
| 3723 | |
| 3724 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3725 | |Header Name |Qualifier|Description | |
| 3726 | +===================+=========+=========================================================================================+ |
| 3727 | |ClientAuth |Y |encoded client authentication details | |
| 3728 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3729 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3730 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3731 | |Environment |Y |execution environments | |
| 3732 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3733 | |Authorization |Y |Base64 encoded username:password | |
| 3734 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3735 | |
| 3736 | Request Parameters: |
| 3737 | |
| 3738 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3739 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3740 | +===================+=========+===========+=======+=============================================================+ |
| 3741 | |notificationTopic |Y |1 |String | | |
| 3742 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3743 | |
| 3744 | HTTP Response Code: |
| 3745 | |
| 3746 | +------------------+---------------------+ |
| 3747 | |HTTP CODE |Description | |
| 3748 | +==================+=====================+ |
| 3749 | |200 |successful | |
| 3750 | +------------------+---------------------+ |
| 3751 | |400 |Invalid Request | |
| 3752 | +------------------+---------------------+ |
| 3753 | |401 |Unauthorized | |
| 3754 | +------------------+---------------------+ |
| 3755 | |500 |Error | |
| 3756 | +------------------+---------------------+ |
| 3757 | |
| 3758 | Stop Notification |
| 3759 | +++++++++++++++++ |
| 3760 | |
| 3761 | +--------------------+--------------------------+ |
| 3762 | |Interface Definition|Description | |
| 3763 | +====================+==========================+ |
| 3764 | |URI |/stopNotification | |
| 3765 | +--------------------+--------------------------+ |
| 3766 | |Operation Type |POST | |
| 3767 | +--------------------+--------------------------+ |
| 3768 | |
| 3769 | Request Headers: |
| 3770 | |
| 3771 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3772 | |Header Name |Qualifier|Description | |
| 3773 | +===================+=========+=========================================================================================+ |
| 3774 | |ClientAuth |Y |encoded client authentication details | |
| 3775 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3776 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3777 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3778 | |Environment |Y |execution environments | |
| 3779 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3780 | |Authorization |Y |Base64 encoded username:password | |
| 3781 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3782 | |
| 3783 | Request Parameters: |
| 3784 | |
| 3785 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3786 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3787 | +===================+=========+===========+=======+=============================================================+ |
| 3788 | |notificationTopic |Y |1 |String | | |
| 3789 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3790 | |
| 3791 | HTTP Response Code: |
| 3792 | |
| 3793 | +------------------+---------------------+ |
| 3794 | |HTTP CODE |Description | |
| 3795 | +==================+=====================+ |
| 3796 | |200 |successful | |
| 3797 | +------------------+---------------------+ |
| 3798 | |400 |Invalid Request | |
| 3799 | +------------------+---------------------+ |
| 3800 | |401 |Unauthorized | |
| 3801 | +------------------+---------------------+ |
| 3802 | |500 |Error | |
| 3803 | +------------------+---------------------+ |
| 3804 | |
| 3805 | Update Dictionary |
| 3806 | +++++++++++++++++ |
| 3807 | |
| 3808 | +--------------------+--------------------------+ |
| 3809 | |Interface Definition|Description | |
| 3810 | +====================+==========================+ |
| 3811 | |URI |/updateDictionaryItem | |
| 3812 | +--------------------+--------------------------+ |
| 3813 | |Operation Type |PUT | |
| 3814 | +--------------------+--------------------------+ |
| 3815 | |
| 3816 | Request Headers: |
| 3817 | |
| 3818 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3819 | |Header Name |Qualifier|Description | |
| 3820 | +===================+=========+=========================================================================================+ |
| 3821 | |ClientAuth |Y |encoded client authentication details | |
| 3822 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3823 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3824 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3825 | |Environment |Y |execution environments | |
| 3826 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3827 | |Authorization |Y |Base64 encoded username:password | |
| 3828 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3829 | |
| 3830 | Request Parameters: |
| 3831 | |
| 3832 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3833 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3834 | +===================+=========+===========+=======+=============================================================+ |
| 3835 | |dictionary |N |1 |String | | |
| 3836 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3837 | |dictionaryJson |N |1 |String | | |
| 3838 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3839 | |dictionaryType |N |1 |String | | |
| 3840 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3841 | |requestID |N |1 |String | | |
| 3842 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3843 | |
| 3844 | HTTP Response Code: |
| 3845 | |
| 3846 | +------------------+---------------------+ |
| 3847 | |HTTP CODE |Description | |
| 3848 | +==================+=====================+ |
| 3849 | |200 |successful | |
| 3850 | +------------------+---------------------+ |
| 3851 | |400 |Invalid Request | |
| 3852 | +------------------+---------------------+ |
| 3853 | |401 |Unauthorized | |
| 3854 | +------------------+---------------------+ |
| 3855 | |500 |Error | |
| 3856 | +------------------+---------------------+ |
| 3857 | |
| 3858 | Update Policy |
| 3859 | +++++++++++++ |
| 3860 | |
| 3861 | +--------------------+--------------------------+ |
| 3862 | |Interface Definition|Description | |
| 3863 | +====================+==========================+ |
| 3864 | |URI |/updatePolicy | |
| 3865 | +--------------------+--------------------------+ |
| 3866 | |Operation Type |PUT | |
| 3867 | +--------------------+--------------------------+ |
| 3868 | |
| 3869 | Request Headers: |
| 3870 | |
| 3871 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3872 | |Header Name |Qualifier|Description | |
| 3873 | +===================+=========+=========================================================================================+ |
| 3874 | |ClientAuth |Y |encoded client authentication details | |
| 3875 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3876 | |X-ECOMP-RequestID |N |Request ID to track the requests | |
| 3877 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3878 | |Environment |Y |execution environments | |
| 3879 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3880 | |Authorization |Y |Base64 encoded username:password | |
| 3881 | +-------------------+---------+-----------------------------------------------------------------------------------------+ |
| 3882 | |
| 3883 | Request Parameters: |
| 3884 | |
| 3885 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3886 | |Attribute |Qualifier|Cardinality|Content|Description | |
| 3887 | +===================+=========+===========+=======+=============================================================+ |
| 3888 | |attributes |N |1 |Object | | |
| 3889 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3890 | |configBody |N |1 |String | | |
| 3891 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3892 | |configBodyType |N |1 |String | | |
| 3893 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3894 | |configName |N |1 |String | | |
| 3895 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3896 | |ecompName |N |1 |String | | |
| 3897 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3898 | |policyClass |N |1 |String | | |
| 3899 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3900 | |policyConfigType |N |1 |String | | |
| 3901 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3902 | |policyDescription |N |1 |String | | |
| 3903 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3904 | |policyName |N |1 |String | | |
| 3905 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3906 | |requestID |N |1 |String | | |
| 3907 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3908 | |
| 3909 | HTTP Response Code: |
| 3910 | |
| 3911 | +------------------+---------------------+ |
| 3912 | |HTTP CODE |Description | |
| 3913 | +==================+=====================+ |
| 3914 | |200 |successful | |
| 3915 | +------------------+---------------------+ |
| 3916 | |400 |Invalid Request | |
| 3917 | +------------------+---------------------+ |
| 3918 | |401 |Unauthorized | |
| 3919 | +------------------+---------------------+ |
| 3920 | |500 |Error | |
| 3921 | +------------------+---------------------+ |
| 3922 | |
| 3923 | |
| 3924 | OOF/HAS create update API |
| 3925 | +++++++++++++++++++++++++ |
| 3926 | |
| 3927 | +--------------------+--------------------------+ |
| 3928 | |Interface Definition|Description | |
| 3929 | +====================+==========================+ |
| 3930 | |URI |/api/oof/v1/placement | |
| 3931 | +--------------------+--------------------------+ |
| 3932 | |Operation Type |POST | |
| 3933 | +--------------------+--------------------------+ |
| 3934 | |
| 3935 | |
| 3936 | Request Parameters: |
| 3937 | |
| 3938 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3939 | |Attribute |Required |Cardinality|Content|Description | |
| 3940 | +===================+=========+===========+=======+=============================================================+ |
| 3941 | |requestInfo |Y |1 |Object |The content of the RequestInfo object. | |
| 3942 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3943 | |placementInfo |Y |1 |Object |The Content of the PlacementInfo object. | |
| 3944 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3945 | |licenseInfo |N |1 |Object |The Content of the LicenseInfo object. | |
| 3946 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3947 | |serviceInfo |Y |1 |Object |The Content of the ServiceInfo object. | |
| 3948 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3949 | |
| 3950 | |
| 3951 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3952 | |Attribute |Required |Cardinality|Content|Description | |
| 3953 | +===================+=========+===========+=======+=======================================================================+ |
| 3954 | |transactionId |Y |1 |String |A unique ID to track an ONAP transaction. | |
| 3955 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3956 | |requestId |Y |1 |String |A unique ID to track multiple requests. | |
| 3957 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3958 | |callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. | |
| 3959 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3960 | |callbackHeader |N |1 |String |The header information a client expecting in a async callback. | |
| 3961 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3962 | |sourceId |Y |1 |String |The unique ID of a client making an optimization call. | |
| 3963 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3964 | |requestType |Y |1 |String |The type of a request | |
| 3965 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3966 | |numSolutions |N |1 |Integer|Expected number of solutions. | |
| 3967 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3968 | |optimizers |Y |1..N |List of Strings|A list of optimization services. | |
| 3969 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3970 | |timeout |N |1 |Integer|A tolerance window (in secs) for expecting solutions. Default is 600 secs.| |
| 3971 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3972 | |
| 3973 | |
| 3974 | PlacementInfo Object |
| 3975 | |
| 3976 | +-------------------+---------+-----------+-------+-------------------------------------------------------------+ |
| 3977 | |Attribute |Required |Cardinality|Content|Description | |
| 3978 | +===================+=========+===========+=======+=============================================================+ |
| 3979 | |requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.| |
| 3980 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3981 | |placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service.| |
| 3982 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3983 | |subscriberInfo |N |1 |Object |The information of a service subscriber. | |
| 3984 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3985 | |
| 3986 | PlacementDemand Object |
| 3987 | |
| 3988 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3989 | |Attribute |Required |Cardinality|Content|Description | |
| 3990 | +===================+=========+===========+=======+=======================================================================+ |
| 3991 | |resourceModuleName |Y |1 |String |A resource name as defined in a service model. | |
| 3992 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3993 | |serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | |
| 3994 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3995 | |tenantId |N |1 |String |A tenant Id as defined in the ordering system. | |
| 3996 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3997 | |resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. | |
| 3998 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 3999 | |existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. | |
| 4000 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4001 | |excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions.| |
| 4002 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4003 | |requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. | |
| 4004 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4005 | |
| 4006 | |
| 4007 | SubscriberInfo Object |
| 4008 | |
| 4009 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4010 | |Attribute |Required |Cardinality|Content|Description | |
| 4011 | +===================+=========+===========+=======+=======================================================================+ |
| 4012 | |globalSubscriberId |Y |1 |String |An ID of a subscriber. | |
| 4013 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4014 | |subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'.| |
| 4015 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4016 | |subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. | |
| 4017 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4018 | |
| 4019 | ModelMetaData Object |
| 4020 | |
| 4021 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4022 | |Attribute |Required |Cardinality|Content|Description | |
| 4023 | +===================+=========+===========+=======+=======================================================================+ |
| 4024 | |modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. | |
| 4025 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4026 | |modelVersionId |Y |1 |String |A unique model Id as defined in a service model. | |
| 4027 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4028 | |modelName |N |1 |String |A model name as defined in a service model. | |
| 4029 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4030 | |modelType |N |1 |String |A model type as defined in a service model. | |
| 4031 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4032 | |modelVersion |N |1 |String |A model version as defined in a service model. | |
| 4033 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4034 | |modelCustomizationName |N |1 |String |A model customization name as defined in a service model. | |
| 4035 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4036 | |
| 4037 | |
| 4038 | Candidates Object |
| 4039 | |
| 4040 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4041 | |Attribute |Required |Cardinality|Content|Description | |
| 4042 | +===================+=========+===========+=======+=======================================================================+ |
| 4043 | |identifierType |Y |1 |String |The type of a candidate. | |
| 4044 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4045 | |identifiers |Y |1..N |List |A list of identifiers. | |
| 4046 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4047 | |cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id.| |
| 4048 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4049 | |
| 4050 | |
| 4051 | ServiceInfo Object |
| 4052 | |
| 4053 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4054 | |Attribute |Required |Cardinality|Content|Description | |
| 4055 | +===================+=========+===========+=======+=======================================================================+ |
| 4056 | |serviceInstanceId |Y |1 |String |A service instance id associated with a request. | |
| 4057 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4058 | |modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. | |
| 4059 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4060 | |serviceName |Y |1 |String |The name of a service | |
| 4061 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4062 | |
| 4063 | LicenseInfo Object |
| 4064 | |
| 4065 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4066 | |Attribute |Required |Cardinality|Content|Description | |
| 4067 | +===================+=========+===========+=======+=======================================================================+ |
| 4068 | |licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. | |
| 4069 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4070 | |
| 4071 | LicenseDemand Object |
| 4072 | |
| 4073 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4074 | |Attribute |Required |Cardinality|Content|Description | |
| 4075 | +===================+=========+===========+=======+=======================================================================+ |
| 4076 | |resourceModuleName |Y |1 |String |A resource name as defined in a service model. | |
| 4077 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4078 | |serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | |
| 4079 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4080 | |resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model.| |
| 4081 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4082 | |existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. | |
| 4083 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4084 | |
| 4085 | LicenseModel Object |
| 4086 | |
| 4087 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4088 | |Attribute |Required |Cardinality|Content|Description | |
| 4089 | +===================+=========+===========+=======+=======================================================================+ |
| 4090 | |entitlementPoolUUID|Y |1..N |List |Entitlement pool UUIDs associated with a resource. | |
| 4091 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4092 | |licenseKeyGroupUUID|Y |1..N |List |License key groups associated with a resource. | |
| 4093 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4094 | |
| 4095 | |
| 4096 | Response Body |
| 4097 | |
| 4098 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4099 | |Attribute |Required |Cardinality|Content|Description | |
| 4100 | +===================+=========+===========+=======+=======================================================================+ |
| 4101 | |requestId |Y |1 |String |A unique Id for an ONAP transaction. | |
| 4102 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4103 | |transactionId |Y |1 |String |A unique ID to track multiple requests associated with a transaction. | |
| 4104 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4105 | |statusMessage |N |1 |String |Reasoning if a requestStatus is failed. | |
| 4106 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |
| 4107 | |requestStatus |Y |1 |String |The status of a request. | |
| 4108 | +-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ |