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

Create a New Blockchain Platform

post

/20191010/blockchainPlatforms

Creates a new Blockchain Platform. platformVersion is the parameter which defines the Hyperledger Fabric version as v2.2.4 or v1.4.7, that will be used for creating an instance. Values are:

Hyperledger Fabric v2.2.4
Hyperledger Fabric v1.4.7

If no platformVersion is passed, the default is v2.2.4.

Request

Supported Media Types

application/json

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.

Details for the new service.

Root Schema : CreateBlockchainPlatformDetails

Type: object

Blockchain Platform details for creating a new service.

Show Source

caCertArchiveText: string

Minimum Length: 1

Maximum Length: 10485760

Base64 encoded text in ASCII character set of a third-party CA Certificates archive file. The Archive file is a zip file containing third part CA certificates, the ca key and certificate files used when issuing enrollment certificates (ECerts) and transaction certificates (TCerts). The chainfile (if it exists) contains the certificate chain which should be trusted for this CA, where the 1st in the chain is always the root CA certificate. File list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)].
compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

Compartment identifier
computeShape(required): string

Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
description: string

Minimum Length: 1

Maximum Length: 255

Blockchain Platform instance description
displayName(required): string

Minimum Length: 1

Maximum Length: 255

Blockchain Platform instance display name. Can be renamed.
federatedUserId: string

Minimum Length: 1

Maximum Length: 255

Identifier for a federated user
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
idcsAccessToken(required): string

Minimum Length: 1

Maximum Length: 5000

IDCS access token with Identity Domain Administrator role
isByol: boolean

Default Value: false

Bring your own license
platformRole(required): string

Role of platform: founder or participant
platformVersion: string

Minimum Length: 1

Maximum Length: 255

Platform version. Values are: Hyperledger Fabric v1.4.7 and Hyperledger Fabric v2.2.4

{
    "description":"Blockchain Platform details for creating a new service.",
    "type":"object",
    "required":[
        "compartmentId",
        "displayName",
        "platformRole",
        "computeShape",
        "idcsAccessToken"
    ],
    "properties":{
        "displayName":{
            "description":"Blockchain Platform instance display name. Can be renamed.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "compartmentId":{
            "description":"Compartment identifier",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "description":{
            "description":"Blockchain Platform instance description",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "platformRole":{
            "description":"Role of platform: founder or participant",
            "x-obmcs-enumref":"#/definitions/BlockchainPlatform/platformRole",
            "type":"string"
        },
        "computeShape":{
            "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, ENTERPRISE_CUSTOM, DIGITAL_ASSETS_MEDIUM, DIGITAL_ASSETS_LARGE, or DIGITAL_ASSETS_EXTRA_LARGE.",
            "x-obmcs-enumref":"#/definitions/BlockchainPlatform/computeShape",
            "type":"string"
        },
        "isByol":{
            "description":"Bring your own license",
            "type":"boolean",
            "default":false
        },
        "platformVersion":{
            "description":"Platform version. Values are: Hyperledger Fabric v1.4.7 and Hyperledger Fabric v2.2.4",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "idcsAccessToken":{
            "description":"IDCS access token with Identity Domain Administrator role",
            "type":"string",
            "minLength":"1",
            "maxLength":"5000"
        },
        "federatedUserId":{
            "description":"Identifier for a federated user",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "caCertArchiveText":{
            "description":"Base64 encoded text in ASCII character set of a third-party CA Certificates archive file.\nThe Archive file is a zip file containing third part CA certificates,\nthe ca key and certificate files used when issuing enrollment certificates\n(ECerts) and transaction certificates (TCerts). The chainfile (if it exists)\ncontains the certificate chain which should be trusted for this CA, where\nthe 1st in the chain is always the root CA certificate.\nFile list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)].\n",
            "type":"string",
            "minLength":"1",
            "maxLength":"10485760"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Response

Supported Media Types

application/json

202 Response

The platform will be created.

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

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"
        }
    }
}