Get orderer pod usage

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Get resource (CPU, memory, storage) usage for orderer pods in a blockchain network

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
GET	/networks/{networkId}/orderers/{ordererId}/{containerNo}/usage

Request headers

For headers common to all Blockchain Service APIs, see Common Blockchain Service headers.

Request path parameters

The following describes the parameters.

Field	Type	Required	Description
`networkId`	Long	Required	Network ID Check through Get network list
`ordererId`	String	Required	Orderer ID Check through Get orderer list
`containerNo`	Long	Required	Ncloud Kubernetes Service container number Categorize by the configuration type of the orderer `1` - `5` `1`: `RAFT_1` (single node) `1` - `5`: `RAFT_5` (multiple nodes)

Request query parameters

The following describes the parameters.

Field	Type	Required	Description
`startTime`	Integer	Required	Usage query start time (Unix timestamp) <E.g.> If it's July 30, 2024, 09:00:00, `startTime=1722297600000`
`endTime`	Integer	Required	Usage query end time (Unix timestamp) <E.g.> If it's July 30, 2024, 15:00:00, `startTime=1722319200000`

Request example

The following is a sample request.

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'

Response

The following describes the response format.

Response body

The following describes the response body.

Field	Type	Required	Description
`networkId`	Long	-	Network ID
`nodeId`	String	-	Orderer node ID
`containerNo`	Long	-	Ncloud Kubernetes Service container number Categorize by the configuration type of the orderer `1` - `5` `1`: `RAFT_1` (single node) `1` - `5`: `RAFT_5` (multiple nodes)
`cpuUsage`	Map	-	CPU usage per hour of event occurrence (unit: vCPU) <E.g.> `"cpuUsage": {"1722306600000": 0.0027334264}`
`memUsage`	Map	-	Memory usage per hour of event occurrence (unit: MiB) <E.g.> `"memUsage": {"1722306600000": 7.33438E-14}`
`diskUsage`	Map	-	Storage usage per hour of event occurrence (unit: %) <E.g.> `"diskUsage": {"1722306600000": 0}`

Response status codes

For response status codes common to all Blockchain Service APIs, see Common Blockchain Service response status codes.

Response example

The following is a sample example.

{
    "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
    }
}

Was this article helpful?

What's Next

Get peer list

Table of contents

Request
Response