Skip to main content

list-allocations 

restish dci list-allocations [flags]

Returns a list of allocations that your account has access to. Allocations are listed in reverse chronological order by default.

Flags​

--max-results: (string default:"500")

--page-token: (string)

--filter: (string)

--sort-by: (string enum:"id","name","owner","description","type","createTime","updateTime")

--sort-order: (string enum:"asc","desc")

Responses​

200 (application/json)​

OK - The request succeeded.

{
  "type": "object",
  "properties": {
    "pageToken": {
      "type": "string",
      "description": "Page token, returned by a previous call, to request the next page of results"
    },
    "rowCount": {
      "type": "integer",
      "description": "Total number of allocations in the result set"
    },
    "allocations": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Allocation ID"
          },
          "name": {
            "type": "string",
            "description": "Allocation name"
          },
          "owner": {
            "type": "string",
            "description": "Allocation owner"
          },
          "description": {
            "type": "string",
            "description": "Allocation description"
          },
          "type": {
            "type": "string",
            "description": "Type of allocation (preset or custom)"
          },
          "allocationType": {
            "type": "string",
            "description": "Type of allocation (single or group)",
            "enum": [
              "single",
              "group"
            ]
          },
          "createTime": {
            "type": "integer",
            "description": "The time when the allocation was created (in UNIX timestamp).",
            "format": "int64"
          },
          "updateTime": {
            "type": "integer",
            "description": "Last time the allocation was modified (in UNIX timestamp).",
            "format": "int64"
          },
          "urlUI": {
            "type": "string",
            "description": "URL to view the allocation in DoiT Cloud Navigator."
          }
        }
      }
    }
  }
}

400 (application/json)​

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)​

Unauthorized - Invalid API key.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)​

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)​

Not Found - The requested resource does not exist.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: list-allocations, listallocations