Get the status of an operation that being performed on an event broker service. To get the operation, you provide identifier of the operation and the identifier of the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "MISSION CONTROL",
"description": "Documentation for Mission Control API",
"version": "2.2.1"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace Cloud SG Region"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/api/v2/missionControl/eventBrokerServices/{serviceId}/operations/{operationId}": {
"get": {
"tags": [
"Event Broker Services"
],
"summary": "Get the status of a service operation",
"description": "Get the status of an operation that being performed on an event broker service. To get the operation, you provide identifier of the operation and the identifier of the event broker service.
Your token must have one of the permissions listed in the Token Permissions.
mission_control:access or services:get or services:get:self or services:view or services:view:self ]",
"operationId": "getServiceOperation",
"parameters": [
{
"name": "serviceId",
"in": "path",
"description": "The unique identifier of the event broker service.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "operationId",
"in": "path",
"description": "The identifier of the operation being performed on the event broker service.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "expand",
"in": "query",
"description": "Additional information to retrieve about the in-progress operation for the event broker service. The supported values are: progressLogsprogressLogs may include information about the state of in-progress multi-stage operations for an event broker service, for example, high-availability switchovers.",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponse"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {}
}
},
"401": {
"description": "Unauthorized.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "An authentication error occurred.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"403": {
"description": "Forbidden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "You do not have permissions to perform this operation.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"404": {
"description": "Not found.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"message": "Could not find the event broker service with id 4o5kyf4x5504.",
"errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
}
}
}
},
"409": {
"description": "Conflict.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"502": {
"description": "Bad Gateway - Marketplace integration error.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service unavailable.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
}
},
"components": {
"schemas": {
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object",
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"description": "The metadata about the error. This provides additional information about the error that occurred.",
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']",
"items": {
"type": "string",
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
}
}
},
"Link": {
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "The location of the related resource, relative to the API root.",
"readOnly": true,
"example": "/api/v2/missionControl/eventBrokerServices/abc123/deploymentInstructions"
}
},
"description": "A link to a related resource.",
"readOnly": true
},
"Operation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Operations requiring time to complete provide an operation identifier so you can query their progress."
},
"type": {
"type": "string",
"description": "The type of object for informational purposes.",
"readOnly": true,
"example": "operation"
},
"operationType": {
"$ref": "#/components/schemas/jobOperationTypes"
},
"createdBy": {
"type": "string",
"description": "The unique identifier representing the user who created the operation."
},
"createdTime": {
"type": "string",
"description": "The time the operation was created, in ISO 8601 date/time format.",
"example": "2022-03-14T15:01:34.000Z"
},
"completedTime": {
"type": "string",
"description": "The completion time, whether it was successful or failed, in ISO 8601 date/time format.",
"example": "2022-03-14T15:01:34.000Z"
},
"resourceId": {
"type": "string",
"description": "The resource ID that the operation belongs to.",
"readOnly": true,
"example": "abcd1234"
},
"resourceType": {
"type": "string",
"description": "The resource type that the operation belongs to.",
"readOnly": true,
"example": "service"
},
"progressLogs": {
"type": "array",
"description": "The progress logs for the operation, if available. Not all operations provide progress logs. If the operation provides progress logs, you will see them listed below.",
"items": {
"$ref": "#/components/schemas/OperationProgressLog"
}
},
"status": {
"type": "string",
"description": "The status of the operation.",
"readOnly": true,
"example": "PENDING",
"enum": [
"PENDING",
"INPROGRESS",
"SUCCEEDED",
"FAILED"
]
},
"error": {
"$ref": "#/components/schemas/OperationError"
},
"_links": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Link"
},
"description": "Links to resources related to this operation, keyed by link relation. Present only for operations that have related resources to point at.",
"readOnly": true
}
}
},
"OperationError": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message describing the reason for the error or what went wrong."
},
"errorId": {
"type": "string",
"description": "A universally unique identifier (UUID) is useful for debugging. You can provide this code as part of the information you send to our support team."
}
}
},
"OperationProgressLog": {
"type": "object",
"properties": {
"step": {
"type": "string"
},
"message": {
"type": "string"
},
"timestamp": {
"type": "string"
},
"stepId": {
"type": "string"
},
"status": {
"type": "string"
}
},
"description": "The progress logs for the operation, if available. Not all operations provide progress logs. If the operation provides progress logs, you will see them listed below."
},
"OperationResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Operation"
},
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
},
"jobOperationTypes": {
"type": "string",
"description": "The type of operation against the resource.",
"enum": [
"createService",
"cloneService",
"deleteService",
"createClientProfile",
"updateClientProfile",
"deleteClientProfile",
"createDnsName",
"moveDnsName",
"deleteDnsName",
"serviceRequest",
"infrastructureRequest",
"datacenterRequest",
"uploadCertificate",
"installCertificate",
"deleteCertificate",
"haSwitchover",
"rotateReplicationPSK",
"serviceScaleUp",
"serviceUpgrade",
"createConnectionEndpoint",
"updateConnectionEndpoint",
"updateMateLinkEncryption",
"deleteConnectionEndpoint",
"createLdapManagementAccess",
"updateLdapManagementAccess",
"deleteLdapManagementAccess",
"createLdapProfile",
"updateLdapProfile",
"deleteLdapProfile",
"enableDmrCluster",
"disableDmrCluster",
"resetBrokerPasswords"
]
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
```