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

Querying Creation Status of a BCS Service

Function

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

URI

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

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

bcs

Detail object

Creation status of the BCS service.

eip

Detail object

Creation status of the EIP.

sfs

Detail object

Creation status of the SFS file system.

obs

Detail object

Creation status of OBS storage.

kafka

Detail object

Creation status of the Kafka instance.

cce

ComCCE object

Creation status of CCE resources.
Table 4 ComCCE

Parameter

Type

Description

cluster

Detail object

Creation status of the CCE cluster.

network

Detail object

Creation status of the CCE network.

security_group

Detail object

Creation status of the CCE security group.
Table 5 Detail

Parameter

Type

Description

start_time

String

Start time.

end_time

String

End time.

status

String

Status.

Enumeration values:

  • waiting

  • deploying

  • finished

  • failed

detail

String

Details.

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

{
  "bcs" : {
    "start_time" : "2020-10-15T18:24:48.658236618+08:00",
    "end_time" : "2020-10-15T18:25:53.552512674+08:00",
    "status" : "finished",
    "detail" : ""
  },
  "eip" : {
    "start_time" : "2020-10-15T18:24:31.957780831+08:00",
    "end_time" : "2020-10-15T18:24:33.810699517+08:00",
    "status" : "finished",
    "detail" : ""
  },
  "sfs" : {
    "start_time" : "2020-10-15T18:24:31.957781285+08:00",
    "end_time" : "2020-10-15T18:24:48.611812564+08:00",
    "status" : "finished",
    "detail" : ""
  }
}

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