You can call this operation to query the members in a consortium in Ant Blockchain.

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
ConsortiumId String Yes q0oWq92P

The ID of the consortium whose members are to be queried.

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 DescribeAntChainMembers

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

RegionId String No cn-hangzhou

The ID of the region where Ant Blockchain is used.

Response parameters

Parameter Type Example Description
RequestId String E0DB75A2-28C8-4295-8851-A157FFB3DFED

The ID of the request.

Result

The result of the operation.

Members

The information about the members in the consortium.

JoinTime Long 1557477823000

The time when the member joined the consortium.

MemberId String uid-1388601577407805

The ID of the member.

MemberName String uid-1562589998337656

The name of the member.

Role String Member

The role of the member.

Status String AllianceNotJoined

Indicates whether the member has joined the consortium.

Pagination

The information about the pages that list the members in the consortium.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 10

The number of entries returned per page.

TotalCount Integer 6

The total number of returned entries.

Examples

Sample requests


http(s)://[Endpoint]/?Action=DescribeAntChainMembers
&<Common request parameters>

Sample success responses

XML format

<xml version="1.0" encoding="UTF-8">
	  <code>200</code>
	  <data>
		    <RequestId>E0DB75A2-28C8-4295-8851-A157FFB3DFED</RequestId>
		    <Result>
			      <Pagination>
				        <PageSize>10</PageSize>
				        <Total>2</Total>
				        <Current>1</Current>
			      </Pagination>
			      <Members>
				        <Status>AllianceJoined</Status>
				        <Role>SuperAdmin</Role>
				        <MemberId>uid-1388601577407805</MemberId>
				        <UserId>OYXLOokN</UserId>
				        <JoinTime>1557477823000</JoinTime>
				        <MemberName>uid-1388601577407805sss</MemberName>
			      </Members>
			      <Members>
				        <Status>AllianceNotJoined</Status>
				        <Role>Member</Role>
				        <MemberId>uid-1562589998337656</MemberId>
				        <UserId>broOV8kD</UserId>
				        <JoinTime>1560147228000</JoinTime>
				        <MemberName>uid-1562589998337656</MemberName>
			      </Members>
		    </Result>
	  </data>
	  <requestId>E0DB75A2-28C8-4295-8851-A157FFB3DFED</requestId>
	  <successResponse>true</successResponse>
</xml>

JSON format

{
	"successResponse":true,
	"requestId":"15EFC35E-3DAD-4E97-A97D-9F81660C9DE9",
	"data":{
		"Result":{
			"Pagination":{
				"PageNumber":1,
				"TotalCount":6,
				"PageSize":10
			},
			"Members":[
				{
					"Status":"AllianceJoined",
					"JoinTime":1562845453000,
					"Role":"SuperAdmin",
					"MemberName":"uid-1287126353308684",
					"MemberId":"1287126353308684"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562847689000,
					"Role":"Member",
					"MemberName":"uid-1897759808932113",
					"MemberId":"1897759808932113"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562847826000,
					"Role":"Member",
					"MemberName":"uid-1244631294173906",
					"MemberId":"1244631294173906"
				},
				{
					"Status":"AllianceJoined",
					"JoinTime":1562848743000,
					"Role":"Member",
					"MemberName":"uid-1298430932251201",
					"MemberId":"1298430932251201"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562848777000,
					"Role":"Member",
					"MemberName":"uid-1908162809538613",
					"MemberId":"1908162809538613"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562850385000,
					"Role":"Member",
					"MemberName":"uid-100",
					"MemberId":"100"
				}
			]
		},
		"RequestId":"15EFC35E-3DAD-4E97-A97D-9F81660C9DE9"
	},
	"code":"200"
}

Error codes

For a list of error codes, visit the API Error Center.