Get a coordinator candidate

GET /platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}

Retrieve a coordinator candidate.

Path parameters

Responses

  • 200

    Info about a coordinator candidate.

    Hide response attributes Show response attributes object
    • name string Required

      Name of this coordinator candidate.

    • public_hostname string Required

      Public hostname of this coordinator candidate

    • acl object Required

      Zookeeper ACL of nodes this coordinator candidate is allowed to read

      Additional properties are allowed.

      Hide acl attributes Show acl attributes object
      • perms integer(int32) Required

        ZK static permissions for admin/all/create/read/write/delete

      • scheme string Required

        Zookeeper ACL scheme

      • id string Required

        Identity within provided scheme

    • id integer(int32)

      Zookeeper server identifier corresponding to this coordinator candidate

    • attributes object Required

      Attributes of this coordinator candidate

      Hide attributes attribute Show attributes attribute object
      • * string Additional properties
    • state string Required

      State of the candidate

      Values are accepted or pending.
  • 404

    Unable to find coordinator candidate {coordinator_candidate_id}. Edit your request, then try again. (code: coordinators.candidate_not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is coordinators.candidate_not_found.

    Hide response attribute Show response attribute object
    • errors array[object] Required

      A list of errors that occurred in the failing request

      Hide errors attributes Show errors attributes object
      • code string Required

        A structured code representing the error type that occurred

      • message string Required

        A human readable message describing the error that occurred

      • fields array[string]

        If the error can be tied to a specific field or fields in the user request, this lists those fields
GET /platform/infrastructure/coordinators/candidates/{coordinator_candidate_id} 
curl \
 -X GET https://{{hostname}}/api/v1/platform/infrastructure/coordinators/candidates/{coordinator_candidate_id}
Response examples (200) 
{
  "name": "string",
  "public_hostname": "string",
  "acl": {
    "perms": 42,
    "scheme": "string",
    "id": "string"
  },
  "id": 42,
  "attributes": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "state": "accepted"
}
Response examples (404) 
# Headers
x-cloud-error-codes: coordinators.candidate_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}