Orderer Pod使用量の照会

Prev Next

VPC環境で利用できます。

ブロックチェーンネットワーク内 Orderer Podのリソース(CPU、Memory、Storage)使用量を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /networks/{networkId}/orderers/{ordererId}/{containerNo}/usage

リクエストヘッダ

Blockchain Service APIで共通して使用されるヘッダの詳細は、Blockchain Serviceの共通ヘッダをご参照ください。

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
networkId Long Required ネットワーク ID
ordererId String Required Orderer ID
containerNo Long Required Ncloud Kubernetes Serviceコンテナ番号
  • Ordererの構成タイプによる分類
  • 1~5
    • 1: RAFT_1(単一ノード)
    • 1~5: RAFT_5(マルチノード)

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
startTime Integer Required 使用量照会開始時刻(Unix Timestamp)
  • <例> 2024年07月30日09時00分00秒の場合、startTime=1722297600000
endTime Integer Required 使用量照会終了時刻(Unix Timestamp)
  • <例> 2024年07月30日15時00分00秒の場合、endTime=1722319200000

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://blockchainservice.apigw.ntruss.com/api/v1/networks/{networkId}/orderers/{ordererId}/{containerNo}/usage?startTime=1722297600000&endTime=1722319200000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
networkId Long - ネットワーク ID
nodeId String - Ordererノード ID
containerNo Long - Ncloud Kubernetes Serviceコンテナ番号
  • Ordererの構成タイプによる分類
  • 1~5
    • 1: RAFT_1(単一ノード)
    • 1~5: RAFT_5(マルチノード)
cpuUsage Map - イベント発生時間ごとの CPU使用量(単位: vCPU)
  • <例> "cpuUsage": {"1722306600000": 0.0027334264}
memUsage Map - イベント発生時間ごとの Memory使用量(単位: MiB)
  • <例> "memUsage": {"1722306600000": 14}
diskUsage Map - イベント発生時間ごとの Storage使用量(単位: %)
  • <例> "diskUsage": {"1722306600000": 0}

レスポンスステータスコード

Blockchain Service APIで共通して使用されるレスポンスステータスコードの詳細は、Blockchain Serviceの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "networkId": 1630,
    "nodeId": "25728701",
    "containerNo": 1,
    "cpuUsage": {
        "1722306600000": 0.0027334264,
        "1722308400000": 0.0025221796,
        "1722313800000": 0.0025501417,
        "1722304800000": 0.002683841,
        "1722299400000": 0.002278521,
        "1722301200000": 0.0023474433,
        "1722312000000": 0.0027172305,
        "1722297600000": 0.0023242563,
        "1722303000000": 0.002385926,
        "1722310200000": 0.0028314379
    },
    "memUsage": {
        "1722306600000": 14,
        "1722308400000": 15,
        "1722313800000": 15,
        "1722304800000": 14,
        "1722299400000": 14,
        "1722301200000": 14,
        "1722312000000": 15,
        "1722297600000": 15,
        "1722303000000": 14,
        "1722310200000": 15
    },
    "diskUsage": {
        "1722306600000": 0,
        "1722308400000": 0,
        "1722313800000": 0,
        "1722304800000": 0,
        "1722299400000": 0,
        "1722301200000": 0,
        "1722312000000": 0,
        "1722297600000": 0,
        "1722303000000": 0,
        "1722310200000": 0
    }
}