InstanceIterator

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/eu-sovereign-cloud-api/main/json-schema/eu-sovereign-cloud-api-instance-iterator-schema.json",
  "title": "InstanceIterator",
  "description": "Iterator for instances",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/eu-sovereign-cloud-api-foundation-compute-v1-openapi.yml#/components/schemas/InstanceIterator",
  "type": "object",
  "required": [
    "items",
    "metadata"
  ],
  "properties": {
    "items": {
      "description": "List of instances",
      "type": "array",
      "items": {
        "$ref": "#/$defs/Instance"
      }
    },
    "metadata": {
      "$ref": "#/$defs/ResponseMetadata"
    }
  },
  "$defs": {
    "Annotations": {
      "x-go-type-skip-optional-pointer": true,
      "type": "object",
      "description": "User-defined key/value pairs that are mutable and can be used to add annotations.\nThe number of annotations is eventually limited by the CSP.\n",
      "additionalProperties": {
        "type": "string",
        "maxLength": 1024
      }
    },
    "Extensions": {
      "x-go-type-skip-optional-pointer": true,
      "type": "object",
      "description": "User-defined key/value pairs that are mutable and can be used to add extensions.\nExtensions are subject to validation by the CSP, and any value that is not accepted will be rejected during admission.\n",
      "additionalProperties": {
        "type": "string"
      }
    },
    "Instance": {
      "description": "Instance resource representing a virtual machine in the cloud provider's infrastructure.\nThis resource is used to manage the lifecycle of the instance, including its creation,\nupdates, and deletion.\n",
      "allOf": [
        {
          "$ref": "#/$defs/UserResourceMetadata"
        },
        {
          "type": "object",
          "required": [
            "spec"
          ],
          "properties": {
            "metadata": {
              "$ref": "#/$defs/RegionalWorkspaceResourceMetadata"
            },
            "spec": {
              "$ref": "#/$defs/InstanceSpec"
            },
            "status": {
              "$ref": "#/$defs/InstanceStatus"
            }
          }
        }
      ]
    },
    "InstanceSpec": {
      "type": "object",
      "description": "Specification of the instance, including its SKU, network configuration, and storage options.\n",
      "required": [
        "skuRef",
        "zone",
        "bootVolume"
      ],
      "properties": {
        "skuRef": {
          "allOf": [
            {
              "$ref": "#/$defs/Reference"
            }
          ],
          "description": "Reference to the SKU of the instance. The SKU is immutable after the instance is created.\nTo change the SKU, the instance must be deleted and recreated with the new SKU reference.\n",
          "x-oapi-codegen-extra-tags": {
            "x-cel-rule-0": "self == oldSelf",
            "x-cel-message-0": "spec.skuRef is immutable"
          }
        },
        "primaryNicRef": {
          "allOf": [
            {
              "$ref": "#/$defs/Reference"
            }
          ],
          "description": "Reference to the primary NIC attached to this instance."
        },
        "additionalNicRefs": {
          "type": "array",
          "x-go-type-skip-optional-pointer": true,
          "maxItems": 16,
          "description": "Additional NICs attached to this instance",
          "items": {
            "allOf": [
              {
                "$ref": "#/$defs/Reference"
              }
            ],
            "description": "Reference to an additional NIC attached to this instance."
          },
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-items": "16"
          }
        },
        "zone": {
          "allOf": [
            {
              "$ref": "#/$defs/Zone"
            }
          ],
          "description": "The zone in which the instance is deployed. The zone is immutable after the instance is created.\nTo change the zone, the instance must be deleted and recreated with the new zone.\n",
          "x-oapi-codegen-extra-tags": {
            "x-cel-rule-0": "self == oldSelf",
            "x-cel-message-0": "spec.zone is immutable",
            "x-kubebuilder-validation-min-length": "1",
            "x-kubebuilder-validation-max-length": "32"
          }
        },
        "securityGroupRef": {
          "allOf": [
            {
              "$ref": "#/$defs/Reference"
            }
          ],
          "description": "Reference to the security group associated with this instance."
        },
        "userData": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "Cloud-init user data for instance initialization\nExample cloud-init user configuration with SSH key:\n",
          "maxLength": 65536,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "65536"
          }
        },
        "antiAffinityGroup": {
          "description": "Anti-affinity group to which this instance belongs.\nInstances in the same anti-affinity group are placed on different physical hosts.\nThe number of maximum instances in an anti-affinity group is provider-specific.\n",
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "maxLength": 64,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "64"
          }
        },
        "sshKeys": {
          "type": "array",
          "x-go-type-skip-optional-pointer": true,
          "maxItems": 32,
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 4096,
            "x-oapi-codegen-extra-tags": {
              "x-kubebuilder-validation-max-length": "4096"
            }
          },
          "description": "Provider-specific references to SSH keys used in cloud-init vendorData.\nThese references are used to inject SSH public keys during instance initialization\nthrough cloud-init's vendor data configuration.\n",
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-items-min-length": "1",
            "x-kubebuilder-validation-items-max-length": "4096",
            "x-kubebuilder-validation-max-items": "32"
          }
        },
        "bootVolume": {
          "allOf": [
            {
              "$ref": "#/$defs/VolumeReference"
            }
          ],
          "description": "Reference to the block storage used to store the boot volume of the instance."
        },
        "dataVolumes": {
          "type": "array",
          "x-go-type-skip-optional-pointer": true,
          "maxItems": 64,
          "items": {
            "allOf": [
              {
                "$ref": "#/$defs/VolumeReference"
              }
            ],
            "description": "Reference to the block storage used to store an additional volume of the instance."
          },
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-items": "64"
          }
        }
      }
    },
    "InstanceStatus": {
      "description": "Current status of the instance.\n",
      "allOf": [
        {
          "$ref": "#/$defs/Status"
        },
        {
          "type": "object",
          "readOnly": true,
          "required": [
            "powerState"
          ],
          "properties": {
            "powerState": {
              "default": "off",
              "type": "string",
              "description": "Current power state of the instance.",
              "enum": [
                "on",
                "off"
              ],
              "x-enumNames": [
                "InstanceStatusPowerStateOn",
                "InstanceStatusPowerStateOff"
              ],
              "x-oapi-codegen-extra-tags": {
                "x-kubebuilder-validation-enum": "on;off",
                "x-kubebuilder-default": "off"
              }
            },
            "powerStateSince": {
              "type": "string",
              "format": "date-time",
              "description": "Indicates the time when the instance powerState has updated, basecause the instance was started, stoped or restarted. If the instance was never started the field is `null`."
            }
          }
        }
      ]
    },
    "Labels": {
      "x-go-type-skip-optional-pointer": true,
      "type": "object",
      "description": "User-defined key/value pairs that are mutable and can be used to\norganize and categorize resources. They can be used to filter resources.\nThe number of labels is eventually limited by the CSP.\n",
      "additionalProperties": {
        "type": "string",
        "maxLength": 63
      }
    },
    "ModificationMetadata": {
      "type": "object",
      "readOnly": true,
      "description": "Base metadata for all resources with optional region references",
      "required": [
        "createdAt",
        "lastModifiedAt",
        "resourceVersion"
      ],
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "Indicates the time when the resource was created. The field is set by the provider and should not be modified by the user."
        },
        "deletedAt": {
          "type": "string",
          "format": "date-time",
          "description": "If set, indicates the time when the resource was marked for deletion. Resources with this field set are considered pending deletion."
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "Indicates the time when the resource was created or last modified. Field is used for \"If-Unmodified-Since\" logic for concurrency control. The provider guarantees that a modification on a single resource can happen only once every millisecond."
        },
        "resourceVersion": {
          "type": "integer",
          "description": "Incremented on every modification of the resource. Used for optimistic concurrency control.",
          "minimum": 1,
          "format": "int64"
        }
      }
    },
    "NameMetadata": {
      "type": "object",
      "readOnly": true,
      "required": [
        "name"
      ],
      "description": "Metadata for resource names",
      "properties": {
        "name": {
          "type": "string",
          "description": "Resource identifier in dash-case (kebab-case) format. Must start and end with an alphanumeric character.\nCan contain lowercase letters, numbers, and hyphens. Multiple segments can be joined with dots.\nEach segment follows the same rules.\n",
          "minLength": 1,
          "maxLength": 128,
          "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$"
        }
      }
    },
    "PermissionMetadata": {
      "type": "object",
      "readOnly": true,
      "description": "Metadata for permission management",
      "required": [
        "provider",
        "resource",
        "verb"
      ],
      "properties": {
        "provider": {
          "type": "string",
          "minLength": 1,
          "maxLength": 64
        },
        "resource": {
          "type": "string",
          "minLength": 1,
          "maxLength": 256
        },
        "verb": {
          "type": "string",
          "minLength": 1,
          "maxLength": 7
        }
      }
    },
    "Reference": {
      "type": "object",
      "description": "A reference to a resource using an object. The object contains the\nsame information as the ReferenceURN, but is represented as a structured object.\nThe advantage of this representation is that it can be used to reference\nresources in different workspaces or regions without the need to specify\nthe full URN.\n",
      "required": [
        "resource"
      ],
      "properties": {
        "region": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "Region of the resource. If not set, the region is inferred from the context.\n",
          "maxLength": 64,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "64"
          }
        },
        "provider": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "Provider of the resource. If not set, the provider is inferred from the context.\n",
          "maxLength": 64,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "64"
          }
        },
        "tenant": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "Tenant of the resource. If not set, the tenant is inferred from the context.\n",
          "maxLength": 64,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "64"
          }
        },
        "workspace": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "Workspace of the resource. If not set, the workspace is inferred from the context.\n",
          "maxLength": 64,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "64"
          }
        },
        "resource": {
          "type": "string",
          "description": "Resource-specific path identifying the resource within its workspace context.\nThis is the segment of the full URN after the provider, version, tenant, and\nworkspace parts. For a flat resource it is `<type>/<name>`, and for hierarchical\n(nested) resources it includes the parent path segments:\n  `networks/<network-name>/route-tables/<rt-name>`\nThe provider, tenant, and workspace can be specified as separate fields in this\nobject; they do not need to be repeated here.\n",
          "minLength": 1,
          "maxLength": 256,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-min-length": "1",
            "x-kubebuilder-validation-max-length": "256"
          }
        }
      }
    },
    "ReferenceURN": {
      "type": "string",
      "minLength": 1,
      "description": "A unique resource name (URN) used to identify and reference this resource.\n\nThe URN is NOT a URL — it does not contain a protocol scheme (http/https), a host,\nor any endpoint-specific prefix. It is a portable, transport-agnostic identifier.\nA configured SDK client — which knows the provider's base URL and endpoint mapping —\ncan derive a URL from a URN, but the URN alone cannot be turned into a URL without\nthat SDK configuration context. This separation keeps the URN portable across\nenvironments and CSP deployments.\n\nThe full URN format is:\n  `{provider}/{version}/tenants/{tenant}/workspaces/{workspace}/{type}/{name}`\n\nFor hierarchical (nested) resources, additional parent path segments are included:\n  `seca.network/v1/tenants/tn-1/workspaces/ws-1/networks/my-net/route-tables/my-rt`\n\n### Automatic Prefix Inference\n\nIn most cases, the prefix of the URN can be automatically derived in the given context.\nTo simplify usage, only the resource type and name might be specified as a reference\nusing the `<type>/<name>` notation. The suffix can be made more specific by adding\nadditional segments separated by slashes.\n\nThe prefix is automatically inferred from the context. For example, if the resource is a\nblock storage in the same workspace the reference can be specified as\n`block-storages/my-block-storage`. If the resource is a block storage in a different workspace, the\nreference can be specified as `workspaces/ws-1/block-storages/my-block-storage`.\n\nFor automatic prefix inference, the following rules apply:\n- the version is inferred from the current resource version\n- the workspace is inferred from the current workspace\n- the region is inferred from the current region\n- the provider is inferred from the type and context of the usage\n\nThe prefix inference is resolved on admission into the full URN format, which makes it\nmostly suitable for human use.\n",
      "maxLength": 255
    },
    "RegionalMetadata": {
      "type": "object",
      "description": "Metadata for regional resources",
      "readOnly": true,
      "required": [
        "region"
      ],
      "properties": {
        "region": {
          "type": "string",
          "description": "Reference to the region where the resource is located",
          "minLength": 1,
          "maxLength": 64
        }
      }
    },
    "RegionalWorkspaceResourceMetadata": {
      "description": "Metadata for regional resources with name, permission, modification, type, tenant and workspace and region information.\n",
      "allOf": [
        {
          "$ref": "#/$defs/NameMetadata"
        },
        {
          "$ref": "#/$defs/PermissionMetadata"
        },
        {
          "$ref": "#/$defs/ModificationMetadata"
        },
        {
          "$ref": "#/$defs/TypeMetadata"
        },
        {
          "$ref": "#/$defs/TenantMetadata"
        },
        {
          "$ref": "#/$defs/WorkspaceMetadata"
        },
        {
          "$ref": "#/$defs/RegionalMetadata"
        }
      ]
    },
    "ResourceState": {
      "type": "string",
      "description": "Current phase of the resource:\n- pending: not available, waiting for other resources\n- creating: not available, creation started\n- active: available for data layer usage\n- updating: available for data layer usage\n- deleting: maybe still available for data layer user, can fail any moment\n- error: failed to fulfill the request; would be related to provider issue or customer related input.\n",
      "enum": [
        "pending",
        "creating",
        "active",
        "updating",
        "deleting",
        "error"
      ],
      "x-enumNames": [
        "ResourceStatePending",
        "ResourceStateCreating",
        "ResourceStateActive",
        "ResourceStateUpdating",
        "ResourceStateDeleting",
        "ResourceStateError"
      ]
    },
    "ResponseMetadata": {
      "description": "Metadata for response objects.\n",
      "allOf": [
        {
          "$ref": "#/$defs/PermissionMetadata"
        },
        {
          "type": "object",
          "readOnly": true,
          "properties": {
            "skipToken": {
              "type": "string",
              "description": "Opaque cursor to get the next page. Field is omitted when there are no more pages available.",
              "maxLength": 5
            }
          }
        }
      ]
    },
    "Status": {
      "type": "object",
      "readOnly": true,
      "description": "Current status of the resource",
      "required": [
        "conditions"
      ],
      "properties": {
        "state": {
          "x-go-type-skip-optional-pointer": true,
          "allOf": [
            {
              "$ref": "#/$defs/ResourceState"
            }
          ]
        },
        "conditions": {
          "type": "array",
          "description": "History of state transitions, ordered newest-first, complementing the\ncurrent snapshot in `state`.\n",
          "maxItems": 32,
          "items": {
            "$ref": "#/$defs/StatusCondition"
          },
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-items": "32"
          }
        }
      }
    },
    "StatusCondition": {
      "type": "object",
      "description": "StatusCondition describes the state of a resource at a certain point.\nConditions are provider-specific and can represent different states depending on the\nresource type and provider implementation.\n",
      "required": [
        "state",
        "lastTransitionAt"
      ],
      "properties": {
        "state": {
          "$ref": "#/$defs/ResourceState"
        },
        "lastTransitionAt": {
          "type": "string",
          "format": "date-time",
          "description": "LastTransitionAt is the last time the condition transitioned from one\nstatus to another. This should be when the underlying condition changed.\nIf that is not known, then using the time when the API field changed is\nacceptable.\n"
        },
        "type": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "Type of condition. The condition type is provider-specific and should\nreflect the specific states relevant to your resource.\n"
        },
        "reason": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "The reason for the condition's last transition in CamelCase.\nThe specific set of reason values is provider-specific and should be\ndocumented by the provider.\n",
          "maxLength": 1024,
          "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "1024",
            "x-kubebuilder-validation-pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$"
          }
        },
        "message": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "A human-readable message indicating details about the transition.\n",
          "maxLength": 32768,
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-max-length": "32768"
          }
        }
      }
    },
    "TenantMetadata": {
      "type": "object",
      "description": "Metadata for resources with tenant constraints",
      "readOnly": true,
      "required": [
        "tenant"
      ],
      "properties": {
        "tenant": {
          "type": "string",
          "description": "Tenant identifier",
          "minLength": 1,
          "maxLength": 64
        }
      }
    },
    "TypeMetadata": {
      "type": "object",
      "readOnly": true,
      "required": [
        "apiVersion",
        "kind",
        "ref"
      ],
      "description": "Metadata for all resources with type information.\n",
      "properties": {
        "apiVersion": {
          "type": "string",
          "description": "API version of the resource",
          "minLength": 1,
          "maxLength": 16,
          "default": "v1"
        },
        "kind": {
          "type": "string",
          "description": "Type of the resource",
          "enum": [
            "activity-log",
            "block-storage",
            "image",
            "instance",
            "instance-sku",
            "internet-gateway",
            "network",
            "network-load-balancer",
            "network-sku",
            "nic",
            "object-storage-account",
            "public-ip",
            "region",
            "role",
            "role-assignment",
            "routing-table",
            "security-group",
            "security-group-rule",
            "storage-sku",
            "subnet",
            "workspace"
          ],
          "x-enumNames": [
            "ResourceKindActivityLog",
            "ResourceKindBlockStorage",
            "ResourceKindImage",
            "ResourceKindInstance",
            "ResourceKindInstanceSku",
            "ResourceKindInternetGateway",
            "ResourceKindNetwork",
            "ResourceKindNetworkLoadBalancer",
            "ResourceKindNetworkSku",
            "ResourceKindNic",
            "ResourceKindObjectStorageAccount",
            "ResourceKindPublicIP",
            "ResourceKindRegion",
            "ResourceKindRole",
            "ResourceKindRoleAssignment",
            "ResourceKindRoutingTable",
            "ResourceKindSecurityGroup",
            "ResourceKindSecurityGroupRule",
            "ResourceKindStorageSku",
            "ResourceKindSubnet",
            "ResourceKindWorkspace"
          ]
        },
        "ref": {
          "$ref": "#/$defs/ReferenceURN"
        }
      }
    },
    "UserResourceMetadata": {
      "type": "object",
      "description": "Metadata for user-defined resource properties",
      "properties": {
        "labels": {
          "$ref": "#/$defs/Labels"
        },
        "annotations": {
          "$ref": "#/$defs/Annotations"
        },
        "extensions": {
          "$ref": "#/$defs/Extensions"
        }
      }
    },
    "VolumeReference": {
      "type": "object",
      "description": "Represents a connection between a Block Storage and an a user of the block storage.",
      "required": [
        "deviceRef"
      ],
      "properties": {
        "deviceRef": {
          "allOf": [
            {
              "$ref": "#/$defs/Reference"
            }
          ],
          "description": "Reference to the block storage used to store the volume."
        },
        "type": {
          "type": "string",
          "x-go-type-skip-optional-pointer": true,
          "description": "The connection type depends on the type of device and type of block storage.",
          "enum": [
            "virtio"
          ],
          "default": "virtio",
          "x-enumNames": [
            "VolumeReferenceTypeVirtio"
          ],
          "x-oapi-codegen-extra-tags": {
            "x-kubebuilder-validation-enum": "virtio",
            "x-kubebuilder-validation-max-length": "7",
            "x-kubebuilder-default": "virtio"
          }
        }
      }
    },
    "WorkspaceMetadata": {
      "type": "object",
      "description": "Metadata for resources with workspace constraints",
      "readOnly": true,
      "required": [
        "workspace"
      ],
      "properties": {
        "workspace": {
          "type": "string",
          "description": "Workspace identifier",
          "minLength": 1,
          "maxLength": 64
        }
      }
    },
    "Zone": {
      "type": "string",
      "description": "Reference to a specific zone within a region",
      "minLength": 1,
      "maxLength": 32
    }
  }
}