List Namespaced Virtual Machine Images
- Request
  - Path Parameters
  - Query Parameters
- Responses

List Namespaced Virtual Machine Images

GET /apis/harvesterhci.io/v1beta1/namespaces/:namespace/virtualmachineimages

Get a list of VirtualMachineImage objects in a namespace.

Request

Path Parameters

namespace stringrequired

Possible values: Value must match regular expression [a-z0-9][a-z0-9\-]*

Object name and auth scope, such as for teams and projects

Query Parameters

continue string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized boolean

If true, partially initialized resources are included in the response.

labelSelector string

A selector to restrict the list of returned objects by their labels. Defaults to everything

limit integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the continue field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.

timeoutSeconds integer

TimeoutSeconds for the list/watch call.

watch boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Responses

application/json
application/json;stream=watch
application/yaml
Schema
Example (from schema)

Schema

apiVersion stringrequired

items object[]required

kind stringrequired

metadata objectrequired

continue string

remainingItemCount int64

resourceVersion string

selfLink string

{
  "apiVersion": "string",
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "name": "string",
        "namespace": "string"
      },
      "spec": {
        "checksum": "string",
        "description": "string",
        "displayName": "string",
        "pvcName": "string",
        "pvcNamespace": "string",
        "retry": 0,
        "sourceType": "download",
        "storageClassParameters": {},
        "url": "string"
      },
      "status": {
        "appliedUrl": "string",
        "conditions": [
          {
            "lastTransitionTime": "string",
            "lastUpdateTime": "string",
            "message": "string",
            "reason": "string",
            "status": "string",
            "type": "string"
          }
        ],
        "failed": 0,
        "lastFailedTime": "string",
        "progress": 0,
        "size": 0,
        "storageClassName": "string"
      }
    }
  ],
  "kind": "string",
  "metadata": {
    "continue": "string",
    "remainingItemCount": 0,
    "resourceVersion": "string",
    "selfLink": "string"
  }
}

Schema
Example (from schema)

Schema

apiVersion stringrequired

items object[]required

kind stringrequired

metadata objectrequired

continue string

remainingItemCount int64

resourceVersion string

selfLink string

{
  "apiVersion": "string",
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "name": "string",
        "namespace": "string"
      },
      "spec": {
        "checksum": "string",
        "description": "string",
        "displayName": "string",
        "pvcName": "string",
        "pvcNamespace": "string",
        "retry": 0,
        "sourceType": "download",
        "storageClassParameters": {},
        "url": "string"
      },
      "status": {
        "appliedUrl": "string",
        "conditions": [
          {
            "lastTransitionTime": "string",
            "lastUpdateTime": "string",
            "message": "string",
            "reason": "string",
            "status": "string",
            "type": "string"
          }
        ],
        "failed": 0,
        "lastFailedTime": "string",
        "progress": 0,
        "size": 0,
        "storageClassName": "string"
      }
    }
  ],
  "kind": "string",
  "metadata": {
    "continue": "string",
    "remainingItemCount": 0,
    "resourceVersion": "string",
    "selfLink": "string"
  }
}

Schema
Example (from schema)

Schema

apiVersion stringrequired

items object[]required

kind stringrequired

metadata objectrequired

continue string

remainingItemCount int64

resourceVersion string

selfLink string

{
  "apiVersion": "string",
  "items": [
    {
      "apiVersion": "string",
      "kind": "string",
      "metadata": {
        "name": "string",
        "namespace": "string"
      },
      "spec": {
        "checksum": "string",
        "description": "string",
        "displayName": "string",
        "pvcName": "string",
        "pvcNamespace": "string",
        "retry": 0,
        "sourceType": "download",
        "storageClassParameters": {},
        "url": "string"
      },
      "status": {
        "appliedUrl": "string",
        "conditions": [
          {
            "lastTransitionTime": "string",
            "lastUpdateTime": "string",
            "message": "string",
            "reason": "string",
            "status": "string",
            "type": "string"
          }
        ],
        "failed": 0,
        "lastFailedTime": "string",
        "progress": 0,
        "size": 0,
        "storageClassName": "string"
      }
    }
  ],
  "kind": "string",
  "metadata": {
    "continue": "string",
    "remainingItemCount": 0,
    "resourceVersion": "string",
    "selfLink": "string"
  }
}

Unauthorized

application/json
application/json;stream=watch
application/yaml
Schema

Schema

string

Schema

Schema

string

Schema

Schema

string

Loading…