openapi: 3.0.1 info: title: FlashArray REST Active Directory Realms API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Realms description: A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups. paths: /api/2.52/realms: get: tags: - Realms summary: Pure Storage List Realms description: 'Displays a list of realms. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmGetResponse' '207': description: 'Indicates partial success. Some resources were returned, but errors may have prevented other resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/RealmGetResponse' post: tags: - Realms summary: Pure Storage Create Realms description: 'Creates realms on the local array. Each realm must be given a name that is unique across the connected arrays. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmPost' required: false x-codegen-request-body-name: realm responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmResponse' x-codegen-request-body-name: realm delete: tags: - Realms summary: Pure Storage Delete Realms description: 'Deletes realms that have been destroyed and are pending eradication. Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Eradicate_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK content: {} patch: tags: - Realms summary: Pure Storage Modify Realms description: 'Modifies realm details. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Destroy_contents' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Container_ignore_usage' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmPatch' required: true x-codegen-request-body-name: realm responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmResponse' x-codegen-request-body-name: realm /api/2.52/realms/performance: get: tags: - Realms summary: Pure Storage List Realm Performance Data description: 'Displays real-time and historical performance data, real-time latency data, and average I/O sizes across all realms, displayed both by realm and as a total across all realms. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ContainerPerformanceGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/ContainerPerformanceGetResponse' /api/2.52/realms/qos: get: tags: - Realms summary: Pure Storage List Realm QoS Config description: 'Displays real-time and historical QoS configuration data for each realm. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmQosGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/RealmQosGetResponse' /api/2.52/realms/space: get: tags: - Realms summary: Pure Storage List Realm Space Information description: 'Displays provisioned size and storage consumption data for each realm on the local array. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmSpaceGetResponse' /api/2.52/realms/tags: get: tags: - Realms summary: Pure Storage List Tags description: 'Displays the list of tags. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Namespaces' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Resource_destroyed' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/TagGetResponse' delete: tags: - Realms summary: Pure Storage Delete Tags description: 'Deletes specified tags. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Keys' - $ref: '#/components/parameters/Namespaces_delete' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' responses: '200': description: OK content: {} /api/2.52/realms/tags/batch: put: tags: - Realms summary: Pure Storage Update Tags description: 'Updates or creates tags for all specified objects. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Resource_ids' - $ref: '#/components/parameters/Resource_names' requestBody: description: A list of tags to be created or, if already existing, updated. content: application/json: schema: maxItems: 30 minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/NonCopyableTag' required: true x-codegen-request-body-name: tag responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TagResponse' x-codegen-request-body-name: tag /api/2.26/realms: get: tags: - Realms summary: Pure Storage GET Realms description: Displays a list of realms. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealmGetResponse_2' post: tags: - Realms summary: Pure Storage POST Realms description: Create a new realm. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Names_required_2' - $ref: '#/components/parameters/Without_default_access_list' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealmResponse' delete: tags: - Realms summary: Pure Storage DELETE Realms description: 'Deletes a realm that has been destroyed and is pending eradication. Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Realms summary: Pure Storage PATCH Realms description: Modify an existing realm's attributes, including destroying a realm. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmPatch_2' required: true x-codegen-request-body-name: realm responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmResponse' x-codegen-request-body-name: realm /api/2.26/realms/defaults: get: tags: - Realms summary: Pure Storage GET Realms/defaults description: 'List of default configurations for realms. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Realm_ids' - $ref: '#/components/parameters/Realm_names' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealmDefaultsGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealmDefaultsGetResponse' patch: tags: - Realms summary: Pure Storage PATCH Realms/defaults description: 'Modify a default configuration for a realm. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Realm_ids' - $ref: '#/components/parameters/Realm_names' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealmDefaults' required: true x-codegen-request-body-name: default_realm_configuration responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealmDefaultsResponse' x-codegen-request-body-name: default_realm_configuration /api/2.26/realms/space: get: tags: - Realms summary: Pure Storage GET Realms/space description: List used storage space for the realm. parameters: - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/Total_only' - $ref: '#/components/parameters/Type' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RealmSpaceGetResponse_2' /api/2.26/realms/space/storage-classes: get: tags: - Realms summary: Pure Storage GET Realms/space/storage-classes description: List used storage space for storage classes in the realm. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/End_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $ref: '#/components/parameters/Start_time' - $ref: '#/components/parameters/StorageClassNames' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/RealmSpaceStorageClassGetResponse' components: schemas: RealmDefaults: allOf: - $ref: '#/components/schemas/_context_2' - type: object properties: object_store: type: array description: Default configurations for object store. items: title: ObjectStoreDefault allOf: - $ref: '#/components/schemas/_objectStoreDefault' realm: description: Realm for the defaults. readOnly: true title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' ContainerPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'Performance data. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/ContainerPerformance' total: description: 'The aggregate value of all items after filtering. When applicable, the average value is displayed instead. If applicable, the values are displayed for each field. ' type: array items: $ref: '#/components/schemas/ContainerPerformance' _builtIn_2: type: object properties: id: description: 'A non-modifiable, globally unique ID chosen by the system. ' type: string readOnly: true name: description: Name of the object (e.g., a file system or snapshot). type: string readOnly: true _objectStoreDefault: type: object description: Configuration of defaults for object store. properties: server: description: 'Default server for new entities created in object store. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' RealmGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/RealmResponse' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: total: description: 'The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful. ' type: array items: $ref: '#/components/schemas/Realm' _referenceWritable: allOf: - $ref: '#/components/schemas/_referenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, `policies/snapshot`, etc. ' type: string x-aliases: - _reference Tag: allOf: - $ref: '#/components/schemas/_context' - type: object properties: copyable: description: 'Specifies whether or not to include the tag when copying the parent resource. If set to `true`, the tag is included in resource copying. If set to `false`, the tag is not included. If not specified, defaults to `true`. ' type: boolean example: true key: description: 'Key of the tag. Supports up to 64 Unicode characters. ' type: string example: environment namespace: description: 'Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. ' type: string example: default resource: $ref: '#/components/schemas/_fixedReference' value: description: 'Value of the tag. Supports up to 256 Unicode characters. ' type: string example: staging _performance_others: type: object properties: mirrored_others_per_sec: description: The number of mirrored other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true others_per_sec: description: The number of other requests processed per second. type: integer format: int64 minimum: 0 readOnly: true usec_per_mirrored_other_op: description: 'The average time it takes the array to process a mirrored I/O other request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true usec_per_other_op: description: 'The average time it takes the array to process an I/O other request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true Realm: allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' - description: 'A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups. ' type: object properties: created: description: 'Creation timestamp of the realm. ' type: integer format: int64 readOnly: true destroyed: description: 'Returns a value of `true` if the realm has been destroyed and is pending eradication. The realm cannot be modified while it is in the destroyed state. The `time_remaining` value displays the amount of time left until the destroyed realm is permanently eradicated. Once eradication has begun, the realm can no longer be recovered. Before the `time_remaining` period has elapsed, the destroyed realm can be recovered through the PATCH method ' type: boolean eradication_config: title: ContainerEradicationConfig allOf: - $ref: '#/components/schemas/ContainerEradicationConfig' qos: description: 'Displays QoS limit information. ' title: ContainerQos allOf: - $ref: '#/components/schemas/_containerQos' quota_limit: description: 'The logical quota limit of the realm, measured in bytes. ' type: integer format: int64 maximum: 4503599627370496 readOnly: true space: description: 'Displays provisioned size and physical storage consumption information for the realm. ' title: SpaceNoDeprecatedPhysicalOrEffective allOf: - $ref: '#/components/schemas/_spaceNoDeprecatedPhysicalOrEffective' time_remaining: description: 'Time in milliseconds before the realm is eradicated. `null` if not destroyed. ' type: integer format: int64 readOnly: true RealmGetResponse_2: allOf: - $ref: '#/components/schemas/_context_2' - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/RealmResponse' - $ref: '#/components/schemas/_errorContextResponse_2' - properties: total: $ref: '#/components/schemas/Realm_2' _builtIn: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true NonCopyableTag: type: object properties: key: description: 'Key of the tag. Supports up to 64 Unicode characters. ' type: string example: environment namespace: description: 'Optional namespace of the tag. Namespace identifies the category of the tag. Omitting the namespace defaults to the namespace `default`. The `pure*` namespaces are reserved for plugins and integration partners. It is recommended that customers avoid using reserved namespaces. ' type: string example: default resource: $ref: '#/components/schemas/_fixedReference' value: description: 'Value of the tag. Supports up to 256 Unicode characters. ' type: string example: staging RealmSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: 'Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/ResourceRealmSpace' total: description: 'The aggregate value of all items after filtering. When applicable, the average value is displayed instead. The values are displayed for each field, if meaningful. ' type: array items: $ref: '#/components/schemas/ResourceRealmSpace' Realm_2: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: created: description: Creation timestamp of the realm. type: integer format: int64 readOnly: true default_inbound_tls_policy: description: 'The default TLS policy governing inbound traffic from clients accessing the accessing the realm''s network interfaces. This TLS policy will be applied for any IP addresses within the realm that do not have a specific policy applied to them at a more granular level. If no `default_inbound_tls_policy` is configured, then IP addresses within the realm that do not have a specific policy applied to them at a more granular level will not be accessible using TLS. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' destroyed: description: 'Returns a value of `true` if the realm has been destroyed and is pending eradication. The realm cannot be modified while it is in the destroyed state. The `time_remaining` value displays the amount of time left until the destroyed realm is permanently eradicated. Once eradication has begun, the realm can no longer be recovered. Before the `time_remaining` period has elapsed, the destroyed realm can be recovered through the PATCH method by setting `destroyed=false`. ' type: boolean space: description: The space usage of the realm. title: Space allOf: - $ref: '#/components/schemas/_space' time_remaining: description: 'Time in milliseconds before the realm is eradicated. `null` if not destroyed. ' type: integer format: int64 readOnly: true RealmDefaultsGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/RealmDefaultsResponse' - $ref: '#/components/schemas/_errorContextResponse_2' _space: type: object properties: available_provisioned: description: 'The amount of space left that the current object can grow before writes are stopped due to a hard limit quota being hit. This is total_provisioned minus the virtual space used for file-systems and buckets. For array and object store accounts it is total_provisioned minus the virtual space used by non-destroyed file-systems and buckets. ' type: integer format: int64 minimum: 0 example: 19937690345472 available_ratio: description: 'The ratio of the available space versus the total provisioned space. ' type: number format: float minimum: 0 maximum: 1 data_reduction: description: Reduction of data. type: number format: float readOnly: true destroyed: description: 'Unique physical space (excluding snapshots) occupied by destroyed data within the child containers, in bytes. For buckets and filesystems, the destroyed space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems. ' type: integer format: int64 readOnly: true destroyed_virtual: description: 'The amount of destroyed logically written data within the child containers, in bytes. For buckets and filesystems, the destroyed virtual space will be 0 as they cannot have child containers. For the whole array, the space will be the sum of all destroyed buckets and filesystems. ' type: integer format: int64 readOnly: true shared: description: 'The space contributed by data that is not unique to a managed directory, or snapshot, measured in bytes. ' type: integer format: int64 readOnly: true snapshots: description: Physical usage by snapshots, other than unique in bytes. type: integer format: int64 readOnly: true total_physical: description: 'Deprecated. See total_used for the newer functionality. The total physical space consumed by the file system, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true total_provisioned: description: 'The effective provisioned size of the container, at which a hard limit will be applied. For a bucket with a `quota_limit` value and `hard_limit_enabled` set to `true`, this is its `quota_limit` value, unless the available space of the associated object store account, as defined by its `quota_limit` value, would prevent the bucket from reaching its own `quota_limit` value. In such a case, `total_provisioned` will reflect the smaller value. For a file system with a `provisioned` value and `hard_limit_enabled` set to `true`, this is the `provisioned` value of the file system. For an object store account with a `quota_limit` value and `hard_limit_enabled` set to `true`, this is the `quota_limit` value of the object store account. For the array, this is the sum of the file systems and accounts. Measured in bytes. ' type: integer format: int64 minimum: 0 example: 19937690345472 total_used: description: 'The total space consumed by customer data, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true unique: description: 'Unique physical space occupied by customer data, in bytes. Excludes snapshots, destroyed. ' type: integer format: int64 readOnly: true virtual: description: 'The amount of logically written data, in bytes. Excludes destroyed data. ' type: integer format: int64 readOnly: true example: 19937690345472 _referenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string ResourceRealmSpace: allOf: - $ref: '#/components/schemas/_builtIn' - type: object properties: space: description: 'Displays size and space consumption information. ' title: SpaceNoDeprecatedPhysicalOrEffective allOf: - $ref: '#/components/schemas/_spaceNoDeprecatedPhysicalOrEffective' time: description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true _newName: type: object properties: name: description: The new name for the resource. type: string _resource: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a file system), or correspond to something in the environment, like a host or a server. ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A user-specified name. The name must be locally unique and can be changed. ' type: string RealmSpaceStorageClassGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: type: array items: $ref: '#/components/schemas/RealmSpaceStorageClass' description: A list of realm space metrics objects for each storage class. total: description: 'Total of all records after filtering. If `total_only` query param is `true`, then no items will be returned. ' type: array items: $ref: '#/components/schemas/RealmSpaceStorageClass' TagResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Tag' _qos_bw_limit_type: type: integer format: int64 minimum: 1048576 maximum: 549755813888 _quota_limit_type: type: integer format: int64 minimum: 1048576 maximum: 4503599627370496 RealmPost: type: object properties: qos: description: Sets QoS limits. title: ContainerQos allOf: - $ref: '#/components/schemas/_containerQos' quota_limit: description: 'The logical quota limit of the realm, measured in bytes. Must be a multiple of 512. ' title: Quota_limit_type allOf: - $ref: '#/components/schemas/_quota_limit_type' tags: description: 'The list of tags to be upserted with the object. ' type: array items: $ref: '#/components/schemas/NonCopyableTag' _qos_iops_limit_type: type: integer format: int64 minimum: 100 maximum: 100000000 _limit_unset_value: type: string minLength: 0 maxLength: 0 _fixedReference_2: allOf: - $ref: '#/components/schemas/_fixedReferenceWithoutType' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true RealmSpaceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - type: object properties: items: description: A list of realm space metrics objects. type: array items: $ref: '#/components/schemas/RealmSpace' total: description: 'Total of all records after filtering. If `total_only` query param is `true`, then no items will be returned. ' type: array items: $ref: '#/components/schemas/RealmSpace' RealmQosGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'QoS configuration data. ' type: array items: $ref: '#/components/schemas/QosMetrics' PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32 TagGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/TagResponse' - $ref: '#/components/schemas/_errorContextResponse' _errorContextResponse: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorcontextresponseErrors' QosMetrics: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_containerQos' - $ref: '#/components/schemas/_context' - type: object properties: time: description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true _errorcontextresponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors _errorContextResponse_2: type: object properties: errors: description: The list of errors encountered when attempting to perform an operation. type: array readOnly: true items: $ref: '#/components/schemas/_errorContextResponseErrors' _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true x-aliases: - _fixedReference _containerQos: allOf: - $ref: '#/components/schemas/_containerQosCeilings' - properties: bandwidth_floor: description: 'The QoS bandwidth floor for the container. Traffic is granted priority until this floor is reached. Measured in bytes per second. Maximum floor is 512 GB/s. ' title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_floor: description: 'The QoS IOPs floor for the container. Traffic is granted priority until this floor is reached. Maximum floor is 100,000,000 IOs per second. ' title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' _context: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _context_2: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' RealmSpaceStorageClass: allOf: - $ref: '#/components/schemas/RealmSpace' - properties: storage_class: description: The name of the storage-class. type: string PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the `continuation_token` to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The `continuation_token` is generated if the `limit` is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 RealmPatch_2: allOf: - $ref: '#/components/schemas/_resource' - type: object properties: default_inbound_tls_policy: description: 'The default TLS policy governing inbound traffic from clients accessing the accessing the realm''s network interfaces. This TLS policy will be applied for any IP addresses within the realm that do not have a specific policy applied to them at a more granular level. If no `default_inbound_tls_policy` is configured, then IP addresses within the realm that do not have a specific policy applied to them at a more granular level will not be accessible using TLS. ' title: ReferenceWritable allOf: - $ref: '#/components/schemas/_referenceWritable' destroyed: description: 'Returns a value of `true` if the realm has been destroyed and is pending eradication. The realm cannot be modified while it is in the destroyed state. The `time_remaining` value displays the amount of time left until the destroyed realm is permanently eradicated. Once eradication has begun, the realm can no longer be recovered. Before the `time_remaining` period has elapsed, the destroyed realm can be recovered through the PATCH method by setting `destroyed=false`. ' type: boolean _errorContextResponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' message: description: A description of the error which occurred. type: string example: Resource does not exist. _containerQos_patch: allOf: - $ref: '#/components/schemas/_containerQosCeilings_patch' - properties: bandwidth_floor: description: 'The QoS bandwidth floor for the container, measured in `bytes per second`. Priority is granted to traffic until this floor is reached. The maximum supported floor is `512 GB/s`. Specifying an empty string `""` unsets the floor. ' title: ContainerQosBandwidthLimitPatch oneOf: - $ref: '#/components/schemas/_qos_bw_limit_type' - $ref: '#/components/schemas/_limit_unset_value' iops_floor: description: 'The QoS `IOPS` floor for the container. Priority is granted to traffic until this floor is reached. The maximum supported floor is `100,000,000` `IOs per second`. Specifying an empty string `""` unsets the floor. ' title: ContainerQosIopsLimitPatch oneOf: - $ref: '#/components/schemas/_qos_iops_limit_type' - $ref: '#/components/schemas/_limit_unset_value' RealmSpace: allOf: - $ref: '#/components/schemas/_builtIn_2' - type: object properties: space: $ref: '#/components/schemas/_space' time: description: Sample time in milliseconds since UNIX epoch. type: integer format: int64 ContainerEradicationConfig: description: The status of the eradication functionality type: object properties: manual_eradication: description: 'The manual eradication status of the container. If `all-enabled`, the container and its contents can be eradicated. If `partially-disabled`, the container cannot be eradicated because the container contains some some entities that are eradication disabled. If `all-disabled`, the container and its contents cannot be eradicated. Values include `all-disabled`, `all-enabled`, and `partially-disabled`. ' type: string readOnly: true example: all-enabled _fixedReferenceWithoutType: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true _containerQosCeilings: type: object properties: bandwidth_limit: description: 'The maximum QoS bandwidth limit for the container. Whenever throughput exceeds the bandwidth limit, throttling occurs. Measured in bytes per second. Maximum limit is 512 GB/s. ' title: Qos_bw_limit_type allOf: - $ref: '#/components/schemas/_qos_bw_limit_type' iops_limit: description: 'The QoS IOPs limit for the container. ' title: Qos_iops_limit_type allOf: - $ref: '#/components/schemas/_qos_iops_limit_type' RealmPatch: allOf: - $ref: '#/components/schemas/_newName' - type: object properties: destroyed: description: 'If set to `true`, the realm will be destroyed and pending eradication. The `time_remaining` value displays the amount of time left until the destroyed realm is permanently eradicated. A realm can only be destroyed if it is empty or destroy_contents is set to true. Before the `time_remaining` period has elapsed, the destroyed realm can be recovered by setting `destroyed=false`. Once the `time_remaining` period has elapsed, the realm is permanently eradicated and can no longer be recovered. ' type: boolean qos: description: 'Sets QoS limits. ' title: ContainerQos_patch allOf: - $ref: '#/components/schemas/_containerQos_patch' - $ref: '#/components/schemas/_quota_limit_patch' _quota_limit_patch: type: object properties: quota_limit: title: QuotaLimitPatch description: 'The logical quota limit of the object, measured in `bytes`. Specifying an empty string `""` unsets the quota limit. ' oneOf: - $ref: '#/components/schemas/_quota_limit_type' - $ref: '#/components/schemas/_limit_unset_value' _performance: type: object properties: bytes_per_mirrored_write: description: 'The average I/O size per mirrored write, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true bytes_per_op: description: 'The average I/O size for both read and write (all) operations. ' type: integer format: int64 minimum: 0 readOnly: true bytes_per_read: description: 'The average I/O size per read, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true bytes_per_write: description: 'The average I/O size per write, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true cached_read_bytes_per_sec: description: The number of cached bytes read, measured in bytes per second. type: integer format: int64 minimum: 0 readOnly: true cached_reads_per_sec: description: The number of cached read requests, measured in requests per second. type: integer format: int64 minimum: 0 readOnly: true mirrored_write_bytes_per_sec: description: 'The number of mirrored bytes written per second. ' type: integer format: int64 minimum: 0 readOnly: true mirrored_writes_per_sec: description: 'The number of mirrored writes per second. ' type: integer format: int64 minimum: 0 readOnly: true non_cached_read_bytes_per_sec: description: The number of non-cached bytes read, measured in bytes per second. type: integer format: int64 minimum: 0 readOnly: true non_cached_reads_per_sec: description: The number of non-cached read requests, measured in requests per second. type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_mirrored_write_op: description: 'The average time it takes the array to process a mirrored I/O write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_read_op: description: 'The average time spent waiting due to QoS rate limiting for a read request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_rate_limit_usec_per_write_op: description: 'The average time that a write I/O request spends waiting as a result of the volume reaching its QoS bandwidth limit, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_mirrored_write_op: description: 'The average time that a mirrored write I/O gets delayed due to QoS scheduling, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_read_op: description: 'The average time that a read I/O gets delayed due to QoS scheduling, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true qos_scheduling_usec_per_write_op: description: 'The average time that a write I/O gets delayed due to QoS scheduling, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_mirrored_write_op: description: 'The average time that a mirrored write I/O request spends in the kernel waiting to be served, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_read_op: description: 'The average time that a read I/O request spends in the kernel waiting to be served, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true queue_usec_per_write_op: description: 'The average time that a write I/O request spends in the kernel waiting to be served, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true read_bytes_per_sec: description: 'The number of bytes read per second. ' type: integer format: int64 minimum: 0 readOnly: true read_cache_hit_ratio: description: The ratio of read requests served directly from the cache. type: number format: float minimum: 0 maximum: 1 readOnly: true reads_per_sec: description: 'The number of read requests processed per second. ' type: integer format: int64 minimum: 0 readOnly: true san_usec_per_mirrored_write_op: description: 'The average time required to transfer data from the initiator to the array for a mirrored write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true san_usec_per_read_op: description: 'The average time required to transfer data from the array to the initiator for a read request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true san_usec_per_write_op: description: 'The average time required to transfer data from the initiator to the array for a write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_mirrored_write_op: description: 'The average time required for the array to service a mirrored write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op: description: 'The average time required for the array to service a read request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op_cache_reduction: description: 'The percentage reduction in `service_usec_per_read_op` due to data cache hits. For example, a value of 0.25 indicates that the value of `service_usec_per_read_op` is 25% lower than it would have been without any data cache hits. ' type: number format: float minimum: 0 maximum: 1 service_usec_per_read_op_cached: description: 'The average time required for the array to service a read request that is satisfied by a cache hit, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_read_op_non_cached: description: 'The average time required for the array to service a read request that is not satisfied by a cache hit, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true service_usec_per_write_op: description: 'The average time required for the array to service a write request, measured in microseconds. ' type: integer format: int64 minimum: 0 readOnly: true time: description: 'The time when the sample performance data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true usec_per_mirrored_write_op: description: 'The average time it takes the array to process a mirrored I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. ' type: integer format: int64 minimum: 0 readOnly: true usec_per_read_op: description: 'The average time it takes the array to process an I/O read request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. ' type: integer format: int64 minimum: 0 readOnly: true usec_per_write_op: description: 'The average time it takes the array to process an I/O write request, measured in microseconds. Beginning in Purity 6.3.14 and 6.4.10 and later, including later major versions (6.5.x, 6.6.x and beyond), queue time is included. The average time does not include SAN time or QoS rate limit time. ' type: integer format: int64 minimum: 0 readOnly: true write_bytes_per_sec: description: The number of bytes written per second. type: integer format: int64 minimum: 0 readOnly: true writes_per_sec: description: The number of write requests processed per second. type: integer format: int64 minimum: 0 readOnly: true x-readOnly: true RealmDefaultsResponse: type: object properties: items: description: A list of realm default configurations. type: array items: $ref: '#/components/schemas/RealmDefaults' RealmResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Realm' _spaceNoDeprecatedPhysicalOrEffective: type: object properties: data_reduction: description: 'The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array''s flash modules. ' type: number format: float footprint: description: 'The maximum amount of physical space the container would take up on any array, ignoring any data shared outside the container. Measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space, measured in bytes. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts. ' type: integer format: int64 minimum: 0 shared: description: 'The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. ' type: integer format: int64 minimum: 0 example: 111863360624 snapshots: description: 'The physical space occupied by data unique to one or more snapshots, measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes. ' type: integer format: int64 minimum: 0 system: description: 'The physical space occupied by internal array metadata, measured in bytes. ' type: integer format: int64 minimum: 0 thin_provisioning: description: 'The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. ' type: number format: float minimum: 0 maximum: 1 total_provisioned: description: 'The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by `null`. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is `null`. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null`. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container''s quota limit (or the container''s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts. ' type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 total_reduction: description: 'The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array''s flash modules. ' type: number format: float total_used: description: 'The total space contributed by customer data, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true unique: description: 'The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata. ' type: integer format: int64 minimum: 0 used_provisioned: description: 'The amount of logical space a container has consumed. The amount of logical space is compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. For a destroyed container, used provisioned can include destroyed objects and represents how much logical space it would take to recover the container. ' type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 virtual: description: 'The amount of logically written data that a volume or a snapshot references, measured in bytes. ' type: integer format: int64 minimum: 0 _containerQosCeilings_patch: type: object properties: bandwidth_limit: description: 'The maximum QoS bandwidth limit for the container, measured in `bytes per second`. Throttling occurs when throughput exceeds this limit. The maximum supported limit is `512 GB/s`. Specifying an empty string `""` unsets the limit. ' title: ContainerQosCeilingsBandwidthLimitPatch oneOf: - $ref: '#/components/schemas/_qos_bw_limit_type' - $ref: '#/components/schemas/_limit_unset_value' iops_limit: description: 'The QoS `IOPS` limit for the container. Specifying an empty string `""` unsets the limit. ' title: ContainerQosCeilingsIopsLimitPatch oneOf: - $ref: '#/components/schemas/_qos_iops_limit_type' - $ref: '#/components/schemas/_limit_unset_value' ContainerPerformance: allOf: - $ref: '#/components/schemas/_performance' - $ref: '#/components/schemas/_performance_others' - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_context' _fixedReference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true x-aliases: - _fixedReferenceWithoutType parameters: Resource_names: name: resource_names in: query description: 'A comma-separated list of resource names. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 History_start_time: name: start_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Without_default_access_list: name: without_default_access_list in: query description: 'Specifying this option ensures a realm is created without any resource accesses. ' required: true schema: type: boolean Ids: name: ids in: query description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" style: form explode: false schema: type: array items: type: string Realm_names: name: realm_names in: query description: 'A comma-separated list of realm names. If there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with `realm_ids` query parameter. ' style: form explode: false schema: type: array items: type: string Sort: name: sort in: query description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false Container_ignore_usage: name: ignore_usage in: query description: 'Set to `true` to set a `quota_limit` that is lower than the existing usage. This ensures that no new volumes can be created until the existing usage drops below the `quota_limit`. If not specified, defaults to `false`. ' schema: type: boolean Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Namespaces_delete: name: namespaces in: query description: 'A comma-separated list of namespaces. Only one namespace is allowed per delete request. ' style: form explode: false schema: type: array items: type: string Sort_2: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). NOTE: If you provide a sort you will not get a `continuation_token` in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Destroy_contents: name: destroy_contents in: query description: 'Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups), including eradicating containers with content. ' schema: type: boolean Ids_2: name: ids in: query description: 'A comma-separated list of resource IDs. If after filtering, there is not at least one resource that matches each of the elements of `ids`, then an error is returned. This cannot be provided together with the `name` or `names` query parameters. ' style: form explode: false schema: type: array items: type: string Names_required: name: names in: query description: 'Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. ' required: true style: form explode: false schema: type: array items: type: string Resolution: name: resolution in: query description: 'The desired ms between samples. Available resolutions may depend on data type, `start_time` and `end_time`. In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and `86400000` are possible values. ' schema: type: integer format: int64 minimum: 0 example: 30000 Total_only: name: total_only in: query description: 'If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. ' schema: type: boolean Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 Start_time: name: start_time in: query description: 'When the time window starts (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 History_end_time: name: end_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Context_names: name: context_names in: query description: 'Performs the operation on the context specified. If specified, the context names must be an array of size 1, and the single element must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' style: form explode: false schema: type: array items: type: string Namespaces: name: namespaces in: query description: 'A comma-separated list of namespaces. ' style: form explode: false schema: type: array items: type: string Resource_destroyed: name: resource_destroyed in: query description: 'If set to `true`, returns only objects from destroyed resources. Returns an error if the name of a live resource is specified in the `resource_names` query parameter. If set to `false`, returns only objects from live resources. Returns an error if the name of a destroyed resource is specified in the `resource_names` query parameter. ' schema: type: boolean Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string Total_item_count: name: total_item_count in: query description: 'If set to `true`, the `total_item_count` matching the specified query parameters is calculated and returned in the response. If set to `false`, the `total_item_count` is `null` in the response. This may speed up queries where the `total_item_count` is large. If not specified, defaults to `false`. ' schema: type: boolean Realm_ids: name: realm_ids in: query description: 'A comma-separated list of realm IDs. If, after filtering, there is not at least one resource that matches each of the elements, then an error is returned. This cannot be provided together with the `realm_names` query parameter. ' style: form explode: false schema: type: array items: type: string Keys: name: keys in: query description: 'A comma-separated list of tag keys. ' style: form explode: false schema: type: array items: type: string Type: name: type in: query description: 'Display the metric of a specified object type. Valid values are `array`, `file-system`, and `object-store`. If not specified, defaults to `array`. ' schema: type: string History_resolution: name: resolution in: query description: 'The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution. ' schema: type: integer format: int64 minimum: 0 example: 30000 Names_required_2: name: names in: query description: 'A comma-separated list of resource names. ' required: true style: form explode: false schema: type: array items: type: string Resource_ids: name: resource_ids in: query description: 'A comma-separated list of resource IDs. The `resource_ids` or `resource_names` parameter is required, but they cannot be set together. ' style: form explode: false schema: type: array items: type: string Eradicate_contents: name: eradicate_contents in: query description: 'Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers (e.g., realms, pods, volume groups). This enables you to eradicate containers with contents. ' schema: type: boolean Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string StorageClassNames: name: storage_class_names in: query description: 'A comma-separated list of storage class names. Valid values include `S500X-S` and `S500X-A`. ' style: form explode: false schema: type: array items: type: string End_time: name: end_time in: query description: 'When the time window ends (in milliseconds since epoch). ' schema: type: integer format: int64 minimum: 0 example: 1514764800000 Destroyed: name: destroyed in: query description: 'If set to `true`, lists only destroyed objects that are in the eradication pending state. If set to `false`, lists only objects that are not destroyed. If not set, lists both objects that are destroyed and those that are not destroyed. For destroyed objects, the time remaining is displayed in milliseconds. If object name(s) or id(s) are specified, then each object referenced must exist. If `destroyed` is set to `true`, then each object referenced must also be destroyed. If `destroyed` is set to `false`, then each object referenced must also not be destroyed. An error is returned if any of these conditions are not met. ' schema: type: boolean