DescribeFabricConsortiumChannels - Blockchain as a Service

You can call this operation to query the channels of a consortium.

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	DescribeFabricConsortiumChannels	The operation that you want to perform. Set the value to DescribeFabricConsortiumChannels.
ConsortiumId	String	Yes	consortium-lianmenyumingyi-hc5d1bwlulg7	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 channels of the consortium.
BatchTimeout	Integer	2	The amount of time to wait after the first transaction arrives for additional transactions before cutting a block.
BlockCount	Integer	2	The number of blocks.
ChaincodeCount	Integer	2	The number of chaincodes.
ChannelId	String	chan-channelx-1l1hmckuuisxo	The ID of the channel.
ChannelName	String	mychammel	The name of the channel.
ConsortiumChannelId	Integer	1	The sequence of the channel in the consortium.
ConsortiumId	String	consortium-lianmenyumingyi-hc5d1bwlulg7	The ID of the consortium.
ConsortiumName	String	name	The name of the consortium.
CreateTime	String	1544411108000	The creation time.
DeleteTime	String	1544411108000	The time when the channel was deleted.
Deleted	Boolean	true	Indicates whether the channel is deleted.
MaxMessageCount	Integer	200	The maximum number of transactions that are permitted in a block.
MemberCount	Integer	3	The number of channel members.
MemberJoinedCount	String	3	The number of members who have joined the consortium.
NeedJoined	Boolean	true	Indicates whether to join the channel.
OwnerBid	String	26842	The business ID of the creator.
OwnerName	String	uid-*	The creator.
OwnerUid	Integer	212	The user ID of the creator.
PreferredMaxBytes	Integer	102410241	The preferred maximum number of bytes allowed for.
RequestId	String	1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3	The ID of the API request.
State	String	Running	The status.
SupportChannelConfig	Boolean	true	Indicates whether custom parameters are supported.
UpdateTime	String	1544411108000	The time when the channel was last updated.
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=DescribeFabricConsortiumChannels
&ConsortiumId=consortium-lianmenyumingyi-hc5d1bwl****
&Location=cn-hangzhou
&<Common request parameters>

Successful response examples

XML format

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

<DescribeFabricConsortiumChannelsResponse>
    <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
    <Success>true</Success>
    <ErrorCode>200</ErrorCode>
    <Result>
        <BatchTimeout>2</BatchTimeout>
        <UpdateTime>1544411108000</UpdateTime>
        <ChaincodeCount>2</ChaincodeCount>
        <PreferredMaxBytes>102410241</PreferredMaxBytes>
        <MemberJoinedCount>3</MemberJoinedCount>
        <State>Running</State>
        <CreateTime>1544411108000</CreateTime>
        <SupportChannelConfig>true</SupportChannelConfig>
        <OwnerName>uid-*</OwnerName>
        <OwnerUid>212</OwnerUid>
        <OwnerBid>26842</OwnerBid>
        <MaxMessageCount>200</MaxMessageCount>
        <MemberCount>3</MemberCount>
        <NeedJoined>true</NeedJoined>
        <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
        <ConsortiumId>consortium-lianmenyumingyi-hc5d1bwl****</ConsortiumId>
        <ChannelName>mychammel</ChannelName>
        <DeleteTime>1544411108000</DeleteTime>
        <ChannelId>chan-channelx-1l1hmckuuisxo</ChannelId>
        <ConsortiumChannelId>1</ConsortiumChannelId>
        <Deleted>true</Deleted>
        <ConsortiumName>name</ConsortiumName>
        <BlockCount>2</BlockCount>
    </Result>
</DescribeFabricConsortiumChannelsResponse>

JSON format

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

{
  "RequestId" : "1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
  "Success" : true,
  "ErrorCode" : 200,
  "Result" : [ {
    "BatchTimeout" : 2,
    "UpdateTime" : "1544411108000",
    "ChaincodeCount" : 2,
    "PreferredMaxBytes" : 102410241,
    "MemberJoinedCount" : "3",
    "State" : "Running",
    "CreateTime" : "1544411108000",
    "SupportChannelConfig" : true,
    "OwnerName" : "uid-*",
    "OwnerUid" : 212,
    "OwnerBid" : "26842",
    "MaxMessageCount" : 200,
    "MemberCount" : 3,
    "NeedJoined" : true,
    "RequestId" : "1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
    "ConsortiumId" : "consortium-lianmenyumingyi-hc5d1bwl****",
    "ChannelName" : "mychammel",
    "DeleteTime" : "1544411108000",
    "ChannelId" : "chan-channelx-1l1hmckuuisxo",
    "ConsortiumChannelId" : 1,
    "Deleted" : true,
    "ConsortiumName" : "name",
    "BlockCount" : 2
  } ]
}

Error codes

For more information about error codes, see Error codes.