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

Listing Entity Monitoring Data of a BCS Service

Function

This API is used to query the monitoring data list of entities of a BCS service.

URI

POST /v2/{project_id}/blockchains/{blockchain_id}/entity/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

type

Yes

String

Entity type. Options: org (peer organization) plugin (add-on) Default value: org.

entity_name

No

String

Entity name.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

metrics

Array of EntityMetricList objects

Request result.
Table 5 EntityMetricList

Parameter

Type

Description

dimensions

Array of Dimension objects

Request result.

values

Array of EntityMetricListItem objects

Monitoring data list.
Table 6 Dimension

Parameter

Type

Description

name

String

Dimension name.

value

String

Dimension value.
Table 7 EntityMetricListItem

Parameter

Type

Description

cpuUsage

String

CPU usage.

diskReadRate

String

Disk read rate.

diskWriteRate

String

Disk write rate.

memUsage

String

Physical memory usage.

recvBytesRate

String

Downlink rate (bps).

sendBytesRate

String

Uplink rate (bps).

filesystemUsage

String

File system usage.

Status code: 400

Table 8 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 9 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 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: 404

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: 500

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

Example Requests

{
  "type" : "org",
  "entity_name" : "baas-agent"
}

Example Responses

Status code: 200

Ok

{
  "metrics" : [ {
    "dimensions" : [ {
      "name" : "cluster",
      "value" : "abc"
    } ],
    "values" : [ {
      "cpuUsage" : 0.175,
      "diskReadRate" : 0,
      "diskWriteRate" : 0,
      "memUsage" : 1.252,
      "recvBytesRate" : 1703.617,
      "sendBytesRate" : 2438.85,
      "filesystemUsage" : 9.344
    } ]
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "BCS.4004024",
  "error_msg" : "invalid org name input"
}

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