All Products
Search
Document Center

Blockchain as a Service:DescribeAntChainMembers

Last Updated:Aug 18, 2023

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

ParameterTypeRequiredExampleDescription
ConsortiumIdStringYesq0oWq92P

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

PageNumberIntegerYes1

The number of the page to return. Pages start from page 1.

PageSizeIntegerYes10

The number of entries to return on each page.

ActionStringNoDescribeAntChainMembers

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

RegionIdStringNocn-hangzhou

The ID of the region where Ant Blockchain is used.

Response parameters

ParameterTypeExampleDescription
RequestIdStringE0DB75A2-28C8-4295-8851-A157FFB3DFED

The ID of the request.

Result

The result of the operation.

Members

The information about the members in the consortium.

JoinTimeLong1557477823000

The time when the member joined the consortium.

MemberIdStringuid-138860157740****

The ID of the member.

MemberNameStringuid-156258999833****

The name of the member.

RoleStringMember

The role of the member.

StatusStringAllianceNotJoined

Indicates whether the member has joined the consortium.

Pagination

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

PageNumberInteger1

The page number of the returned page.

PageSizeInteger10

The number of entries returned per page.

TotalCountInteger6

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-138860157740****</MemberId>
				        <UserId>OYXLOokN</UserId>
				        <JoinTime>1557477823000</JoinTime>
				        <MemberName>uid-138860157740****sss</MemberName>
			      </Members>
			      <Members>
				        <Status>AllianceNotJoined</Status>
				        <Role>Member</Role>
				        <MemberId>uid-156258999833****</MemberId>
				        <UserId>broOV8kD</UserId>
				        <JoinTime>1560147228000</JoinTime>
				        <MemberName>uid-156258999833****</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-128712635330****",
					"MemberId":"128712635330****"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562847689000,
					"Role":"Member",
					"MemberName":"uid-189775980893****",
					"MemberId":"189775980893****"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562847826000,
					"Role":"Member",
					"MemberName":"uid-1244631294173****",
					"MemberId":"1244631294173****"
				},
				{
					"Status":"AllianceJoined",
					"JoinTime":1562848743000,
					"Role":"Member",
					"MemberName":"uid-129843093225****",
					"MemberId":"129843093225****"
				},
				{
					"Status":"AllianceNotJoined",
					"JoinTime":1562848777000,
					"Role":"Member",
					"MemberName":"uid-190816280953****",
					"MemberId":"190816280953****"
				},
				{
					"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.