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

Querying Peer Information

Function

This API is used to query the peer details of a specified BCS service.

URI

GET /v2/{project_id}/blockchains/{blockchain_id}/nodes

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

blockchainID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Minimum: 1

Maximum: 32768

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

node_orgs

Map<String,Org>

The key is the organization name and the value is the organization details.
Table 4 Org

Parameter

Type

Description

org_msp_id

String

Organization MSP ID.

org_domain

String

Organization domain name.

peers

Map<String,Node>

The key is the peer name and the value is the peer details.
Table 5 Node

Parameter

Type

Description

ip_port

String

Peer EIP information.

channels

Array of strings

Array of channels to which the peer is added.

Status code: 400

Table 6 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 7 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 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: 404

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

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

Example Requests

None

Example Responses

Status code: 200

Ok

{
  "node_orgs" : {
    "organization" : {
      "org_msp_id" : "328000cb35d8971e0b0388f6182f95eaa4100784MSP",
      "org_domain" : "peer-328000cb35d8971e0b0388f6182f95eaa4100784.default.svc.cluster.local",
      "peers" : {
        "peer-328000cb35d8971e0b0388f6182f95eaa4100784-0" : {
          "channels" : [ "channel" ],
          "ip_port" : "100.93.3.32:30605"
        },
        "peer-328000cb35d8971e0b0388f6182f95eaa4100784-1" : {
          "channels" : [ "channel" ],
          "ip_port" : "100.93.3.32:30606"
        }
      }
    }
  }
}

Status code: 400

Bad Request

{
  "error_code" : "BCS.4006005",
  "error_msg" : "keyType error, keyType: blok not supported"
}

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 Management