Update Platform Config
Updates the platform configuration and triggers the appropriate Lifecycle Management (LCM) workflow asynchronously.
Behavior:
- Fresh Platform (Not Deployed): If the platform record exists but the cluster hasn't been deployed yet, this updates the configuration and immediately triggers the initial deployment workflow.
- Deployed Platform (Day-2 Operation): If the platform is already running, this saves the updated configuration and triggers a Day-2 configuration update workflow (e.g., scaling out worker nodes, modifying features).
Workflow Chain:
The response returns a 202 Accepted with a status_url. Call GET /sspi/platforms/{platform-id}/status to poll the update/deployment progress.
A globally unique UUID representing the platform to update.
434348d8-681e-4809-8dc1-427127d2bee7The modified platform configuration to apply.
{
"_revision": 1,
"compute": {
"cluster_id": "domain-c9",
"content_datastore_id": "datastore-45",
"datacenter_id": "datacenter-3",
"enable_resource_reservation": true,
"resource_pool_id": "resgroup-46",
"ssp_resource_pool_id": "resgroup-86",
"storage_policy_id": "aa6d5a82-1c88-45da-85d3-3d74b91a5bad"
},
"desired_state": "START",
"network": {
"dns": [
"dns.broadcom.example"
],
"network_configs": [
{
"network_id": "dvs-47",
"node_pools": [
{
"end": "172.16.111.66",
"name": "node-pool-name-1",
"start": "172.16.111.43"
}
],
"platform_default_gateway": "172.16.111.1",
"platform_subnet": "172.16.111.1/24",
"portgroup_id": "dvportgroup-49",
"service_pools": [
{
"end": "172.16.111.89",
"name": "service-ippool-name-1",
"start": "172.16.111.71"
}
]
}
],
"ntp": "ntp.broadcom.example",
"search_domain": "searchdomain.example"
},
"provider_id": "8289450b-f562-4ee5-9a40-dd840307319b",
"service": {
"addon_ids": [
"b39360db-b6a8-4894-abfb-0dae59ac9d00",
"3e9fff83-75b9-4dde-90a6-ddf4d9e0f539"
],
"ingress_fqdn": "ingress-fqdn.example",
"instance_name": "instance-name-example",
"kafka_fqdn": "kafka-fqdn.example",
"preserve_addons": false,
"ssp_bundle_id": "061352f8-b306-46a6-81fd-fe2998176c66"
},
"system": {
"controller_count": 3,
"form_factor": "LARGE",
"ssp_type": "ATP",
"worker_count": 5
}
}The platform action request has been accepted. Use the returned platform ID and status URL to query for more detailed information.
{
"id": "434348d8-681e-4809-8dc1-427127d2bee7",
"status_url": "https://sspi.example.com/sspi/platforms/434348d8-681e-4809-8dc1-427127d2bee7/status"
}UUID identifier of the response.
The URL to check the status of the operation.
Bad Request
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Unauthorized
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Forbidden
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Failed
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Precondition Required
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
Too Many Requests
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
An error occurred while checking the SSPI service.
{
"error_code": 0,
"module_name": "string",
"error_message": "string"
}HTTP Status or Application error code.
Module where the error happened.
Message describing the error.
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/sspi/platforms/{platform-id}