All Products
Search
Document Center

Blockchain as a Service:DescribeFabricConsortiums

Last Updated:Aug 18, 2023

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

ParameterTypeRequiredExampleDescription
ActionStringYesDescribeFabricConsortiums

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

ConsortiumIdStringNoconsortium-lianmenyumingyi-hc5d1bwl****

The ID of the consortium.

LocationStringNocn-hangzhou

The location.

RegionIdStringNocn-hangzhou

The ID of the region.

Response parameters

ParameterTypeExampleDescription
ErrorCodeInteger200

The error code.

RequestIdString1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3

The ID of the API request.

Result

The list of consortia.

ChannelCountInteger2

The number of channels.

ChannelPolicyStringAny

The policy that is used to create the channel.

CodeNameStringcode

The prefix of the domain name.

ConsortiumIdStringconsortium-lianmenyumingyi-hc5d1bwl****

The ID of the consortium.

ConsortiumNameStringname

The name of the consortium.

CreateTimeString1544411108000

The time when the consortium was created.

DomainStringdomain

The domain name.

ExpiredTimeString1544411108000

The expiration time of the payment.

OrganizationCountInteger2

The number of organizations.

OwnerBidString26842

The business ID of the creator.

OwnerNameStringUid-125566

The creator.

OwnerUidInteger12042815

The user ID of the creator.

RegionIdStringcn-hangzhou

The ID of the region.

RequestIdString3A929FAC-A82D-4EAB-A0FF-D867426D8B23

The ID of the API request.

SpecNameStringbasic

The specification of the consortium node.

StateStringPending

The status.

SupportChannelConfigBooleantrue

Indicates whether custom parameters are supported.

SuccessBooleantrue

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>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</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":"1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
	"ErrorCode":200,
	"Success":true
}

Error codes

For more information about error codes, see Error codes.