DescribeFabricConsortiumDeletable - Blockchain as a Service

You can call this operation to query whether a consortium can be deleted.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeFabricConsortiumDeletable	The operation that you want to perform. Set the value to DescribeFabricConsortiumDeletable.
ConsortiumId	String	Yes	consortium-lianmenyumingyi-hc5d1bwl****	The ID of the consortium.
Location	String	No	cn-hangzhou	The location.

Response parameters

Parameter	Type	Example	Description
ErrorCode	Integer	200	The error code.
RequestId	String	1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3	The ID of the API request.
Result			The result list of the operation.
CodeName	String	codename	The prefix of the domain name.
ConsortiumId	String	consortium-lianmenyumingyi-hc5d1bwlulg7	The ID of the consortium.
ConsortiumName	String	myconsortium	The name of the consortium.
Deletable	Boolean	true	Indicates whether the consortium can be deleted.
Description	String	description	The description.
Domain	String	domain	The domain name.
RegionId	String	cn-hangzhou	The ID of the region.
State	String	Running	The status.
ZoneId	String	cn-hangzhou	The available zone.
Success	Boolean	true	Indicates whether the call is successful. A value of true indicates that the call is successful. A value of false indicates that the call has failed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeFabricConsortiumDeletable
&ConsortiumId=consortium-lianmenyumingyi-hc5d1bwl****
&Location=cn-hangzhou
&<Common request parameters>

Successful response examples

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFabricConsortiumDeletableResponse>
    <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
    <Success>true</Success>
    <ErrorCode>200</ErrorCode>
    <Result>
        <Deletable>true</Deletable>
        <Domain>domain</Domain>
        <Description>description</Description>
        <ConsortiumId>consortium-lianmenyumingyi-hc5d1bwl****</ConsortiumId>
        <State>Running</State>
        <ZoneId>cn-hangzhou</ZoneId>
        <CodeName>codename</CodeName>
        <ConsortiumName>myconsortium</ConsortiumName>
        <RegionId>cn-hangzhou</RegionId>
    </Result>
</DescribeFabricConsortiumDeletableResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
  "Success" : true,
  "ErrorCode" : 200,
  "Result" : {
    "Deletable" : true,
    "Domain" : "domain",
    "Description" : "description",
    "ConsortiumId" : "consortium-lianmenyumingyi-hc5d1bwl****",
    "State" : "Running",
    "ZoneId" : "cn-hangzhou",
    "CodeName" : "codename",
    "ConsortiumName" : "myconsortium",
    "RegionId" : "cn-hangzhou"
  }
}

Error codes

For more information about error codes, see Error codes.