Jump to

• Request
• Response

Set Anchor Peers for a Channel

post

/console/admin/api/v2/channels/{channelName}/organizations/{mspId}/anchorPeers

Each member on your network must designate an anchor peer. Anchor peers are primary network contact points and are used to discover additional peers in the network. You can designate one or more peers in your organization as an anchor peer on a channel. For a high availability network, you can specify two or more anchor peers. All members using the network channel must designate one or more of their peer nodes as anchor peers.

Request

Supported Media Types

• application/json

Path Parameters

• channelName: string
  The specified channel name
• mspId: string
  The organization ID

Body ()

The anchor peer peer ID

Root Schema : setAnchorPeers

Type: object

Show Source

• anchorPeers(optional): array anchorPeers

{
    "type":"object",
    "properties":{
        "anchorPeers":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "host":{
                        "type":"string"
                    },
                    "port":{
                        "type":"number"
                    }
                }
            }
        }
    },
    "example":{
        "anchorPeers":[
            {
                "host":"org1.example.com",
                "port":20007
            }
        ]
    }
}

Example:

{
    "anchorPeers":[
        {
            "host":"org1.example.com",
            "port":20007
        }
    ]
}

Nested Schema : anchorPeers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "host":{
                "type":"string"
            },
            "port":{
                "type":"number"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• host(optional): string
• port(optional): number

{
    "type":"object",
    "properties":{
        "host":{
            "type":"string"
        },
        "port":{
            "type":"number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

Example:

{
    "status":"Success"
}

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

Example:

{
    "respMesg":"invalid argument"
}

401 Response

Unauthorized

403 Response

Forbidden

500 Response

Internal server error

Body ()

Root Schema : 500errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top