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

Listing Consortium Members

Function

Listing Consortium Members

URI

GET /v2/{project_id}/members

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token.

Minimum: 1

Maximum: 32768

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

members

Array of Member objects

Consortium member list.
Table 4 Member

Parameter

Type

Description

tcs_need

Boolean

Whether trusted computing is enabled.

channel_name

String

Channel name.

invited_orgs

Array of OrganizationV2 objects

Invitee's organizations.

invitor_info

MemberInvitor object

Inviting party information.

invitee_info

MemberInvitee object

Invitee information.
Table 5 OrganizationV2

Parameter

Type

Description

name

String

Organization name.

name_hash

String

Hash value of the organization name.

node_count

Integer

Peers in the organization.

status

String

Status.

status_detail

String

Status description.
Table 6 MemberInvitor

Parameter

Type

Description

invitor_bcs_id

String

BCS service ID of the inviting party.

invitor_bcs_name

String

BCS service name of the inviting party.

invitor_project_id

String

Project ID of the inviting party.

invitor_user_id

String

ID of the inviting party.

invitor_username

String

Tenant name of the inviting party.
Table 7 MemberInvitee

Parameter

Type

Description

invitee_bcs_id

String

BCS service ID of the invitee.

invitee_user_id

String

Tenant ID of the invitee.

invitee_username

String

Name of the invitee.

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

None

Example Responses

Status code: 200

Ok

{
  "members" : [ {
    "tcs_need" : true,
    "channel_name" : "channel",
    "invited_orgs" : [ {
      "name" : "organization",
      "name_hash" : "25df6ee3d460a5daf6e11e6c5d945a43cda011fd",
      "node_count" : 1,
      "status" : "",
      "status_detail" : ""
    } ],
    "invitor_info" : {
      "invitor_bcs_id" : "b268e1ca-b5c2-28f1-1e57-f571e14ecdbd",
      "invitor_bcs_name" : "bcs-invitor",
      "invitor_project_id" : "051ddda57400d2982fccc014fab5749d",
      "invitor_user_id" : "28839632c7954c6380e59a4d416a60ee",
      "invitor_username" : "test01"
    },
    "invitee_info" : {
      "invitee_bcs_id" : "05c0705f-2520-ff0f-3ae2-a48e7e3c8936",
      "invitee_user_id" : "37556632c7954c6380e56c2e366a75se",
      "invitee_username" : "test02"
    }
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "BCS.4006014",
  "error_msg" : "Invalid Parameter quotasType : ecs"
}

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 Consortium