Help Center/ Blockchain Service/ API Reference/ APIs (Enhanced Hyperledger Fabric)/ BCS Monitoring/ Querying BCS Monitoring Data
Updated on 2023-04-26 GMT+08:00
View PDF
Share

Querying BCS Monitoring Data

Function

This API is used to query the monitoring data of a specified metric of a BCS service.

URI

POST /v2/{project_id}/blockchains/{blockchain_id}/metric/list

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

blockchain_id

Yes

String

BCS service ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. You can obtain the token by calling the IAM API used to obtain a user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

metric_names

No

Array of strings

Metrics. Value range: cpuUsage: CPU usage** diskUsedRate**: disk usage memUsedRate: physical memory usage sendBytesRate: uplink rate (byte/s) recvBytesRate: downlink rate (byte/s) cpuCoreLimit: total CPU cores cpuCoreUsed: used CPU cores totalMem: total physical memory freeMem: available physical memory diskCapacity: disk capacity diskAvailableCapacity: available disk space Default value: the first five metrics.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

metrics

Array of MetricItemResultAPI objects

Request result.
Table 5 MetricItemResultAPI

Parameter

Type

Description

metric

MetricDemision object

Operation record ID.

dataPoints

Array of MetricDataPoints objects

Basic information of the monitoring data.
Table 6 MetricDemision

Parameter

Type

Description

namespace

String

Namespace.

metricName

String

Metric name.

dimensions

Array of Dimension objects

Dimension list.
Table 7 Dimension

Parameter

Type

Description

name

String

Dimension name.

value

String

Dimension value.
Table 8 MetricDataPoints

Parameter

Type

Description

timestamp

Long

Timestamp.

unit

String

Metric unit.

statistics

Array of StatisticValue objects

Statistical method.
Table 9 StatisticValue

Parameter

Type

Description

statistic

String

Statistical method.

value

Double

Statistics.

Status code: 400

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 401

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 403

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 404

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Status code: 500

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 8

Maximum: 36

error_msg

String

Error message.

Minimum: 2

Maximum: 512

Example Requests

{
  "metric_names" : [ "cpuUsage", "diskUsedRate" ]
}

Example Responses

Status code: 200

Ok

{
  "metrics" : [ {
    "metric" : {
      "namespace" : "abc",
      "metricName" : "def",
      "dimensions" : [ {
        "name" : "ghi",
        "value" : "lmn"
      } ]
    },
    "dataPoints" : [ {
      "timestamp" : "1467892800000",
      "unit" : "Percent",
      "statistics" : [ {
        "statistic" : "maximum",
        "value" : "23"
      } ]
    } ]
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "BCS.4001108",
  "error_msg" : "metric names is wrong"
}

Status code: 401

Unauthorized

{
  "error_code" : "BCS.4010401",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "BCS.4030403",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "BCS.4040404",
  "error_msg" : "Not Found:the url is not found"
}

Status code: 500

InternalServerError

{
  "error_code" : "BCS.5000500",
  "error_msg" : "Internal Server Error"
}

Status Codes

Status Code

Description

200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

InternalServerError

Error Codes

See Error Codes.

Parent topic: BCS Monitoring