Show Source

• ad(required): string

  Availability domain of the peer. Options are AD1/AD2/AD3.

  For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number of the peer is mapped to one of the three fault domains available in each availability domain.

• alias: string
  peer alias
• host(required): string
  Host on which the peer exists
• lifecycleState: string
  Allowed Values: [ "ACTIVE", "INACTIVE", "FAILED" ]

  The current state of the peer.
• ocpuAllocationParam: object OcpuAllocationNumberParam
  OCPU allocation parameter
• peerKey(required): string
  Minimum Length: 1

  Maximum Length: 255

  peer identifier
• role(required): string
  Peer role

{
    "type":"object",
    "description":"Peer details",
    "required":[
        "peerKey",
        "role",
        "host",
        "ad"
    ],
    "properties":{
        "peerKey":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "description":"peer identifier"
        },
        "role":{
            "description":"Peer role",
            "x-obmcs-enumref":"#/definitions/PeerRole/role",
            "type":"string"
        },
        "alias":{
            "type":"string",
            "description":"peer alias"
        },
        "ocpuAllocationParam":{
            "$ref":"#/definitions/OcpuAllocationNumberParam"
        },
        "host":{
            "type":"string",
            "description":"Host on which the peer exists"
        },
        "ad":{
            "description":"<p>Availability domain of the peer. Options are AD1/AD2/AD3.</p><p>For a single availability domain region, instead of spreading resources across availability domains, they are spread across fault domains. The availability domain number of the peer is mapped to one of the three fault domains available in each availability domain.</p>",
            "x-obmcs-enumref":"#/definitions/AvailabilityDomain/ads",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the peer.",
            "enum":[
                "ACTIVE",
                "INACTIVE",
                "FAILED"
            ],
            "type":"string"
        }
    }
}

Show Source

• ocpuAllocationNumber(required): number(float)
  Minimum Value: 0

  Maximum Value: 64

  Number of OCPU allocation

{
    "type":"object",
    "description":"OCPU allocation parameter",
    "required":[
        "ocpuAllocationNumber"
    ],
    "properties":{
        "ocpuAllocationNumber":{
            "type":"number",
            "format":"float",
            "minimum":"0",
            "maximum":"64",
            "description":"Number of OCPU allocation"
        }
    }
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        }
    }
}