移動

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

ブロックのデータのリストの取得

get

/console/admin/api/v2/channels/{channelName}/blocks

チャネル名、ブロックIDの範囲および時間範囲を使用して、トランザクション、デプロイメント、呼出しなど、チャネルのブロック範囲のブロックのデータのリストを取得できます。

• 時間範囲とID範囲は同時に有効にできません。
• ID範囲を指定した場合、時間範囲は有効になりません。
• このAPIは、最大1000ブロックのデータを返します。
• パラメータを指定しない場合、最新の1000ブロックが返されます。
• fromId (since)のみを入力とした場合、toId (until)はデフォルトで現在のレジャーの高さに設定されます。
• toId (until)のみを入力とした場合、fromId (since)はデフォルトで0に設定されます。
• 問合せ範囲がこの値を超えている場合、エラー・メッセージが返されます。

リクエスト

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

• application/json

パス・パラメータ

• channelName(必須): string
  チャネル名

問合せパラメータ

• fromId: number
  選択したブロック範囲の開始ID
• since: string
  YYYYMMDDHHmmSS形式の選択したブロック範囲の開始UTC時間
• toId: number
  選択したブロック範囲の終了ID
• until: string
  YYYYMMDDHHmmSS形式の選択したブロック範囲の終了UTC時間

先頭に戻る

レスポンス

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

• application/json

200レスポンス

ブロック統計情報が正常に取得されました

本文()

ルート・スキーマ: blockStatistic

型: object

ソースの表示

• activities: array activities
• blocks: array blocks
• overview: object overview

{
    "type":"object",
    "properties":{
        "overview":{
            "type":"object",
            "properties":{
                "blocks":{
                    "type":"number"
                },
                "blockSpeed":{
                    "type":"number"
                },
                "transactionActivity":{
                    "type":"number"
                },
                "deployment":{
                    "type":"number"
                },
                "invokes":{
                    "type":"number"
                }
            }
        },
        "activities":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "number":{
                        "type":"string"
                    },
                    "deploy":{
                        "type":"string"
                    },
                    "invoke":{
                        "type":"number"
                    }
                }
            }
        },
        "blocks":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "header":{
                        "type":"object"
                    },
                    "data":{
                        "type":"object"
                    }
                }
            }
        }
    }
}

ネストしたスキーマ: activities

型: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "number":{
                "type":"string"
            },
            "deploy":{
                "type":"string"
            },
            "invoke":{
                "type":"number"
            }
        }
    }
}

ネストしたスキーマ: blocks

型: array

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "header":{
                "type":"object"
            },
            "data":{
                "type":"object"
            }
        }
    }
}

ネストしたスキーマ: overview

型: object

ソースの表示

• blocks: number
• blockSpeed: number
• deployment: number
• invokes: number
• transactionActivity: number

{
    "type":"object",
    "properties":{
        "blocks":{
            "type":"number"
        },
        "blockSpeed":{
            "type":"number"
        },
        "transactionActivity":{
            "type":"number"
        },
        "deployment":{
            "type":"number"
        },
        "invokes":{
            "type":"number"
        }
    }
}

ネストしたスキーマ: items

型: object

ソースの表示

• deploy: string
• invoke: number
• number: string

{
    "type":"object",
    "properties":{
        "number":{
            "type":"string"
        },
        "deploy":{
            "type":"string"
        },
        "invoke":{
            "type":"number"
        }
    }
}

ネストしたスキーマ: items

型: object

ソースの表示

• data: object data
• header: object header

{
    "type":"object",
    "properties":{
        "header":{
            "type":"object"
        },
        "data":{
            "type":"object"
        }
    }
}

ネストしたスキーマ: data

型: object

ネストしたスキーマ: header

型: object

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: 500errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: errorModel

型: object

ソースの表示

• code(必須): integer(int32)
• message(必須): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る