Updated on 2023-06-20 GMT+08:00

API Overview

You can call APIs to use the functions provided by BCS, including creating and deleting BCS services, and forming consortium blockchains. Table 1 lists the APIs.

Table 1 API Overview

Category

API

Description

BCS Management

Creating a BCS Service

Creates a BCS service.

Querying Creation Status of a BCS Service

Queries the creation status of a specified BCS service.

Querying Service Information

Queries the details of a specified BCS service.

Modifying a BCS Service

Modifies the peers and organizations of a BCS service.

Creating Channels

Creates channels.

Querying Channel Information

Queries the channel details of a specified BCS service.

Adding Peers to a Channel

Adds peers to a channel.

Removing Organizations from a Channel

Removes organizations from a channel.

Downloading Certificates

Downloads the certificates of a specified BCS service.

Downloading the SDK Configuration

Downloads the SDK configuration of a specified BCS service.

Generating a User Certificate

Generates a user certificate for a specific service.

Unfreezing a User Certificate

Unfreezes a user certificate for a specific BCS service. It takes 0.5 minutes to 1 minute for the unfreezing to take effect.

Freezing a User Certificate

Freezes a user certificate for a specific BCS service. It takes 0.5 minutes to 1 minute for the freezing to take effect.

Querying Quotas

Queries the quotas of all BCS service resources under the specified project.

Querying Flavors

Queries the basic information of all BCS services under the specified project.

Querying Peer Information

Queries the peer details of a specified BCS service.

Querying Asynchronous Operation Results

Queries the asynchronous operation results.

Querying the BCS Service List

Queries the basic information of all BCS services under the specified project.

Deleting a BCS Service

Deletes a BCS service.

Removing a Peer from a Channel

Removes a peer from a channel.

Deleting a Channel

Deletes a channel.

BCS Consortium

Inviting Tenants to Join a Consortium

Invites multiple tenants in batches to join a channel. Invitation notifications will be sent to the invited tenants.

Processing an Invitation

Processes an invitation to join a consortium.

Querying All Notifications

Queries all notifications.

Listing Consortium Members

Lists all members in a consortium.

Deleting Invitation Information

Cancels invitations in batches or delete invitation information about members who have quit, rejected to join, or dismissed.

Exiting a Consortium

Exits a consortium.

BCS Monitoring

Querying BCS Alarms

Queries the monitoring data of a specified metric of a BCS service.

Querying BCS Alarm Statistics

Queries the alarm statistics of a specified metric of a BCS service.

Querying Monitoring Data of a BCS Service

Queries the monitoring data of a specified metric of a BCS service.

Listing Entity Monitoring Data of a BCS Service

Queries the monitoring data list of entities of a BCS service.

Querying Entity Monitoring Details of a BCS Service

Queries the monitoring details of entities of a specified BCS service.