REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

Create Blockchain Platform Peer

post

/20191010/blockchainPlatforms/{blockchainPlatformId}/peers

Creates a Blockchain Platform peer.

Request

Supported Media Types

application/json

Path Parameters

blockchainPlatformId(required): string

Unique service identifier.

Header Parameters

opc-request-id: string

The client request ID for tracing.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Input payload to create a Blockchain Platform peer. The payload cannot be empty.

Root Schema : CreatePeerDetails

Type: object

The peer details to be added

Show Source

ad(required): string

Availability domain to place new peer. Options are AD1/AD2/AD3.
For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.
alias: string

Minimum Length: 1

Maximum Length: 16

peer alias
ocpuAllocationParam(required): object OcpuAllocationNumberParam

OCPU allocation parameter
role(required): string

Peer role

{
    "type":"object",
    "description":"The peer details to be added",
    "required":[
        "role",
        "ocpuAllocationParam",
        "ad"
    ],
    "properties":{
        "role":{
            "description":"Peer role",
            "x-obmcs-enumref":"#/definitions/PeerRole/role",
            "type":"string"
        },
        "alias":{
            "type":"string",
            "minLength":"1",
            "maxLength":"16",
            "description":"peer alias"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        },
        "ad":{
            "description":"<p>Availability domain to place new peer. Options are AD1/AD2/AD3.</p><p>For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number that you select will be mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        }
    }
}

Nested Schema : OcpuAllocationNumberParam

Type: object

OCPU allocation parameter

Show Source

ocpuAllocationNumber(required): number(float)

Minimum Value: 0

Maximum Value: 64

Number of OCPU allocation

{
    "type":"object",
    "description":"OCPU allocation parameter",
    "required":[
        "ocpuAllocationNumber"
    ],
    "properties":{
        "ocpuAllocationNumber":{
            "type":"number",
            "format":"float",
            "minimum":"0",
            "maximum":"64",
            "description":"Number of OCPU allocation"
        }
    }
}

Response

Supported Media Types

application/json

202 Response

The request to create a peer was accepted.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-work-request-id: string

Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

400 Response

Bad Request

401 Response

Not authorized

404 Response

Invalid parameters

409 Response

Conflict

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

412 Response

Precondition failed

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

500 Response

Service unavailable

Default Response

Unknown Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : Error

Type: object

Error Information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}