Help Center/ Blockchain Service/ API Reference/ APIs (Enhanced Hyperledger Fabric)/ BCS Management/ Querying a BCS Service

Updated on 2023-04-26 GMT+08:00

View PDF

Querying a BCS Service

Function

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

URI

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

**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
basic_info	BasicInfo object	BCS service basic information.
channels	Array of ChannelInfo objects	Channel information.
peer_info	Array of PeerInfo objects	Peer organization information.
light_peer_info	Array of PeerInfo objects	light-node organization information.
orderer_info	PeerInfo object	Orderer organization information.
couch_db_info	CouchDBInfo object	Couch DB information.
dms_kafka_info	DmsKafkaInfo object	Creation status of the Kafka instance.
ief_info	IefInfo object	IEF edge cluster information.
sfs_info	SfsInfo object	SFS information.
agent_info	PeerInfo object	agent organization information.
restapi_info	PeerInfo object	restapi organization information.
evs_pvc_info	map<string, object>	evs_pvc information.
tc3_taskserver_info	PeerInfo object	tc3_taskserver organization information.
obs_bucket_info	OBSInfo object	OBS bucket information.

**Table 4** BasicInfo
Parameter	Type	Description
id	String	BCS service ID.
name	String	BCS service name. The name can contain 4 to 24 characters, including letters, digits, and hyphens (-). It cannot start with a hyphen (-).
version	String	BCS service version.
service_type	String	BCS service type. The value can be union or private.
purchase_type	String	Deployment type of the BCS service. The value can be onestep (quick deployment) or normal (normal deployment).
sign_algorithm	String	Security mechanism used by the BCS service. The value can be ECDSA or SM2 (OSCCA-published cryptographic algorithms).
consensus	String	Consensus mechanism of the BCS service. The value can be solo, sflic (FBFT), kafka, or etcdraft.
charging_mode	Long	Billing mode of the BCS service. The value can be 1 (pay-per-use).
version_type	Long	BCS service edition.
database_type	String	Type of the database used by the BCS service. The value can be goleveldb (file database) or couchdb (NoSQL).
cluster_id	String	ID of the cluster where the BCS service is deployed.
cluster_name	String	Name of the cluster where the BCS service is deployed.
cluster_type	String	Type of the cluster where the BCS service is deployed. The value can be CCE (CCE cluster) or ief (IEF cluster).
cluster_az	String	Whether the BCS service is deployed in multiple AZs. The value can be yes (multiple AZs) or no (single AZ).
created_time	String	Time when the BCS service was created.
deploy_type	String	Available for consortium blockchains. The value can be create (inviting party) or invite (invitee).
order_fade_enabled	Boolean	Whether to enable data aging on orderers.
is_cross_region	Boolean	Whether the BCS service is deployed across regions.
is_support_rollback	Boolean	Whether rollback is supported when the BCS service fails to be upgraded.
is_support_restful	Boolean	Whether RESTful APIs are supported by the BCS service. The value can be true (supported) or false (not supported).
is_support_tc3	Boolean	Whether the TC3 add-on is supported. Options: true (supported) or false (not supported).
is_old_service	Boolean	Whether the BCS is an old service. The value can be true (old service) or false (new service).
old_service_version	String	Version of an old BCS service.
agent_portal_addrs	Array of strings	Agent addresses and port numbers on the user data plane of the BCS service.
status	String	BCS service status. The value can be Normal, Abnormal, EipAbnormal, Freeze (frozen), Hibernation (hibernating), or other values (unknown).
process_status	String	BCS service processing status. The value can be IsCreating, IsUpgrading, IsScaling, IsDeleting, or IsAdding (adding peers).
order_status	Long	Order status for a BCS service billed in the yearly/monthly mode. The value can be 0 (the order failed), 1 (the order is abnormal), or 2 (the order is normal).
order_fade_cache	Long	Aging threshold of orderer data.
deploy_status	Integer	BCS service deployment status, which can be 0 (in progress), 1 (successful), 2 (failed), or 3 (finished).
block_info	block_info object	Block generation configurations.
cluster_platform_type	String	Cluster CPU architecture type. The value can be VirtualMachine (x86) or ARM64 (Arm).

**Table 5** block_info
Parameter	Type	Description
batch_timeout	Long	Block generation interval in seconds. The default interval is 2s.
max_message_count	Long	Number of transactions in a block. The default quantity is 500.
preferred_maxbytes	Long	Block size in MB. The default size is 2 MB.

**Table 6** ChannelInfo
Parameter	Type	Description
name	String	Channel name.
org_names	Array of strings	Names of organizations in the channel.
org_name_hash	Array of strings	Hash values of organization names in the channel.
peers	Map<String,Array<String>>	The key is the organization name and value is the peer array.

**Table 7** PeerInfo
Parameter	Type	Description
name	String	Organization name.
node_cnt	Long	Peer quantity.
status	String	Peer status. The value can be IsCreating, IsUpgrading, Adding/IsScaling, Isdeleting, Normal, AbNormal, or Unknown.
status_detail	String	Peer status in the format of 1/1. The denominator is the total number of peers in the organization, and the numerator is the number of normal peers.
pvc_name	String	Name of the PersistenetVolumeClaim (PVC) used by the peer.
address	Array of PeerAddress objects	Peer domain name or IP address.

**Table 8** CouchDBInfo
Parameter	Type	Description
user	String	CouchDB username.

**Table 9** DmsKafkaInfo
Parameter	Type	Description
status	String	Status.
status_detail	String	Status details.
order_fade_enabled	Boolean	Whether to enable data aging on orderers.
addr	Array of strings	Kafka connection addresses.
order_fade_enable	Boolean	Whether data aging on orderers is enabled if Kafka is used.
order_fade_cache	Long	Aging threshold (if data aging on orderers is enabled).

**Table 10** IefInfo
Parameter	Type	Description
deploy_mode	Long	Organization-node relationship in edge cluster deployment mode. The value can be 0 (randomly matched) or 1 (bound).

**Table 11** SfsInfo
Parameter	Type	Description
pvc_name	String	Name of the SFS file system.
name	String	Network storage name.
addr	String	Network storage address.
type	String	Network storage type.

**Table 12** PeerAddress
Parameter	Type	Description
domain_port	String	Domain name address.
ip_port	String	IP address.

**Table 13** OBSInfo
Parameter	Type	Description
name	String	OBS bucket name.
addr	String	OBS bucket address.

Status code: 400

**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

Status code: 401

**Table 15** 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 16** 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 17** 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 18** 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

{
  "basic_info" : {
    "id" : "50ca216f-f0e5-ea05-5aee-de8d8f0fb6fa",
    "name" : "bcs-vqf1x5",
    "version" : "3.0.7",
    "service_type" : "union",
    "purchase_type" : "",
    "sign_algorithm" : "ECDSA",
    "consensus" : "sflic",
    "charging_mode" : 1,
    "version_type" : 3,
    "database_type" : "goleveldb",
    "cluster_id" : "aaace2ac-c18b-11ea-aefb-0255ac100022",
    "cluster_name" : "roma-cluster",
    "cluster_type" : "",
    "cluster_platform_type" : "",
    "cluster_az" : "",
    "created_time" : "2020-07-22T04:03:44Z",
    "deploy_type" : "",
    "order_fade_enabled" : false,
    "order_fade_cache" : 0,
    "is_cross_region" : false,
    "is_support_rollback" : false,
    "is_support_restful" : false,
    "is_old_service" : false,
    "old_service_version" : "",
    "agent_portal_addrs" : [ "24.68.213.148:30603" ],
    "status" : "Normal",
    "process_status" : "",
    "order_status" : 0,
    "deploy_status" : 0,
    "block_info" : {
      "batch_timeout" : 2,
      "max_message_count" : 500,
      "preferred_maxbytes" : 2
    },
    "is_support_tc3" : false
  },
  "channels" : [ {
    "name" : "channel",
    "org_names" : [ "organization" ],
    "org_name_hash" : [ "organization:8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d" ],
    "peers" : {
      "8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d" : [ "peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d-0.peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d.default.svc.cluster.local", "peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d-1.peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d.default.svc.cluster.local" ]
    }
  } ],
  "peer_info" : [ {
    "name" : "organization",
    "node_cnt" : 2,
    "status" : "Normal",
    "status_detail" : "2/2",
    "pvc_name" : ""
  } ],
  "light_peer_info" : [ ],
  "orderer_info" : {
    "name" : "bcs-vqf1x5-orderer",
    "node_cnt" : 4,
    "status" : "Normal",
    "status_detail" : "4/4",
    "address" : [ {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-0.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30835"
    }, {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-1.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30836"
    }, {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-2.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30837"
    }, {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-3.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30838"
    } ],
    "pvc_name" : ""
  },
  "couch_db_info" : {
    "user" : ""
  },
  "dms_kafka_info" : {
    "order_fade_enable" : false,
    "order_fade_cache" : 0,
    "status" : "",
    "status_detail" : ""
  },
  "ief_info" : {
    "deploy_mode" : 0
  },
  "sfs_info" : {
    "pvc_name" : "",
    "name" : "",
    "addr" : "",
    "type" : "host"
  },
  "agent_info" : {
    "name" : "baas-agent",
    "node_cnt" : 0,
    "status" : "Normal",
    "status_detail" : "1/1",
    "pvc_name" : ""
  },
  "restapi_info" : {
    "name" : "",
    "node_cnt" : 0,
    "status" : "",
    "status_detail" : "",
    "pvc_name" : ""
  },
  "tc3_taskserver_info" : {
    "name" : "",
    "node_cnt" : 0,
    "status" : "",
    "status_detail" : "",
    "pvc_name" : ""
  },
  "obs_bucket_info" : {
    "name" : "",
    "addr" : ""
  }
}

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

Previous topic: Querying Creation Status of a BCS Service

Next topic: Modifying a BCS Service

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot