> ## Documentation Index > Fetch the complete documentation index at: https://docs.streamnative.io/llms.txt > Use this file to discover all available pages before exploring further. # List cloudenvironmentss > list or watch objects of kind CloudEnvironment ## OpenAPI ````yaml get /apis/cloud.streamnative.io/v1alpha1/namespaces/{namespace}/cloudenvironments openapi: 3.0.0 info: title: Api version: v1alpha1 servers: [] security: [] paths: /apis/cloud.streamnative.io/v1alpha1/namespaces/{namespace}/cloudenvironments: parameters: - name: namespace in: path description: object name and auth scope, such as for teams and projects required: true schema: type: string uniqueItems: true - name: pretty in: query description: If 'true', then the output is pretty printed. schema: type: string uniqueItems: true get: tags: - cloudStreamnativeIo_v1alpha1 summary: List cloudenvironmentss description: list or watch objects of kind CloudEnvironment operationId: listCloudStreamnativeIoV1alpha1NamespacedCloudEnvironment parameters: - name: allowWatchBookmarks in: query description: >- allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. schema: type: boolean uniqueItems: true - name: continue in: query description: >- 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 together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". 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. schema: type: string uniqueItems: true - name: fieldSelector in: query description: >- A selector to restrict the list of returned objects by their fields. Defaults to everything. schema: type: string uniqueItems: true - name: labelSelector in: query description: >- A selector to restrict the list of returned objects by their labels. Defaults to everything. schema: type: string uniqueItems: true - name: limit in: query description: >- 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. schema: type: integer uniqueItems: true - name: resourceVersion in: query description: >- resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset schema: type: string uniqueItems: true - name: resourceVersionMatch in: query description: >- resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset schema: type: string uniqueItems: true - name: timeoutSeconds in: query description: >- Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. schema: type: integer uniqueItems: true - name: watch in: query description: >- Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. schema: type: boolean uniqueItems: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentList' application/json;stream=watch: schema: $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentList' application/vnd.kubernetes.protobuf: schema: $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentList' application/vnd.kubernetes.protobuf;stream=watch: schema: $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentList' application/yaml: schema: $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentList' components: schemas: cloud.v1alpha1.CloudEnvironmentList: type: object required: - items properties: apiVersion: description: >- 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 type: string items: type: array items: default: {} allOf: - $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironment' kind: description: >- 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 type: string metadata: default: {} allOf: - $ref: >- #/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta x-kubernetes-group-version-kind: - group: cloud.streamnative.io kind: CloudEnvironmentList version: v1alpha1 cloud.v1alpha1.CloudEnvironment: description: >- CloudEnvironment represents the infrastructure environment for running pulsar clusters, consisting of Kubernetes cluster and set of applications type: object properties: apiVersion: description: >- 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 type: string kind: description: >- 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 type: string metadata: default: {} allOf: - $ref: >- #/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta spec: default: {} allOf: - $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentSpec' status: default: {} allOf: - $ref: '#/components/schemas/cloud.v1alpha1.CloudEnvironmentStatus' x-kubernetes-group-version-kind: - group: cloud.streamnative.io kind: CloudEnvironment version: v1alpha1 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta: description: >- ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. type: object properties: continue: description: >- 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. type: string remainingItemCount: description: >- 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. type: integer format: int64 resourceVersion: description: >- 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 type: string selfLink: description: >- Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. type: string io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta: description: >- ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. type: object properties: annotations: description: >- 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: http://kubernetes.io/docs/user-guide/annotations type: object additionalProperties: type: string default: '' clusterName: description: >- Deprecated: ClusterName is a legacy field that was always cleared by the system and never used; it will be removed completely in 1.25. The name in the go struct is changed to help clients detect accidental use. type: string creationTimestamp: description: >- CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata default: {} allOf: - $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time' deletionGracePeriodSeconds: description: >- 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. type: integer format: int64 deletionTimestamp: description: >- DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata allOf: - $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time' finalizers: description: >- 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. type: array items: type: string default: '' x-kubernetes-patch-strategy: merge generateName: description: >- 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 type: string generation: description: >- A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. type: integer format: int64 labels: description: >- 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: http://kubernetes.io/docs/user-guide/labels type: object additionalProperties: type: string default: '' managedFields: description: >- 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. type: array items: default: {} allOf: - $ref: >- #/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry name: description: >- 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: http://kubernetes.io/docs/user-guide/identifiers#names type: string namespace: description: >- 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: http://kubernetes.io/docs/user-guide/namespaces type: string ownerReferences: description: >- 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. type: array items: default: {} allOf: - $ref: >- #/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference x-kubernetes-patch-merge-key: uid x-kubernetes-patch-strategy: merge resourceVersion: description: >- 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 type: string selfLink: description: >- Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. type: string uid: description: >- 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.io/docs/user-guide/identifiers#uids type: string cloud.v1alpha1.CloudEnvironmentSpec: description: CloudEnvironmentSpec defines the desired state of CloudEnvironment type: object properties: cloudConnectionName: description: CloudConnectionName references to the CloudConnection object type: string defaultGateway: description: >- DefaultGateway is the default endpoint type to access pulsar clusters on this CloudEnvironment Users can declare new PulsarGateway for different endpoint type If not specified, public pulsar cluster endpoint will be used allOf: - $ref: '#/components/schemas/cloud.v1alpha1.Gateway' network: description: >- Network defines how to provision the network infrastructure A dedicated VPC with predefined CIDRs will be provisioned by default. allOf: - $ref: '#/components/schemas/cloud.v1alpha1.Network' region: description: Region defines in which region will resources be deployed type: string zone: description: >- Zone defines in which availability zone will resources be deployed If specified, the cloud environment will be zonal. Default to unspecified and regional cloud environment type: string cloud.v1alpha1.CloudEnvironmentStatus: description: CloudEnvironmentStatus defines the observed state of CloudEnvironment type: object properties: conditions: description: >- Conditions contains details for the current state of underlying resource type: array items: default: {} allOf: - $ref: >- #/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Condition x-kubernetes-list-map-keys: - type x-kubernetes-list-type: map x-kubernetes-patch-merge-key: type x-kubernetes-patch-strategy: merge defaultGateway: description: DefaultGateway tell the status of the default pulsar gateway allOf: - $ref: '#/components/schemas/cloud.v1alpha1.GatewayStatus' io.k8s.apimachinery.pkg.apis.meta.v1.Time: description: >- 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. type: string format: date-time io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry: description: >- ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. type: object properties: apiVersion: description: >- 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. type: string fieldsType: description: >- FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" type: string fieldsV1: description: >- FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. allOf: - $ref: >- #/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1 manager: description: Manager is an identifier of the workflow managing these fields. type: string operation: description: >- Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. type: string subresource: description: >- 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. type: string time: description: >- Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over. allOf: - $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time' io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference: description: >- 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. type: object required: - apiVersion - kind - name - uid properties: apiVersion: description: API version of the referent. type: string default: '' blockOwnerDeletion: description: >- 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. type: boolean controller: description: If true, this reference points to the managing controller. type: boolean kind: description: >- Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string default: '' name: description: >- Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names type: string default: '' uid: description: >- UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids type: string default: '' x-kubernetes-map-type: atomic cloud.v1alpha1.Gateway: description: Gateway defines the access of pulsar cluster endpoint type: object properties: access: description: >- Access is the access type of the pulsar gateway, available values are public or private. It is immutable, with the default value public. type: string privateService: description: >- PrivateService is the configuration of the private endpoint service, only can be configured when the access type is private. allOf: - $ref: '#/components/schemas/cloud.v1alpha1.PrivateService' cloud.v1alpha1.Network: description: >- Network defines how to provision the network infrastructure CIDR and ID cannot be specified at the same time. When ID is specified, the existing VPC will be used. Otherwise, a new VPC with the specified or default CIDR will be created type: object properties: cidr: description: CIDR determines the CIDR of the VPC to create if specified type: string id: description: >- ID is the id or the name of an existing VPC when specified. It's vpc id in AWS, vpc network name in GCP and vnet name in Azure type: string subnetCIDR: description: >- SubnetCIDR determines the CIDR of the subnet to create if specified required for Azure type: string io.k8s.apimachinery.pkg.apis.meta.v1.Condition: description: >- Condition contains details for one aspect of the current state of this API Resource. type: object required: - type - status - lastTransitionTime - reason - message properties: lastTransitionTime: description: >- lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. default: {} allOf: - $ref: '#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time' message: description: >- message is a human readable message indicating details about the transition. This may be an empty string. type: string default: '' observedGeneration: description: >- observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. type: integer format: int64 reason: description: >- reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. type: string default: '' status: description: status of the condition, one of True, False, Unknown. type: string default: '' type: description: type of condition in CamelCase or in foo.example.com/CamelCase. type: string default: '' cloud.v1alpha1.GatewayStatus: type: object properties: privateServiceIds: description: >- PrivateServiceIds are the id of the private endpoint services, only exposed when the access type is private. type: array items: default: {} allOf: - $ref: '#/components/schemas/cloud.v1alpha1.PrivateServiceId' x-kubernetes-list-type: atomic io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1: description: >- 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 type: object cloud.v1alpha1.PrivateService: type: object properties: allowedIds: description: >- AllowedIds is the list of Ids that are allowed to connect to the private endpoint service, only can be configured when the access type is private, private endpoint service will be disabled if the whitelist is empty. type: array items: type: string default: '' x-kubernetes-list-type: atomic cloud.v1alpha1.PrivateServiceId: type: object properties: id: description: >- Id is the identifier of private service It is endpoint service name in AWS, psc attachment id in GCP, private service alias in Azure type: string ````