REST API for Oracle Blockchain Platform Enterprise Edition

Scale In a Blockchain Platform Instance

post

/api/v1/blockchainPlatforms/instances/{id}/scalein

Scale in a Blockchain Platform instance.

Request

Supported Media Types

application/json

Path Parameters

id: string

Unique platform instance identifier

request payload in JSON

Root Schema : ScaleInPayload

Type: object

scaleIn payload

Show Source

nodes(optional): object ScaleInNodes

ScaleIn node details

{
    "type":"object",
    "description":"scaleIn payload",
    "properties":{
        "nodes":{
            "$ref":"#/definitions/ScaleInNodes"
        }
    }
}

Nested Schema : ScaleInNodes

Type: object

ScaleIn node details

Show Source

peer(optional): array peer

Peer hostnames

{
    "type":"object",
    "description":"ScaleIn node details",
    "properties":{
        "peer":{
            "type":"array",
            "description":"Peer hostnames",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : peer

Type: array

Peer hostnames

Show Source

Array of: string

{
    "type":"array",
    "description":"Peer hostnames",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

202 Response

Accepted

Headers

Location: string

Location header with a URL to query the status of the request.

401 Response

Unauthorized

Root Schema : Error

Type: object

Error Information.

Show Source

errors(optional): array errors

list of errors
message: string

A human-readable error string.
status: string

A short error status that defines the error, meant for programmatic parsing.
warnings(optional): array warnings

list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

404 Response

Not Found

Root Schema : Error

Type: object

Error Information.

Show Source

errors(optional): array errors

list of errors
message: string

A human-readable error string.
status: string

A short error status that defines the error, meant for programmatic parsing.
warnings(optional): array warnings

list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

409 Response

Operation conflict

Root Schema : Error

Type: object

Error Information.

Show Source

errors(optional): array errors

list of errors
message: string

A human-readable error string.
status: string

A short error status that defines the error, meant for programmatic parsing.
warnings(optional): array warnings

list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Error Information.

Show Source

errors(optional): array errors

list of errors
message: string

A human-readable error string.
status: string

A short error status that defines the error, meant for programmatic parsing.
warnings(optional): array warnings

list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Examples

This endpoint is used to scale in a particular Blockchain Platform instance.

The following example shows how to query and scale in a particular Blockchain Platform instance by submitting a POST request on the REST resource using cURL.

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

Example of the Request Body

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

{
  "nodes": {
    "peer": [
      "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99-peer0"
    ]
  }
}'

Example of the Response Body

The following example shows the contents of the response body:

202 Accepted