DescribeFabricOrganization - Blockchain as a Service - Alibaba Cloud Documentation Center

You can call this operation to query the details of an organization.

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	DescribeFabricOrganization	The operation that you want to perform. Set the value to DescribeFabricOrganization.
OrganizationId	String	Yes	peers-aaaaaa2-1eqnj5o5w****	The ID of the organization.
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 details of the organization.
CANAME	String	client	The name of the CA node in the organization.
CAUrl	String	https://ca1.org1.alibabacloudbaas.com:31154	The address of the CA node in the organization.
CodeName	String	org1	The prefix of the domain name.
ConsortiumCount	Integer	2	The number of consortia.
CreateTime	String	1533025590	The creation time.
Domain	String	org1.alibabacloudbaas.com	The domain name.
MSP	String	org1MSP	The provider of the member service.
OrganizationDescription	String	This is org1	The description of the organization.
OrganizationId	String	peers-aaaaaa2-1eqnj5o5w9dt3	The ID of the organization.
OrganizationName	String	org1	The name of the organization.
OwnerBid	String	2544	The business ID of the creator.
OwnerName	String	uid-23434	The creator.
OwnerUid	Long	23434	The user ID of the creator.
PeerCount	Integer	2	The number of peer nodes.
RegionId	String	cn-hangzhou	The ID of the region.
RequestId	String	1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3	The ID of the API request.
SpecName	String	basic	The name of the specification.
State	String	Running	The status.
UserCount	Integer	2	The number of users.
ZoneId	String	cn-hangzhou-1a	The available zone.
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=DescribeFabricOrganization
&OrganizationId=peers-aaaaaa2-1eqnj5o5w****
&<Common request parameters>

Successful response examples

XML format

<DescribeFabricOrganizationResponse>
  </Result>
		    <OrganizationDescription>organization created by ruiqi.zss</OrganizationDescription>
		    <Domain>peer.aliyun.abasssample.cc</Domain>
		    <ZoneId>cn-shanghai-a</ZoneId>
		    <OrganizationId>org-ip92i26m792c9</OrganizationId>
		    <OrganizationName>Alibaba Cloud</OrganizationName>
		    <ConsortiumCount>1</ConsortiumCount>
		    <UserCount>0</UserCount>
		    <State>Created</State>
		    <SpecName>ecs.n1.medium</SpecName>
		    <OwnerUid>120428157028****</OwnerUid>
		    <CAUrl>https://ca1.org1.alibabacloudbaas.com:31154</CAUrl>
		    <CreateTime>2018-06-22T06:14:21.000+0000</CreateTime>
		    <CANAME>caname</CANAME>
		    <CodeName>aliyun</CodeName>
		    <OwnerName>blockchain_baas_test</OwnerName>
		    <PeerCount>2</PeerCount>
		    <OwnerBid>26842</OwnerBid>
	  </Result>
	  <RequestId>C445762C-8909-4BD8-A2BD-BB45BF2441D8</RequestId>
	  <Success>true</Success>
	  <ErrorCode>200</ErrorCode>
</DescribeFabricOrganizationResponse>

JSON format

{
	"Result":{
		"Domain":"peer.aliyun.abasssample.cc",
		"CANAME":"caname",
		"ZoneId":"cn-shanghai-a",
		"CAUrl":"https://ca1.org1.alibabacloudbaas.com:31154",
		"OrganizationId":"org-ip92i26m792c9",
		"OwnerBid":"26842",
		"OrganizationName":"Alibaba Cloud",
		"OrganizationDescription":"organization created by ruiqi.zss",
		"ConsortiumCount":1,
		"UserCount":0,
		"OwnerUid":120428157028****,
		"State":"Created",
		"SpecName":"ecs.n1.medium",
		"CreateTime":"2018-06-22T06:14:21.000+0000",
		"CodeName":"aliyun",
		"PeerCount":2,
		"OwnerName":"blockchain_baas_test"
	},
	"RequestId":"C445762C-8909-4BD8-A2BD-BB45BF2441D8",
	"ErrorCode":200,
	"Success":true
}

Error codes

For more information about error codes, see Error codes.