Get detailed information on a specific fence
GET {{baseUrl}}/api/iserver/fences/:name
Get the detailed information of a sepcific fence based on the fence name, that the authenticated user has access to. The fence can be either User of Workload type.
DssXmlPrivilegesConfigureServerBasic and DssXmlPrivilegesUseClusterMonitor privileges are required to retrieve a specific user or workload fence.
You obtain the authorization token needed to execute the request using POST /auth/login; You obtain the fence name using GET /iserver/fences. You pass the authorization token in the request header. You specify the fence name in the path of the request.
You use the fields query parameters to selectively retrieve part of the response model.
Retrieved fence provides information about rank, name, type, reserved nodes, configured user/usergroup and projects.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token |