Oracle Cloud InfrastructureのOracle Blockchain PlatformのREST API (Hyperledger Fabric v1.4)

機械翻訳について

ブロックチェーン・プラットフォーム情報の取得

get

/20191010/blockchainPlatforms/{blockchainPlatformId}

特定のIDで識別されるブロックチェーン・プラットフォームに関する情報を取得します。

リクエスト

サポートされるメディア・タイプ

application/json

パス・パラメータ

blockchainPlatformId: string

一意のサービス識別子。

ヘッダー・パラメータ

opc-request-id: string

トレース用のクライアント・リクエストID。

トップに戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

指定されたIDのサービスを取得

ヘッダー

etag: string

オプティミスティックな同時実行性制御用。 `if-match`を参照してください。
opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : BlockchainPlatform

型: object

ブロックチェーン・プラットフォーム・インスタンスの説明。

Show Source

compartmentId: string

コンパートメント識別子
componentDetails(optional): object BlockchainPlatformComponentDetails

ブロックチェーン・プラットフォーム・コンポーネントの詳細。
computeShape: string

許容値: [ "STANDARD", "ENTERPRISE_SMALL", "ENTERPRISE_MEDIUM", "ENTERPRISE_LARGE", "ENTERPRISE_EXTRA_LARGE", "ENTERPRISE_CUSTOM" ]

コンピュート・シェイプのタイプ: STANDARD、ENTERPRISE_SMALL、ENTERPRISE_MEDIUM、ENTERPRISE_LARGE、ENTERPRISE_EXTRA_LARGEまたはENTERPRISE_CUSTOM。
definedTags(optional): object definedTags

許可される追加プロパティ: additionalProperties

このリソースの定義済タグ。各キーは事前定義され、ネームスペースにスコープ指定されています。例: `{"foo-namespace": {"bar-key": "value"}}`
description(optional): string

プラットフォーム・インスタンスの説明
displayName: string

プラットフォーム・インスタンス表示名。名前を変更できます
freeformTags(optional): object freeformTags

許可される追加プロパティ: additionalProperties

事前定義された名前、タイプまたはスコープなしで適用される単純なキーと値のペア。クロス互換性のためにのみ存在します。例: `{"bar-key": "value"}`
hostOcpuUtilizationInfo(optional): array hostOcpuUtilizationInfo

すべてのホストのOcpuUtilizationのリスト
id: string

作成時に変更できない一意の識別子
isByol(optional): boolean

自身のライセンスを使用
isChaincodeClusterEnabled(optional): boolean

プラットフォーム・クラスタで複数のチェーンコード・ホストが有効化されました
isMultiAD(optional): boolean

マルチADブロックチェーン・プラットフォームの場合はtrue、シングルADの場合はfalse
lifecycleDetails(optional): string

現在の状態をより詳細に説明するメッセージ。たとえば、失敗状態のリソースのアクション可能な情報を提供するために使用できます。
lifecycleState(optional): string

許容値: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "SCALING", "INACTIVE", "FAILED" ]

ブロックチェーン・プラットフォームの現在の状態。
platformRole: string

許容値: [ "FOUNDER", "PARTICIPANT" ]

プラットフォームのロール: FOUNDERまたはPARTICIPANT
replicas(optional): object ReplicaDetails

RESTプロキシ、CA、コンソールなどのサービス・コンポーネントのレプリカの数
serviceEndpoint(オプション): string

サービス・エンドポイントURL、プロビジョニング後有効
serviceVersion(optional): string

ブロックチェーン・プラットフォームのバージョン。
storageSizeInTBs(optional): number(double)

ストレージ・サイズ(TB)
storageUsedInTBs(optional): number(double)

TBで使用されるストレージ
timeCreated(optional): string(date-time)

ブロックチェーン・プラットフォームが作成された時間。「An RFC3339」書式設定日時文字列
timeUpdated(optional): string(date-time)

ブロックチェーン・プラットフォームが更新された時間。「An RFC3339」書式設定日時文字列
totalOcpuCapacity(optional): integer

プラットフォーム・クラスタに割り当てられたOCPUの合計数

{
    "description":"Blockchain Platform Instance Description.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"blockchainplatform",
        "ocidEntityType":"blockchainplatform",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "ACTIVE",
            "UPDATING",
            "INACTIVE",
            "SCALING",
            "FAILED"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetBlockchainPlatform",
        "listResourcesOperationId":"ListBlockchainPlatforms"
    },
    "required":[
        "id",
        "compartmentId",
        "displayName",
        "platformRole",
        "computeShape"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation",
            "type":"string"
        },
        "displayName":{
            "description":"Platform Instance Display name, can be renamed",
            "type":"string"
        },
        "compartmentId":{
            "description":"Compartment identifier",
            "type":"string"
        },
        "description":{
            "description":"Platform instance description",
            "type":"string"
        },
        "isByol":{
            "description":"Bring your own license",
            "type":"boolean"
        },
        "timeCreated":{
            "description":"The time the the Blockchain Platform was created. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Blockchain Platform was updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "serviceVersion":{
            "description":"The version of the Blockchain Platform.",
            "type":"string"
        },
        "platformRole":{
            "description":"Role of platform: FOUNDER or PARTICIPANT",
            "enum":[
                "FOUNDER",
                "PARTICIPANT"
            ],
            "type":"string"
        },
        "computeShape":{
            "description":"Type of compute shape: STANDARD, ENTERPRISE_SMALL, ENTERPRISE_MEDIUM, ENTERPRISE_LARGE, ENTERPRISE_EXTRA_LARGE, or ENTERPRISE_CUSTOM.",
            "enum":[
                "STANDARD",
                "ENTERPRISE_SMALL",
                "ENTERPRISE_MEDIUM",
                "ENTERPRISE_LARGE",
                "ENTERPRISE_EXTRA_LARGE",
                "ENTERPRISE_CUSTOM"
            ],
            "type":"string"
        },
        "serviceEndpoint":{
            "description":"Service endpoint URL, valid post-provisioning",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the Blockchain Platform.",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "SCALING",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        },
        "lifecycleDetails":{
            "description":"A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        },
        "storageSizeInTBs":{
            "type":"number",
            "format":"double",
            "description":"Storage size in TBs"
        },
        "storageUsedInTBs":{
            "type":"number",
            "format":"double",
            "description":"Storage used in TBs"
        },
        "isMultiAD":{
            "type":"boolean",
            "description":"True for multi-AD Blockchain Platforms, false for single-AD"
        },
        "totalOcpuCapacity":{
            "type":"integer",
            "description":"Number of total OCPUs allocated to the platform cluster"
        },
        "isChaincodeClusterEnabled":{
            "type":"boolean",
            "description":"Multiple chaincode hosts enabled in the platform cluster"
        },
        "componentDetails":{
            "$ref":"#/definitions/BlockchainPlatformComponentDetails"
        },
        "replicas":{
            "$ref":"#/definitions/ReplicaDetails"
        },
        "hostOcpuUtilizationInfo":{
            "type":"array",
            "description":"List of OcpuUtilization for all hosts",
            "items":{
                "$ref":"#/definitions/OcpuUtilizationInfo"
            }
        },
        "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"
                }
            }
        }
    }
}

ネストされたスキーマ : BlockchainPlatformComponentDetails

型: object

ブロックチェーン・プラットフォーム・コンポーネントの詳細。

Show Source

osns(optional): array osns

OSNのリスト
peers (オプション): array peers

ピアのリスト

{
    "description":"Blockchain Platform component details.",
    "type":"object",
    "properties":{
        "osns":{
            "type":"array",
            "description":"List of OSNs",
            "items":{
                "$ref":"#/definitions/Osn"
            }
        },
        "peers":{
            "type":"array",
            "description":"List of Peers",
            "items":{
                "$ref":"#/definitions/Peer"
            }
        }
    }
}

ネストされたスキーマ : definedTags

型: object

使用可能なその他のプロパティ

Show Source

object additionalProperties

許可される追加プロパティ: additionalProperties

ネームスペースにスコープ指定された事前定義済タグのキーと値を表すキーと値のペア。例: `{"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"
        }
    }
}

このリソースの定義済タグ。各キーは事前定義され、ネームスペースにスコープ指定されています。例: `{"foo-namespace": {"bar-key": "value"}}`

ネストされたスキーマ : freeformTags

型: object

使用可能なその他のプロパティ

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

事前定義された名前、タイプまたはスコープなしで適用される単純なキーと値のペア。クロス互換性のためにのみ存在します。例: `{"bar-key": "value"}`

ネストされたスキーマ : hostOcpuUtilizationInfo

型: array

すべてのホストのOcpuUtilizationのリスト

Show Source

Array of: object OcpuUtilizationInfo

VMホストのOCPU使用率

{
    "type":"array",
    "description":"List of OcpuUtilization for all hosts",
    "items":{
        "$ref":"#/definitions/OcpuUtilizationInfo"
    }
}

ネストされたスキーマ : ReplicaDetails

型: object

RESTプロキシ、CA、コンソールなどのサービス・コンポーネントのレプリカの数

Show Source

caCount(optional): integer

最小値: 1

最大値: 10

CAレプリカの数
consoleCount(optional): integer

最小値: 1

最大値: 10

コンソール・レプリカの数
proxyCount(optional): integer

最小値: 1

最大値: 10

RESTプロキシ・レプリカの数

{
    "type":"object",
    "description":"Number of replicas of service components like REST Proxy, CA and Console",
    "properties":{
        "proxyCount":{
            "type":"integer",
            "minimum":1,
            "maximum":10,
            "description":"Number of REST proxy replicas"
        },
        "caCount":{
            "type":"integer",
            "minimum":1,
            "maximum":10,
            "description":"Number of CA replicas"
        },
        "consoleCount":{
            "type":"integer",
            "minimum":1,
            "maximum":10,
            "description":"Number of console replicas"
        }
    }
}

ネストされたスキーマ : osns

型: array

OSNのリスト

Show Source

Array of: object Osn

オーダリング・サービス・ノード詳細

{
    "type":"array",
    "description":"List of OSNs",
    "items":{
        "$ref":"#/definitions/Osn"
    }
}

ネストされたスキーマ : peers

型: array

ピアのリスト

Show Source

Array of: object Peer

ピア詳細

{
    "type":"array",
    "description":"List of Peers",
    "items":{
        "$ref":"#/definitions/Peer"
    }
}

ネストされたスキーマ : Osn

型: object

オーダリング・サービス・ノード詳細

Show Source

ad: string

OSNの可用性ドメイン。オプションはAD1/AD2/AD3です。
単一の可用性ドメイン・リージョンでは、可用性ドメイン間でリソースが分散されるのではなく、フォルト・ドメイン間で分散されます。アベイラビリティ・ドメイン番号は、各アベイラビリティ・ドメインで使用可能な3つのフォルト・ドメインのいずれかにマップされます。
lifecycleState(optional): string

許容値: [ "ACTIVE", "INACTIVE", "FAILED" ]

OSNの現在の状態。
ocpuAllocationParam(optional): object OcpuAllocationNumberParam

OCPU割当てパラメータ
osnKey: string

最小長: 1

最大長: 255

OSN識別子

{
    "type":"object",
    "description":"Ordering Service Node details",
    "required":[
        "osnKey",
        "ad"
    ],
    "properties":{
        "osnKey":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"OSN identifier"
        },
        "ad":{
            "description":"<p>Availability domain for the OSN. 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 is mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        },
        "lifecycleState":{
            "description":"The current state of the OSN.",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ : OcpuAllocationNumberParam

型: object

OCPU割当てパラメータ

Show Source

ocpuAllocationNumber: number(float)

最小値: 0

最大値: 64

OCPU割当ての数

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

ネストされたスキーマ : ピア

型: object

ピア詳細

Show Source

ad: string

ピアの可用性ドメイン。オプションはAD1/AD2/AD3です。
単一の可用性ドメイン・リージョンでは、可用性ドメイン間でリソースが分散されるのではなく、フォルト・ドメイン間で分散されます。ピアの可用性ドメイン番号は、各可用性ドメインで使用可能な3つのフォルト・ドメインのいずれかにマップされます。
alias(オプション): string

ピア別名
host: string

ピアが存在するホスト
lifecycleState(optional): string

許容値: [ "ACTIVE", "INACTIVE", "FAILED" ]

ピアの現在の状態。
ocpuAllocationParam(optional): object OcpuAllocationNumberParam

OCPU割当てパラメータ
peerKey: string

最小長: 1

最大長: 255

ピア識別子
role: string

ピアのロール

{
    "type":"object",
    "description":"Peer details",
    "required":[
        "peerKey",
        "role",
        "host",
        "ad"
    ],
    "properties":{
        "peerKey":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"peer identifier"
        },
        "role":{
            "description":"Peer role",
            "x-obmcs-enumref":"#/definitions/PeerRole/role",
            "type":"string"
        },
        "alias":{
            "type":"string",
            "description":"peer alias"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        },
        "host":{
            "type":"string",
            "description":"Host on which the peer exists"
        },
        "ad":{
            "description":"<p>Availability domain of the 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 of the peer is mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the peer.",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        }
    }
}

ネストされたスキーマ : additionalProperties

型: object

使用可能なその他のプロパティ

Show Source

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

ネームスペースにスコープ指定された事前定義済タグのキーと値を表すキーと値のペア。例: `{"bar-key": "value"}`

ネストされたスキーマ : additionalProperties

型: object

タグの値。サポートされているのは、文字列、整数およびブール型のみです。

ネストされたスキーマ : OcpuUtilizationInfo

型: object

VMホストのOCPU使用率

Show Source

host(optional): string

VMのホスト名
ocpuCapacityNumber(optional): number(float)

ホスト上のOCPU容量の合計数
ocpuUtilizationNumber(optional): number(float)

使用されたOCPUの数

{
    "type":"object",
    "description":"OCPU utilization for a VM host",
    "properties":{
        "host":{
            "type":"string",
            "description":"Host name of VM"
        },
        "ocpuUtilizationNumber":{
            "type":"number",
            "format":"float",
            "description":"Number of OCPUs utilized"
        },
        "ocpuCapacityNumber":{
            "type":"number",
            "format":"float",
            "description":"Number of total OCPU capacity on the host"
        }
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

404レスポンス

無効なパラメータ

429レスポンス

リクエストが多すぎます

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : エラー

型: object

エラー情報。

Show Source

code: string

プログラム解析用のエラーを定義する短いエラー・コード。
message: 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レスポンス

サービス使用不可

デフォルト・レスポンス

不明なエラー

ヘッダー

opc-request-id: string

リクエストに対するOracleで割り当てられた一意の識別子。特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

ルート・スキーマ : エラー

型: object

エラー情報。

Show Source

code: string

プログラム解析用のエラーを定義する短いエラー・コード。
message: 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"
        }
    }
}

トップに戻る