Help Center/ Blockchain Service/ API Reference/ APIs (Enhanced Hyperledger Fabric)/ BCS Management/ Deleting a BCS Service
Updated on 2023-06-20 GMT+08:00
View PDF

Deleting a BCS Service

Function

This API is used to delete a BCS service. This API is not supported for BCS services billed on a yearly/monthly basis.

URI

DELETE /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

BCS service ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

is_delete_storage

No

Boolean

is_delete_obs

No

Boolean

is_delete_resource

No

Boolean

Whether to delete underlying CCE resources. This parameter is not required if the BCS service is deployed using IEF.

is_delete_ief

No

Boolean

Specifies whether to delete the underlying IEF edge nodes. This field is optional in CCE mode and mandatory in IEF mode.

is_delete_lightpeer

No

String

Optional in CCE mode. This parameter specifies whether to delete the IEF edge nodes used by the LightPeer add-on. To delete them, enter the corresponding edge node name. For example: is_delete_lightpeer=ief_node_name_1,ief_node_name_2.

ief_nodes_id

No

String

Optional in IEF mode. This parameter specifies whether to delete the IEF edge nodes used by edge clusters. To delete them, enter the edge node ID. For example: ief_nodes_id=1356f6f0-c448-4ec2-926f-c13b026369d9, 0cdacbf9-2002-41e9-8123-2fa13e8d1449.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Account token.

Minimum: 1

Maximum: 32768

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

operation_id

String

Request result.

Status code: 400

Table 5 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 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: 403

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

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

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

Example Requests

None

Example Responses

Status code: 200

Ok

{
  "operation_id" : "BCSSVC01-03-1617158790255323683"
}

Status code: 400

Bad Request

{
  "error_code" : "BCS.4006014",
  "error_msg" : "Invalid Parameter is_delete_obs ,must be true or false"
}

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