You can call this operation to query the consortium list.

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 DescribeFabricConsortiums

The operation that you want to perform. Set the value to DescribeFabricConsortiums.

ConsortiumId String No consortium-lianmenyumingyi-hc5d1bwl****

The ID of the consortium.
Location String No cn-hangzhou

The location.
RegionId String No cn-hangzhou

The ID of the region.

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 list of consortia.
ChannelCount Integer 2

The number of channels.
ChannelPolicy String Any

The policy that is used to create the channel.
CodeName String code

The prefix of the domain name.
ConsortiumId String consortium-lianmenyumingyi-hc5d1bwl****

The ID of the consortium.
ConsortiumName String name

The name of the consortium.
CreateTime String 1544411108000

The time when the consortium was created.
Domain String domain

The domain name.
ExpiredTime String 1544411108000

The expiration time of the payment.
OrganizationCount Integer 2

The number of organizations.
OwnerBid String 26842

The business ID of the creator.
OwnerName String Uid-125566

The creator.
OwnerUid Integer 12042815

The user ID of the creator.
RegionId String cn-hangzhou

The ID of the region.
RequestId String 3a929fac-a82d-4eab-a0ff-d8671_d8b23

The ID of the API request.
SpecName String basic

The specification of the consortium node.
State String Pending

The status.
SupportChannelConfig Boolean true

Indicates whether custom parameters are supported.
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=DescribeFabricConsortiums
&<Common request parameters>

Successful response examples

XML format 

<DescribeFabricConsortiumsResponse>
  <Result>
		    <Domain>perf9141perf9141perf9141pef9141.asdadadewdasada.top</Domain>
		    <ConsortiumId>10000</ConsortiumId>
		    <OrganizationCount>2</OrganizationCount>
		    <ChannelCount>0</ChannelCount>
		    <ConsortiumName>quickstart</ConsortiumName>
		    <DeleteTime></DeleteTime>
		    <OwnerUid>1204281570282129</OwnerUid>
		    <State>Created</State>
		    <RegionId>cn-beijing</RegionId>
		    <RequestId>3A929FAC-A82D-4EAB-A0FF-D867426D8B23</RequestId>
		    <CreateTime>2018-07-16T05:31:32.000+0000</CreateTime>
		    <CodeName>quickstart</CodeName>
		    <OwnerName>uid-1204281570282129</OwnerName>
		    <OwnerBid>26842</OwnerBid>
		    <ChannelPolicy>Any</ChannelPolicy>
		    <SpecName>basic</SpecName>
		    <SupportChannelConfig>true</SupportChannelConfig>
	  </Result>
	  <RequestId>C445762C-8909-4BD8-A2BD-BB45BF2441D8</RequestId>
	  <Success>true</Success>
	  <ErrorCode>200</ErrorCode>
</DescribeFabricConsortiumsResponse>

JSON format 

{
	"Result":[
		{
			"ConsortiumName":"quickstart",
			"Domain":"perf9141perf9141perf9141pef9141.asdadadewdasada.top",
			"ConsortiumId":"10000",
			"OrganizationCount":2,
			"OwnerBid":"26842",
			"ChannelCount":0,
			"DeleteTime":"",
			"OwnerUid":1204281570282129,
			"SpecName":"basic",
			"State":"Created",
			"SupportChannelConfig":true,
			"RegionId":"cn-beijing",
			"RequestId":"3A929FAC-A82D-4EAB-A0FF-D867426D8B23",
			"CreateTime":"2018-07-16T05:31:32.000+0000",
			"CodeName":"quickstart",
			"ChannelPolicy":"Any",
			"OwnerName":"uid-1204281570282129"
		}
	],
	"RequestId":"C445762C-8909-4BD8-A2BD-BB45BF2441D8",
	"ErrorCode":200,
	"Success":true
}

Error codes

For more information about error codes, see Error codes.