ContainerBlueprint onboard request (Provider API)

Description

This API onboards the specified container blueprint.


API stability classification

Unstable


API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/LogicalHostingEnvironmentBlueprint/bulkonboard

void

Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.


Request message body

This API uses the following objects in the request message body JSON. 


Top-level objects



Name

Type

Multi-
plicity

Description

callbackURL

String

0..1

URL to call when the operation finishes

postCallout

String

0..1

Identifier of a callout to run after the operation executes

preCallout

String

0..1

Identifier of a callout to run before the operation executes

timeout

Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

operationParams

OperationParameter

1

Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.





Input parameters to include in operationParams



Name

Type

Multi-
plicity

Description

containerblueprint_list

ContainerBlueprint

1..*

List of container blueprints to onboard

providerURI

String

1



How to get the Request message body

  1. Get Pod instance id from cloud db. BMC_ConcreteCollection form with cloudclass as pod.
  2. Use /csm/pod/<Pod-id>/getCompatibleBlueprints API with the POST method. Use the following example:


    {
        "operationParams": [{
            "name": "isOnboarded",
            "value": false,
            "type": "java.lang.Boolean",
            "multiplicity": "1"
        }],
        "timeout": -1,
        "alreadyTraversedGlobalRegistry": false,
        "alreadyTraversedLocalRegistry": false,
        "preCallout": "",
        "postCallout": "",
        "callbackURL": ""
    }
  3. The response that you get from /csm/pod/<Pod-id>/getCompatibleBlueprints  API lists down all compatible container blueprints.

  4. Take the required blueprint object as body for /csm/LogicalHostingEnvironmentBlueprint/bulkonboard API. Body : Should be response from previous API, it should be as bellow

    {
        "timeout": -1,
        "preCallout": "",
        "postCallout": "",
        "operationParams": [{
            "name": "lheBlueprints",
            "type": "com.bmc.cloud.model.beans.LogicalHostingEnvironmentBlueprint",
            "multiplicity": "1..*",
            "value": [{
                "cloudClass": "com.bmc.cloud.model.beans.LogicalHostingEnvironmentBlueprint",
                "externalID": "8bf6a03d-ec7e-4014-ab46-420ff7dd4748:AustinNCBlueprintMultiZone#0",
                "guid": "bf106505-be20-4f32-9140-98d69d85343d",
                "isLocked": false,
                "name": "AustinNCBlueprintMultiZone",
                "provider": "/provider/97ab63b7-d042-451f-a48e-9374eb8c5eba",
                "resourceHostingEnvironmentBlueprintObject": [{
                    "cloudClass": "com.bmc.cloud.model.beans.ContainerBlueprint",
                    "externalID": "8bf6a03d-ec7e-4014-ab46-420ff7dd4748:AustinNCBlueprintMultiZone#0",
                    "guid": "d1685c6c-a61e-4ac8-9419-d2c0cb01bb79",
                    "isLocked": false,
                    "isOnboarded": false,
                    "name": "AustinNCBlueprintMultiZone",
                    "pods": ["/pod/869e15fe-554a-4c60-b065-26c195fef6bb"],
                    "podsObject": [{
                        "cloudClass": "com.bmc.cloud.model.beans.Pod",
                        "externalID": "8bf6a03d-ec7e-4014-ab46-420ff7dd4748:AutoPodMZ",
                        "guid": "869e15fe-554a-4c60-b065-26c195fef6bb",
                        "isOnboarded": true,
                        "location": "/location/OI-bb48391e694d4282bf182618c374d78b",
                        "modifiedDate": 1527156296000,
                        "name": "AutoPodMZ",
                        "networks": ["/network/147c1af5-d344-49cf-ab29-f8d4df17db9f"],
                        "owner": "AltoCloudAdmin",
                        "provider": "/provider/8bf6a03d-ec7e-4014-ab46-420ff7dd4748",
                        "reconciliationID": "OI-754777f2e8c9435ab0e4a02ffa218495",
                        "staticPools": ["/staticpool/800aabb8-2744-4f9b-8fa8-fba7bd48752e"],
                        "switch": ["/switch/05d16be2-c952-419d-b4ee-099d03fada5d", "/switch/4fddc75d-b9c1-49f7-9890-ea7b1ba46aea", "/switch/03ed04c4-b06e-4b63-ab59-67f996544921", "/switch/13eac350-1df6-42d1-b0c0-a064b85ab4f4", "/switch/4dea973f-7cd0-4ebd-91e3-974d28126af1", "/switch/c6c66aec-43bc-45ae-a662-742702522126"],
                        "switchPort": ["/switchport/aa3c15a3-a355-4a5f-9e12-c8d8b9de1674", "/switchport/394f916d-3f26-42d1-80f7-11fedf9eaa8a", "/switchport/f123c3f7-8d0c-4763-a928-2e660616b441"],
                        "tokenID": "869e15fe-554a-4c60-b065-26c195fef6bb"
                    }],
                    "provider": "/provider/8bf6a03d-ec7e-4014-ab46-420ff7dd4748",
                    "version": "0"
                }],
                "versionNumber": 0
            }]
        }]
    }


HTTP response message

Response message headers

This API uses only common headers listed in HTTP request and response headers.

Response message body

The response message body contains a Task object.


Was this page helpful? Yes No Submitting... Thank you

Comments