移動

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

すべてのアクティビティ詳細の取得

get

/api/v1/blockchainPlatforms/activities

すべてのインスタンスのアクティビティ詳細を取得します。

リクエスト

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

• application/json

問合せパラメータ

• fromDate: string
  yyyy-MM-dd形式での日付範囲検索基準の下限
• instanceNameText: string
  検索基準として使用されるインスタンス名テキスト
• operations: string
  アクティビティを取得する操作タイプのカンマ区切りリスト
• toDate: string
  yyyy-MM-dd形式での日付範囲検索基準の上限

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: InstanceActivityInfoSummary

型: object

Blockchain Platformインスタンスのアクティビティ

ソースの表示

• activities(オプション): array activities
  Blockchain Platformインスタンスに関連付けられたアクティビティをリストします

{
    "description":"Activities for a Blockchain Platform Instance",
    "type":"object",
    "properties":{
        "activities":{
            "description":"List activities associated with a blockchain platform instance",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActivityInfoSummary"
            }
        }
    }
}

ネストしたスキーマ: activities

型: array

Blockchain Platformインスタンスに関連付けられたアクティビティをリストします

ソースの表示

• 配列: object ActivityInfoSummary

{
    "description":"List activities associated with a blockchain platform instance",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ActivityInfoSummary"
    }
}

ネストしたスキーマ: ActivityInfoSummary

型: object

ソースの表示

• details(オプション): string
  操作の最新ステータスからの詳細メッセージ
• initiatedBy(オプション): string
  アクティビティを開始したユーザー
• instanceId(オプション): string
  PlatformインスタンスID
• instanceName(オプション): string
  Platformインスタンスの名前
• lastUpdatedTime(オプション): string(date-time)
  操作ステータスが追跡された最新時刻
• operation(オプション): string
  操作名
• operationId(オプション): string
  操作のID
• operationStartTime(オプション): string(date-time)
  操作が開始された時間
• operationStatus(オプション): string
  操作のステータス

{
    "type":"object",
    "properties":{
        "instanceId":{
            "type":"string",
            "description":"Platform instance ID"
        },
        "instanceName":{
            "type":"string",
            "description":"Name of the platform instance"
        },
        "operation":{
            "type":"string",
            "description":"Operation name"
        },
        "operationId":{
            "type":"string",
            "description":"Operation ID"
        },
        "operationStatus":{
            "type":"string",
            "description":"Operation status"
        },
        "operationStartTime":{
            "type":"string",
            "format":"date-time",
            "description":"Time when the operation started"
        },
        "lastUpdatedTime":{
            "type":"string",
            "format":"date-time",
            "description":"Most recent time when the operation status was tracked"
        },
        "initiatedBy":{
            "type":"string",
            "description":"User who initiated the activity"
        },
        "details":{
            "type":"string",
            "description":"Detailed message from the latest status of the operation"
        }
    }
}

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インスタンスで実行されたすべてのアクティビティの詳細を取得するために使用されます。

次の例は、Blockchain Platformインスタンスで実行されたすべてのアクティビティの詳細を問い合せて取得する方法を示しています。

curl -X GET \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/activities \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json' \
  

レスポンス本文の例

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

{
  "activities": [
    {
      "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
      "instanceName": "myNATinstf1",
      "operation": "Scaleout",
      "operationId": "IDxp769lEAPEz7Ch2ntj94P0-xeFubY87wh3dQzr88k1Q=",
      "operationStatus": "successful",
      "operationStartTime": 1567562162133,
      "lastUpdatedTime": 1567562238677,
      "initiatedBy": "obpuser",
      "details": "Operation successful."
    },
    {
      "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
      "instanceName": "myinstance",
      "operation": "Scalein",
      "operationId": "IDxUl_j7o3Ayqi6wJfNBpBpDrijePWoXgwy9pljmqkZ_k=",
      "operationStatus": "successful",
      "operationStartTime": 1567559363488,
      "lastUpdatedTime": 1567559428821,
      "initiatedBy": "obpuser",
      "details": "Operation successful."
    },
    {
      "instanceId": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf99",
      "instanceName": "myinstance",
      "operation": "Create",
      "operationId": "IDGacTFUlm0wfhjpkYP2inLAhcJrO8D2muFAHMJT9HiOg=",
      "operationStatus": "successful",
      "operationStartTime": 1567556931932,
      "lastUpdatedTime": 1567557797289,
      "initiatedBy": "obpuser",
      "details": "Operation successful."
    }
  ]
}

先頭に戻る