DescribeFabricCandidateOrganizations - Blockchain as a Service

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
Action	String	Yes	DescribeFabricCandidateOrganizations	The operation that you want to perform. Set the value to DescribeFabricCandidateOrganizations.
Location	String	No	cn-hangzhou	The location.
RegionId	String	No	cn-hangzhou	The ID of the region.

Response parameters


Parameter	Type	Example	Description
ErrorCode	Integer	200	The error code.
RequestId	String	1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3	The ID of the API request.
Result			The result of the operation.
ClusterState	String	Running	The status of the cluster.
OrganizationId	String	peers-1oxw31d04****	The ID of the organization.
OrganizationName	String	org1	The name of the organization.
ServiceState	String	Running	The status of the service.
Success	Boolean	true	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=DescribeFabricCandidateOrganizations
&<Common request parameters>

Successful response examples

XML format

<DescribeFabricCandidateOrganizationsResponse>
	  <Result>
		    <ClusterState>Serving</ClusterState>
		    <OrganizationId>org-3hke7gfkjh****</OrganizationId>
		    <ServiceState>Created</ServiceState>
		    <OrganizationName>blockchain_ruiqi_test</OrganizationName>
	  </Result>
	  <Result>
		    <ClusterState>Serving</ClusterState>
		    <OrganizationId>org-2nba94f601****</OrganizationId>
		    <ServiceState>Failed</ServiceState>
		    <OrganizationName>test</OrganizationName>
	  </Result>
	  <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
	  <Success>true</Success>
	  <ErrorCode>200</ErrorCode>
</DescribeFabricCandidateOrganizationsResponse>

JSON format

{
	"Result":[
		{
			"ClusterState":"Serving",
			"OrganizationId":"org-3hke7gfkjh****",
			"ServiceState":"Created",
			"OrganizationName":"blockchain_ruiqi_test"
		},
		{
			"ClusterState":"Serving",
			"OrganizationId":"org-2nba94f601****",
			"ServiceState":"Failed",
			"OrganizationName":"test"
		}
	],
	"RequestId":"1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
	"ErrorCode":200,
	"Success":true,
}

Error codes

For more information about error codes, see Error codes.