You can call this operation to query the consortiums in Ant Blockchain.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
PageNumber | Integer | Yes | 1 |
The number of the page to return. Pages start from page 1. |
PageSize | Integer | Yes | 10 |
The number of entries to return on each page. |
Action | String | No | DescribeAntChainConsortiums |
The operation that you want to perform. Set the value to DescribeAntChainConsortiums. |
RegionId | String | No | cn-hangzhou |
The ID of the region where Ant Blockchain is used. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | D68D66B6-1964-4073-8714-B49F5EF1AEFC |
The ID of the request. |
Result |
The result of the operation. |
||
AntConsortiums |
The information about the consortiums in Ant Blockchain. |
||
ChainNum | Long | 1 |
The number of blockchains in the consortium. |
ConsortiumDescription | String | ConsortiumDescriptionExample |
The description of the consortium. |
ConsortiumId | String | DV80nJXq |
The ID of the consortium. |
ConsortiumName | String | ConsortiumNameExample |
The name of the consortium. |
CreateTime | Long | 1562845453000 |
The time when the consortium was created. |
MemberNum | Long | 2 |
The number of members in the consortium. |
Role | String | SuperAdmin |
The role of the user who called this operation in the consortium. |
Status | String | Active |
The status of the consortium. |
Pagination |
The information about the pages that list the consortiums in Ant Blockchain. |
||
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 10 |
The number of entries returned per page. |
TotalCount | Integer | 1 |
The total number of returned entries. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeAntChainConsortiums
&<Common request parameters>
Sample success responses
XML
format
<xml version="1.0" encoding="UTF-8">
<code>200</code>
<data>
<RequestId>D68D66B6-1964-4073-8714-B49F5EF1AEFC</RequestId>
<Result>
<Pagination>
<TotalCount>1</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
</Pagination>
<AntConsortiums>
<Status>Active</Status>
<Role>SuperAdmin</Role>
<ConsortiumId>DV80nJXq</ConsortiumId>
<ChainNum>1</ChainNum>
<CreateTime>1562845453000</CreateTime>
<ConsortiumDescription>ConsortiumDescriptionExample</ConsortiumDescription>
<ConsortiumName>ConsortiumNameExample</ConsortiumName>
<MemberNum>2</MemberNum>
</AntConsortiums>
</Result>
</data>
<requestId>D68D66B6-1964-4073-8714-B49F5EF1AEFC</requestId>
<successResponse>true</successResponse>
</xml>
JSON
format
{
"successResponse":true,
"requestId":"D68D66B6-1964-4073-8714-B49F5EF1AEFC",
"data":{
"Result":{
"Pagination":{
"PageNumber":1,
"TotalCount":1,
"PageSize":10
},
"AntConsortiums":[
{
"ConsortiumName":"ConsortiumNameExample",
"Status":"Active",
"MemberNum":2,
"ChainNum":1,
"ConsortiumId":"DV80nJXq",
"CreateTime":1562845453000,
"Role":"SuperAdmin",
"ConsortiumDescription":"ConsortiumDescriptionExample"
}
]
},
"RequestId":"D68D66B6-1964-4073-8714-B49F5EF1AEFC"
},
"code":"200"
}
Error codes
For a list of error codes, visit the API Error Center.