- Home
- API Enriched
- Sites
- data
- Namespace List.
Namespace List.
const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/site/example/api/v1/nodes';const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/system/site/example/api/v1/nodes \ --header 'Authorization: <Authorization>'API to GET list of nodes in a site.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Site Site name.
Responses
Section titled “Responses”A successful response.
NodeList is the whole list of all Nodes which have been registered with master.
object
Items in a collection or array
Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. In etcd).
object
object
Additional metadata and notes
object
Cluster or grouping configuration
object
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Security-related configuration
object
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Configuration parameter for finalizers
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 NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
Applied only if Name is not specified. More info: HTTPS://git.K8s.I/O/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +optional.
Configuration parameter for generation
Key-value labels for organization and selection
object
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.
+optional.
ManagedFieldsEntry is a workflow-ID, a FieldSet and the group version of the resource that the fieldset applies to.
object
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.
Field specification or configuration
object
Raw is the underlying serialization of this object.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are ‘Apply’ and ‘Update’.
object
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Human-readable name for the resource
Namespace defines the space within 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: HTTP://Kubernetes.I/O/docs/user-guide/namespaces +optional.
Owner or responsible party
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
object
API version of the referent.
Blocking or denial configuration
Configuration parameter for controller
Resource type or kind
Human-readable name for the resource
Unique identifier for this resource
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.I/O/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +optional.
SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.
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: HTTP://Kubernetes.I/O/docs/user-guide/identifiers#uids +optional.
object
object
object
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Version number or identifier
Unique identifier for this resource
Unique identifier for this resource
Configuration parameter for podCIDR
Configuration parameter for podCIDRs
Unique identifier for this resource
Configuration parameter for taints
The node this Taint is attached to has the “effect” on any pod that does not tolerate the Taint.
object
Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
Required. The taint key to be applied to a node.
object
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Configuration parameter for value
Configuration parameter for unschedulable
object
Network address or location
NodeAddress contains information for the node’s address.
object
The node address.
Node address type, one of Hostname, ExternalIP or InternalIP.
Configuration parameter for allocatable
object
Configuration parameter for capacity
object
Configuration parameter for conditions
NodeCondition contains condition information for a node.
object
object
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
object
Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
Configuration parameter for message
Configuration parameter for reason
Status of the condition, one of True, False, Unknown.
Type of node condition.
object
object
object
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Version number or identifier
Unique identifier for this resource
object
object
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Version number or identifier
Unique identifier for this resource
Configuration parameter for error
object
object
KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
Version number or identifier
Unique identifier for this resource
object
object
Port number of the given endpoint.
Configuration parameter for images
object
Human-readable name for the resource
Configuration parameter for sizeBytes
object
Configuration parameter for architecture
Boot ID reported by the node.
ContainerRuntime Version reported by the node through runtime remote API (e.g. Docker://1.5.0).
Kernel Version reported by the node from ‘uname -r’ (e.g. 3.16.0-0.bpo.4-amd64).
KubeProxy Version reported by the node.
Kubelet Version reported by the node.
Unique identifier for this resource
Configuration parameter for operatingSystem
OS Image reported by the node from /etc/OS-release (e.g. Debian GNU/Linux 7 (wheezy)).
Unique identifier for this resource
Current phase in the lifecycle
Configuration parameter for volumesAttached
object
File system or URL path
Human-readable name for the resource
Configuration parameter for volumesInUse
object
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.
Number of items or occurrences
Version number or identifier
SelfLink is a URL representing this object. Populated by the system. Read-only.
DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. +optional.
Examplegenerated
{ "items": [ { "metadata": { "annotations": {}, "clusterName": "example", "creationTimestamp": { "nanos": 1, "seconds": "example" }, "deletionGracePeriodSeconds": "example", "deletionTimestamp": { "nanos": 1, "seconds": "example" }, "finalizers": [ "example" ], "generateName": "example", "generation": "example", "labels": {}, "managedFields": [ { "apiVersion": "example", "fieldsType": "example", "fieldsV1": { "Raw": "example" }, "manager": "example", "operation": "example", "time": { "nanos": 1, "seconds": "example" } } ], "name": "example", "namespace": "example", "ownerReferences": [ { "apiVersion": "example", "blockOwnerDeletion": true, "controller": true, "kind": "example", "name": "example", "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ], "resourceVersion": "example", "selfLink": "example", "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "spec": { "configSource": { "configMap": { "kubeletConfigKey": "example", "name": "example", "namespace": "example", "resourceVersion": "example", "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }, "externalID": "example", "podCIDR": "example", "podCIDRs": [ "example" ], "providerID": "example", "taints": [ { "effect": "example", "key": "example", "timeAdded": { "nanos": 1, "seconds": "example" }, "value": "example" } ], "unschedulable": true }, "status": { "addresses": [ { "address": "example", "type": "example" } ], "allocatable": {}, "capacity": {}, "conditions": [ { "lastHeartbeatTime": { "nanos": 1, "seconds": "example" }, "lastTransitionTime": { "nanos": 1, "seconds": "example" }, "message": "example", "reason": "example", "status": "example", "type": "example" } ], "config": { "active": { "configMap": { "kubeletConfigKey": "example", "name": "example", "namespace": "example", "resourceVersion": "example", "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }, "assigned": { "configMap": { "kubeletConfigKey": "example", "name": "example", "namespace": "example", "resourceVersion": "example", "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }, "error": "example", "lastKnownGood": { "configMap": { "kubeletConfigKey": "example", "name": "example", "namespace": "example", "resourceVersion": "example", "uid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } } }, "daemonEndpoints": { "kubeletEndpoint": { "Port": 1 } }, "images": [ { "names": [ "example" ], "sizeBytes": "example" } ], "nodeInfo": { "architecture": "example", "bootID": "example", "containerRuntimeVersion": "example", "kernelVersion": "example", "kubeProxyVersion": "example", "kubeletVersion": "example", "machineID": "example", "operatingSystem": "example", "osImage": "example", "systemUUID": "example" }, "phase": "example", "volumesAttached": [ { "devicePath": "example", "name": "example" } ], "volumesInUse": [ "example" ] } } ], "metadata": { "continue": "example", "remainingItemCount": "example", "resourceVersion": "example", "selfLink": "example" }}Returned when operation is not authorized.
Examplegenerated
exampleReturned when there is no permission to access resource.
Examplegenerated
exampleReturned when resource is not found.
Examplegenerated
exampleReturned when operation on resource is conflicting with current value.
Examplegenerated
exampleReturned when operation has been rejected as it is happening too frequently.
Examplegenerated
exampleReturned when server encountered an error in processing API.
Examplegenerated
exampleReturned when service is unavailable temporarily.
Examplegenerated
exampleReturned when server timed out processing request.
Examplegenerated
example