DescribeFabricOrganizationPeers - Blockchain as a Service

You can call this operation to query the peer node list of the 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	DescribeFabricOrganizationPeers	The operation that you want to perform. Set the value to DescribeFabricOrganizationPeers.
OrganizationId	String	Yes	peers-aaaaaa2-1eqnj5o5w****	The ID of the organization.
Location	String	No	cn-hangzhou	The location.

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 node list of an organization.
CreateTime	String	1533025590	The time when the organization was created.
Domain	String	domain	The domain name.
InstanceType	String	basic	The type of the instance.
InternetIp	String	10.0.0.2	The IP address of the public network.
IntranetIp	String	10.0.0.2	The IP address of the internal network.
IsAnchor	Boolean	false	Indicates whether the node is an anchor peer. A value of true indicates that the node is an anchor peer. A value of false indicates that the node is not an anchor peer.
OrganizationPeerName	String	name	The name of the peer node in the organization.
Port	Integer	1234	The port of the node.
UpdateTime	String	1533025590	The time when the organization was last updated.
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=DescribeFabricOrganizationPeers
&OrganizationId=peers-aaaaaa2-1eqnj5o5w****
&Location=cn-hangzhou
&<Common request parameters>

Successful response examples

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFabricOrganizationPeersResponse>
    <RequestId>1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3</RequestId>
    <Success>true</Success>
    <ErrorCode>200</ErrorCode>
    <Result>
        <UpdateTime>1533025590</UpdateTime>
        <Domain>domain</Domain>
        <InternetIp>10.0.0.2</InternetIp>
        <CreateTime>1533025590</CreateTime>
        <IsAnchor>false</IsAnchor>
        <InstanceType>basic</InstanceType>
        <Port>1234</Port>
        <OrganizationPeerName>name</OrganizationPeerName>
        <IntranetIp>10.0.0.2</IntranetIp>
    </Result>
</DescribeFabricOrganizationPeersResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1890FA4F-067A-4CE9-AC9B-2BD2E58FB5D3",
  "Success" : true,
  "ErrorCode" : 200,
  "Result" : [ {
    "UpdateTime" : "1533025590",
    "Domain" : "domain",
    "InternetIp" : "10.0.0.2",
    "CreateTime" : "1533025590",
    "IsAnchor" : false,
    "InstanceType" : "basic",
    "Port" : 1234,
    "OrganizationPeerName" : "name",
    "IntranetIp" : "10.0.0.2"
  } ]
}

Error codes

For more information about error codes, see Error codes.