移動

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

インスタンスの操作ステータスの取得

get

/api/v1/blockchainPlatforms/instances/{id}/operation/{opid}/status

Blockchain Platformインスタンスの操作ステータスを取得します。

リクエスト

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

• application/json

パス・パラメータ

• id: string
  プラットフォーム・インスタンスの一意の識別子
• opid: string
  問い合せる操作ID

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: OperationStatus

型: object

ソースの表示

• details(オプション): string
  例: ステップの情報、失敗の理由
• instanceId(オプション): string
  インスタンスID
• operation(オプション): string
  許容値: [ "create", "delete", "start", "stop", "update", "patch", "scaleout", "scalein" ]

  操作の問合せ
• operationId(オプション): string
  操作のID
• status(オプション): string
  許容値: [ "norecord", "inprogress", "failed", "successful", "successfulwitherrors", "unknown" ]

  削除の場合、成功すると404が返されます。

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Instance ID"
        },
        "operationId":{
            "type":"string",
            "description":"Operation ID"
        },
        "operation":{
            "type":"string",
            "description":"Operation querying",
            "enum":[
                "create",
                "delete",
                "start",
                "stop",
                "update",
                "patch",
                "scaleout",
                "scalein"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "norecord",
                "inprogress",
                "failed",
                "successful",
                "successfulwitherrors",
                "unknown"
            ],
            "description":"For delete, 404 will be returned after it succeeds."
        },
        "details":{
            "type":"string",
            "description":"e.g. step info, fail reason"
        }
    }
}

401レスポンス

未認可

本文()

ルート・スキーマ: 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"
    }
}

404レスポンス

見つかりません

本文()

ルート・スキーマ: 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/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/operation/IDpJPaezDL9_7zTlfY2ti-LlxB7kW8hCoz5lZPQCv8Cr4=/status \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json' \
  

レスポンス本文の例

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

{
  "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
  "operation": "create",
  "status": "successful",
  "details": "",
  "operationId": "IDpJPaezDL9_7zTlfY2ti-LlxB7kW8hCoz5lZPQCv8Cr4="
}

先頭に戻る