--- title: "GET /apis/devices.kubeedge.io/v1alpha2/devices" method: GET path: "/apis/devices.kubeedge.io/v1alpha2/devices" tags: ["devicesKubeedgeIo_v1alpha2"] --- # GET /apis/devices.kubeedge.io/v1alpha2/devices `GET /apis/devices.kubeedge.io/v1alpha2/devices` list or watch objects of kind Device ## Response `200` OK - ComGithubKubeedgeApiApisDevicesV1alpha2DeviceList — DeviceList contains a list of Device - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - `items` ComGithubKubeedgeApiApisDevicesV1alpha2Device[], required - `apiVersion` string — APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `metadata` IoK8sApimachineryPkgApisMetaV1ObjectMeta — ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. - `annotations` object — Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations - `creationTimestamp` string, date-time — Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `deletionGracePeriodSeconds` integer — Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. - `deletionTimestamp` string, date-time — Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `finalizers` string[] — Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. - `generateName` string — GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. If this field is specified and the generated name exists, the server will return a 409. Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency - `generation` integer — A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - `labels` object — Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels - `managedFields` IoK8sApimachineryPkgApisMetaV1ManagedFieldsEntry[] — ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object. - `apiVersion` string — APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. - `fieldsType` string — FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" - `fieldsV1` IoK8sApimachineryPkgApisMetaV1FieldsV1 — FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff - `manager` string — Manager is an identifier of the workflow managing these fields. - `operation` string — Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. - `subresource` string — Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. - `time` string, date-time — Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - `name` string — Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `namespace` string — Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces - `ownerReferences` IoK8sApimachineryPkgApisMetaV1OwnerReference[] — List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. - `apiVersion` string, required — API version of the referent. - `blockOwnerDeletion` boolean — If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. - `controller` boolean — If true, this reference points to the managing controller. - `kind` string, required — Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `name` string, required — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names - `uid` string, required — UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `resourceVersion` string — An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. - `uid` string — UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - `spec` ComGithubKubeedgeApiApisDevicesV1alpha2DeviceSpec — DeviceSpec represents a single device instance. It is an instantiation of a device model. - `data` ComGithubKubeedgeApiApisDevicesV1alpha2DeviceData — DeviceData reports the device's time-series data to edge MQTT broker. These data should not be processed by edgecore. Instead, they can be processed by third-party data-processing apps like EMQX kuiper. - `dataProperties` ComGithubKubeedgeApiApisDevicesV1alpha2DataProperty[] — Required: A list of data properties, which are not required to be processed by edgecore - `metadata` object — Additional metadata like timestamp when the value was reported etc. - `propertyName` string — Required: The property name for which should be processed by external apps. This property should be present in the device model. - `dataTopic` string — Topic used by mapper, all data collected from dataProperties should be published to this topic, the default value is $ke/events/device/+/data/update - `deviceModelRef` IoK8sApiCoreV1LocalObjectReference — LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace. - `name` string — Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - `nodeSelector` IoK8sApiCoreV1NodeSelector — A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms. - `nodeSelectorTerms` IoK8sApiCoreV1NodeSelectorTerm[], required — Required. A list of node selector terms. The terms are ORed. - `matchExpressions` IoK8sApiCoreV1NodeSelectorRequirement[] — A list of node selector requirements by node's labels. - `key` string, required — The label key that the selector applies to. - `operator` 'DoesNotExist' | 'Exists' | 'Gt' | 'In' | 'Lt' | 'NotIn', required — Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Possible enum values: - `"DoesNotExist"` - `"Exists"` - `"Gt"` - `"In"` - `"Lt"` - `"NotIn"` - `values` string[] — An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. - `matchFields` IoK8sApiCoreV1NodeSelectorRequirement[] — A list of node selector requirements by node's fields. - `key` string, required — The label key that the selector applies to. - `operator` 'DoesNotExist' | 'Exists' | 'Gt' | 'In' | 'Lt' | 'NotIn', required — Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. Possible enum values: - `"DoesNotExist"` - `"Exists"` - `"Gt"` - `"In"` - `"Lt"` - `"NotIn"` - `values` string[] — An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt, the values array must have a single element, which will be interpreted as an integer. This array is replaced during a strategic merge patch. - `propertyVisitors` ComGithubKubeedgeApiApisDevicesV1alpha2DevicePropertyVisitor[] — List of property visitors which describe how to access the device properties. PropertyVisitors must unique by propertyVisitor.propertyName. - `bluetooth` ComGithubKubeedgeApiApisDevicesV1alpha2VisitorConfigBluetooth — Common visitor configurations for bluetooth protocol - `characteristicUUID` string — Required: Unique ID of the corresponding operation - `dataConverter` ComGithubKubeedgeApiApisDevicesV1alpha2BluetoothReadConverter — Specifies the operations that may need to be performed to convert the data - `endIndex` integer — Required: Specifies the end index of incoming byte stream to be considered to convert the data the value specified should be inclusive for example if 3 is specified it includes the third index - `orderOfOperations` ComGithubKubeedgeApiApisDevicesV1alpha2BluetoothOperations[] — Specifies in what order the operations(which are required to be performed to convert incoming data into understandable form) are performed - … - `shiftLeft` integer — Refers to the number of bits to shift left, if left-shift operation is necessary for conversion - `shiftRight` integer — Refers to the number of bits to shift right, if right-shift operation is necessary for conversion - `startIndex` integer — Required: Specifies the start index of the incoming byte stream to be considered to convert the data. For example: start-index:2, end-index:3 concatenates the value present at second and third index of the incoming byte stream. If we want to reverse the order we can give it as start-index:3, end-index:2 - `dataWrite` object — Responsible for converting the data coming from the platform into a form that is understood by the bluetooth device For example: "ON":[1], "OFF":[0] - `collectCycle` integer — Define how frequent mapper will collect from device. - `customizedProtocol` ComGithubKubeedgeApiApisDevicesV1alpha2VisitorConfigCustomized — Common visitor configurations for customized protocol - `configData` ComGithubKubeedgeApiApisDevicesV1alpha2CustomizedValue — CustomizedValue contains a map type data - `protocolName` string — Required: name of customized protocol - `customizedValues` ComGithubKubeedgeApiApisDevicesV1alpha2CustomizedValue — CustomizedValue contains a map type data - `modbus` ComGithubKubeedgeApiApisDevicesV1alpha2VisitorConfigModbus — Common visitor configurations for modbus protocol - `isRegisterSwap` boolean — Indicates whether the high and low register swapped. Defaults to false. - `isSwap` boolean — Indicates whether the high and low byte swapped. Defaults to false. - `limit` integer — Required: Limit number of registers to read/write. - `offset` integer — Required: Offset indicates the starting register number to read/write data. - `register` string — Required: Type of register - `scale` number, double — The scale to convert raw property data into final units. Defaults to 1.0 - `opcua` ComGithubKubeedgeApiApisDevicesV1alpha2VisitorConfigOPCUA — Common visitor configurations for opc-ua protocol - `browseName` string — The name of opc-ua node - `nodeID` string — Required: The ID of opc-ua node, e.g. "ns=1,i=1005" - `propertyName` string — Required: The device property name to be accessed. This should refer to one of the device properties defined in the device model. - `reportCycle` integer — Define how frequent mapper will report the value. - `protocol` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfig — Only one of its members may be specified. - `bluetooth` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigBluetooth - `macAddress` string — Unique identifier assigned to the device. - `common` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigCommon — Only one of COM or TCP may be specified. - `collectRetryTimes` integer — Define retry times of mapper will collect from device. - `collectTimeout` integer — Define timeout of mapper collect from device. - `collectType` string — Define collect type, sync or async. - `com` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigCOM - `baudRate` integer — Required. BaudRate 115200|57600|38400|19200|9600|4800|2400|1800|1200|600|300|200|150|134|110|75|50 - `dataBits` integer — Required. Valid values are 8, 7, 6, 5. - `parity` string — Required. Valid options are "none", "even", "odd". Defaults to "none". - `serialPort` string — Required. - `stopBits` integer — Required. Bit that stops 1|2 - `commType` string — Communication type, like tcp client, tcp server or COM - `customizedValues` ComGithubKubeedgeApiApisDevicesV1alpha2CustomizedValue — CustomizedValue contains a map type data - `reconnRetryTimes` integer — Reconnecting retry times - `reconnTimeout` integer — Reconnection timeout - `tcp` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigTCP - `ip` string — Required. - `port` integer — Required. - `customizedProtocol` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigCustomized - `configData` ComGithubKubeedgeApiApisDevicesV1alpha2CustomizedValue — CustomizedValue contains a map type data - `protocolName` string — Unique protocol name Required. - `modbus` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigModbus — Only one of its members may be specified. - `slaveID` integer — Required. 0-255 - `opcua` ComGithubKubeedgeApiApisDevicesV1alpha2ProtocolConfigOpcUA - `certificate` string — Certificate for access opc server. - `password` string — Password for access opc server. - `privateKey` string — PrivateKey for access opc server. - `securityMode` string — Defaults to "none". - `securityPolicy` string — Defaults to "none". - `timeout` integer — Timeout seconds for the opc server connection.??? - `url` string — Required: The URL for opc server endpoint. - `userName` string — Username for access opc server. - `status` ComGithubKubeedgeApiApisDevicesV1alpha2DeviceStatus — DeviceStatus reports the device state and the desired/reported values of twin attributes. - `twins` ComGithubKubeedgeApiApisDevicesV1alpha2Twin[] — A list of device twins containing desired/reported desired/reported values of twin properties. Optional: A passive device won't have twin properties and this list could be empty. - `desired` ComGithubKubeedgeApiApisDevicesV1alpha2TwinProperty — TwinProperty represents the device property for which an Expected/Actual state can be defined. - `metadata` object — Additional metadata like timestamp when the value was reported etc. - `value` string, required — Required: The value for this property. - `propertyName` string — Required: The property name for which the desired/reported values are specified. This property should be present in the device model. - `reported` ComGithubKubeedgeApiApisDevicesV1alpha2TwinProperty — TwinProperty represents the device property for which an Expected/Actual state can be defined. - `metadata` object — Additional metadata like timestamp when the value was reported etc. - `value` string, required — Required: The value for this property. - `kind` string — Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds - `metadata` IoK8sApimachineryPkgApisMetaV1ListMeta — ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. - `continue` string — continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message. - `remainingItemCount` integer — remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact. - `resourceVersion` string — String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency - `selfLink` string — Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. --- [API](https://skmtc.net/kubeedge/apis/kubeedge-openapi.md) · [All operations](https://skmtc.net/kubeedge/apis/kubeedge-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kubeedge/kubeedge-openapi/revisions/f44d1c181231/schema)