Jump to

• Request
• Response
• Examples

Get Operation Status of an Instance

get

/api/v1/blockchainPlatforms/instances/{id}/operation/{opid}/status

Get the operation status of an Blockchain Platform instance.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  Unique platform instance identifier
• opid: string
  the operation id to query

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : OperationStatus

Type: object

Show Source

• details(optional): string
  e.g. step info, fail reason
• instanceId(optional): string
  Instance ID
• operation(optional): string
  Allowed Values: [ "create", "delete", "start", "stop", "update", "patch", "scaleout", "scalein" ]

  Operation querying
• operationId(optional): string
  Operation ID
• status(optional): string
  Allowed Values: [ "norecord", "inprogress", "failed", "successful", "successfulwitherrors", "unknown" ]

  For delete, 404 will be returned after it succeeds.

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Instance ID"
        },
        "operationId":{
            "type":"string",
            "description":"Operation ID"
        },
        "operation":{
            "type":"string",
            "description":"Operation querying",
            "enum":[
                "create",
                "delete",
                "start",
                "stop",
                "update",
                "patch",
                "scaleout",
                "scalein"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "norecord",
                "inprogress",
                "failed",
                "successful",
                "successfulwitherrors",
                "unknown"
            ],
            "description":"For delete, 404 will be returned after it succeeds."
        },
        "details":{
            "type":"string",
            "description":"e.g. step info, fail reason"
        }
    }
}

401 Response

Not authorized

404 Response

Invalid parameters

500 Response

Service unavailable

Back to Top

Examples

This endpoint is used to get the status of an operation performed on a particular Blockchain Platform instance.

The following example shows how to query and get the status of an operation performed on a particular Blockchain Platform instance by submitting a GET request on the REST resource using cURL:

curl -X GET \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/operation/IDpJPaezDL9_7zTlfY2ti-LlxB7kW8hCoz5lZPQCv8Cr4=/status \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json' \
  

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
  "operation": "create",
  "status": "successful",
  "details": "",
  "operationId": "IDpJPaezDL9_7zTlfY2ti-LlxB7kW8hCoz5lZPQCv8Cr4="
}

Back to Top