移動

• リクエスト
• レスポンス
• 例

Blockchain Platformインスタンスのリスト

get

/api/v1/blockchainPlatforms/instances

Blockchain Platformインスタンスのサマリーおよびリストを取得します。

リクエスト

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

• application/json

問合せパラメータ

• includeSummary: string
  インスタンス・サマリーを含める: trueまたはfalse

  許容値: [ true, false ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

Blockchain Platformインスタンスのサマリーおよびリストを取得します

本文()

ルート・スキーマ: schema

型: array

ソースの表示

• 配列: object BlockchainPlatformSummaryWrapper
  Blockchain Platformサマリー・リストのラッパー

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformSummaryWrapper"
    }
}

ネストしたスキーマ: BlockchainPlatformSummaryWrapper

型: object

Blockchain Platformサマリー・リストのラッパー

ソースの表示

• instances: array instances
  Blockchain Platformインスタンスのリスト
• summary: object InstancesCountSummary
  Blockchain Platformインスタンス数のサマリー

{
    "description":"Blockchain Platform summary list wrapper",
    "type":"object",
    "properties":{
        "instances":{
            "description":"List of Blockchain Platform instances",
            "type":"array",
            "items":{
                "$ref":"#/definitions/BlockchainPlatformSummary"
            }
        },
        "summary":{
            "$ref":"#/definitions/InstancesCountSummary"
        }
    }
}

ネストしたスキーマ: instances

型: array

Blockchain Platformインスタンスのリスト

ソースの表示

• 配列: object BlockchainPlatformSummary
  Blockchain Platformのサマリー

{
    "description":"List of Blockchain Platform instances",
    "type":"array",
    "items":{
        "$ref":"#/definitions/BlockchainPlatformSummary"
    }
}

ネストしたスキーマ: InstancesCountSummary

型: object

Blockchain Platformインスタンス数のサマリー

ソースの表示

• developerCount: integer
  開発者インスタンスの合計数
• enterpriseCount: integer
  エンタープライズ・インスタンスの合計数
• founderCount: integer
  ファウンダ・インスタンスの合計数
• instancesCount: integer
  インスタンスの合計数
• participantCount: integer
  参加者インスタンスの合計数

{
    "description":"Blockchain Platform instance count summary",
    "type":"object",
    "properties":{
        "instancesCount":{
            "description":"Total number of instances",
            "type":"integer"
        },
        "founderCount":{
            "description":"Total number of founder instances",
            "type":"integer"
        },
        "participantCount":{
            "description":"Total number of participant instances",
            "type":"integer"
        },
        "enterpriseCount":{
            "description":"Total number of enterprise instances",
            "type":"integer"
        },
        "developerCount":{
            "description":"Total number of developer instances",
            "type":"integer"
        }
    }
}

ネストしたスキーマ: BlockchainPlatformSummary

型: object

Blockchain Platformのサマリー

ソースの表示

• configuration: string
  許容値: [ "Developer", "Enterprise" ]

  コンピュート構成のタイプ: DeveloperまたはEnterprise
• createActivityId: string
  インスタンスを作成した作成操作のアクティビティID
• createdBy: string
  インスタンスを作成したユーザー
• displayName: string
  インスタンスの表示名。名前を変更できます
• domainName: string
  インスタンス・ドメイン名
• id(必須): string
  作成時に変更できない一意の識別子
• lifecycleState: string
  許容値: [ "Creating", "Active", "Updating", "Terminating", "Terminated", "Starting", "Stopping", "Stopped", "Patching", "RollBack", "ScalingOut", "ScalingIn", "Unknown", "Failed" ]

  インスタンスの現在の操作の状態
• platformRole: string
  許容値: [ "Founder", "Participant" ]

  プラットフォームのロール: FounderまたはParticipant
• serviceEndpoint: string
  インスタンス・データ・プレーン・コンソール・エンドポイント
• stateMessage: string
  インスタンス状態メッセージ
• status: string
  許容値: [ "Healthy", "Unhealthy", "Down", "Unknown", "Stopped" ]

  インスタンスのステータス
• statusDisplayName: string
  許容値: [ "Up", "PartiallyUp", "Down", "Unknown", "Stopped" ]

  インスタンス・ステータス表示名
• timeCreated: string(date-time)
  インスタンスが作成された時間。RFC3339形式の日時文字列
• timeUpdated: string(date-time)
  インスタンスが更新された時間。RFC3339形式の日時文字列
• version: string
  インスタンスのバージョン

{
    "description":"Blockchain Platform summary",
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "description":"Unique identifier that is immutable on creation",
            "type":"string"
        },
        "displayName":{
            "description":"Instance display name, can be renamed",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the the instance was created. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the instance was updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The user who created the instance",
            "type":"string"
        },
        "createActivityId":{
            "description":"The activity ID of the create operation that created the instance",
            "type":"string"
        },
        "platformRole":{
            "description":"Role of platform: Founder or Participant",
            "type":"string",
            "enum":[
                "Founder",
                "Participant"
            ]
        },
        "configuration":{
            "description":"Type of compute configuration: Developer or Enterprise",
            "type":"string",
            "enum":[
                "Developer",
                "Enterprise"
            ]
        },
        "status":{
            "type":"string",
            "description":"Instance status",
            "enum":[
                "Healthy",
                "Unhealthy",
                "Down",
                "Unknown",
                "Stopped"
            ]
        },
        "lifecycleState":{
            "description":"The current operation state of the instance",
            "enum":[
                "Creating",
                "Active",
                "Updating",
                "Terminating",
                "Terminated",
                "Starting",
                "Stopping",
                "Stopped",
                "Patching",
                "RollBack",
                "ScalingOut",
                "ScalingIn",
                "Unknown",
                "Failed"
            ],
            "type":"string"
        },
        "version":{
            "description":"Instance version",
            "type":"string"
        },
        "domainName":{
            "description":"Instance domain name",
            "type":"string"
        },
        "stateMessage":{
            "description":"Instance state message",
            "type":"string"
        },
        "serviceEndpoint":{
            "description":"Instance data plane console endpoint",
            "type":"string"
        },
        "statusDisplayName":{
            "type":"string",
            "description":"Instance status display name",
            "enum":[
                "Up",
                "PartiallyUp",
                "Down",
                "Unknown",
                "Stopped"
            ]
        }
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

404レスポンス

無効なパラメータ

429レスポンス

リクエストが多すぎます

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors: array errors
  エラーのリスト
• message(必須): string
  判読可能なエラー文字列。
• status(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings: array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

500レスポンス

サービス使用不可

デフォルト・レスポンス

不明なエラー

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors: array errors
  エラーのリスト
• message(必須): string
  判読可能なエラー文字列。
• status(必須): string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings: array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

先頭に戻る

例

このエンドポイントは、Blockchain Platformインスタンスのリストおよびサマリーを取得するために使用されます。

次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行し、Blockchain Platformインスタンスのサマリーおよびリストを問い合せて取得する方法を示します。

curl -X GET \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/93d26463-e4b9-4773-b1c1-9cda2c311b55 \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'
  

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "instances": [
        {
            "id": "93d26463-e4b9-4773-b1c1-9cda2c311b55",
            "displayName": "myNATinstf1",
            "timeCreated": 1566971517441,
            "timeUpdated": 1566972304422,
            "createdBy": "obpuser",
            "createOperationId": "IDR0yB4PWpqjaqTe__iq2c03PIe2H-QCypb3DGyCjCWJE=",
            "platformRole": "Founder",
            "configuration": "Developer",
            "status": "Healthy",
            "lifecycleState": "Active",
            "version": "19.3.2",
            "instanceFQDN": "",
            "enableTLS": true,
            "startPort": 0,
            "stateMessage": "",
            "statusDisplayName": "Up"
        }
    ],
    "summary": {
        "instancesCount": 1,
        "founderCount": 1,
        "participantCount": 0,
        "enterpriseCount": 0,
        "developerCount": 1
    }
}

先頭に戻る