You can call this operation to query the blockchains 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 AroN3X2l

The ID of the consortium in which you want to query the blockchains.

PageNumber Integer Yes 1

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

PageSize Integer Yes 20

The number of entries to return on each page.

Action String No DescribeAntChains

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

RegionId String No cn-hangzhou

The ID of the region where Ant Blockchain is used.

Response parameters

Parameter Type Example Description
RequestId String 52EC3196-D0B8-4FBE-A8B6-6DDABABE11C9

The ID of the request.

Result

The result of the operation.

AntChains

The information about the blockchains in the consortium.

AntChainId String pYogqb9v

The ID of the blockchain.

AntChainName String BlockchainNameExample

The name of the blockchain.

ChainType String Contract

The type of the blockchain.

CipherSuit String classic

The type of the cipher suite.

CreateTime Long 1562847396000

The time when the blockchain was created.

ExpireTime Long 1626019200000

The time when the blockchain is to expire.

IsAdmin Boolean true

Indicates whether the current user who called this operation is the administrator of the consortium.

MemberStatus String ChainApplied

Indicates whether the current user has applied for the certificate to access the blockchain.

MerkleTreeSuit String fdmt

The type of the Merkle tree of the blockchain.

Network String Running

The running status of the blockchain.

NodeNum Integer 4

The number of nodes on the blockchain.

RegionId String cn-hangzhou

The ID of the region where the blockchain resides.

ResourceSize String Basic

The type of the blockchain.

TlsAlgo String rsa

The TLS encryption algorithm used by the blockchain.

IsExist Boolean false

Indicates whether the blockchains that you are applying for are included.

Pagination

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

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

TotalCount Integer 1

The total number of returned entries.

Examples

Sample requests


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

Sample success responses

JSON format

{
	"successResponse":true,
	"requestId":"06EA0FF7-6D9E-41A6-8652-6536F1C5304F",
	"data":{
		"Result":{
			"AntChains":[
				{
					"TlsAlgo":"rsa",
					"CipherSuit":"classic",
					"MerkleTreeSuit":"fdmt",
					"IsAdmin":true,
					"MemberStatus":"ChainApplied",
					"NodeNum":4,
					"AntChainName":"BlockchainNameExample",
					"ResourceSize":"Basic",
					"Network":"Running",
					"ExpireTime":1626019200000,
					"CreateTime":1562847396000,
					"RegionId":"cn-hangzhou",
					"ChainType":"Contract",
					"AntChainId":"pYogqb9v"
				}
			],
			"Pagination":{
				"PageNumber":1,
				"TotalCount":1,
				"PageSize":20
			},
			"IsExist":false
		},
		"RequestId":"06EA0FF7-6D9E-41A6-8652-6536F1C5304F"
	},
	"code":"200"
}

Error codes

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