Nutanix Objects Manual: S3 APIs, Prometheus, and Integrations

NUTANIX OBJECTS PROMETHEUS

EXPORTER

The Nutanix Objects Prometheus Exporter provides a solution for Nutanix Objects observability. The Nutanix Objects Prometheus Exporter service runs on Prism Central. Using an external Prometheus server, stats can be periodically retrieved from the exporter service and visualized through Grafana dashboards. You can also use any other observability tools that can import stats in Prometheus format and store and visualize them.The exporter can be used to monitor the following stats:

• Object stores and buckets stats:

• Capacity consumed or usage• Number of objects• Number of buckets

• Performance stats (individual bucket level as well as cumulative object store level): Total requests/sec,

GET/sec, PUT/sec, throughput.

• Object store resource consumption stats: CPU and memory consumption for object store services -

Object Controller, Metadata service, Atlas, and Load Balancer.

List of stats at bucket level

• nutanix_objectstore_total_object_data_gets• nutanix_objectstore_object_count• nutanix_objectstore_total_object_data_puts• nutanix_objectstore_storage_usage_bytes• nutanix_objectstore_total_deletes• nutanix_objectstore_total_batch_deletes• nutanix_objectstore_total_batch_delete_objects• nutanix_objectstore_total_batch_delete_with_versions• nutanix_objectstore_total_delete_with_versions• nutanix_objectstore_total_heads• nutanix_objectstore_total_lists• nutanix_objectstore_total_list_versions• nutanix_objectstore_total_multipart_lists• nutanix_objectstore_total_multipart_uploads• nutanix_objectstore_total_posts• nutanix_objectstore_total_requests_sec• nutanix_objectstore_total_select_content_ops• nutanix_objectstore_total_throughput_in_sec

Objects | Nutanix Objects Prometheus Exporter |

• nutanix_objectstore_total_throughput_out_sec

List of stats at object store level

• nutanix_objectstore_total_object_data_gets• nutanix_objectstore_total_batch_deletes• nutanix_objectstore_total_batch_delete_objects• nutanix_objectstore_total_batch_delete_with_versions• nutanix_objectstore_total_delete_with_versions• nutanix_objectstore_num_buckets• nutanix_objectstore_num_objects• nutanix_objectstore_total_object_data_puts• nutanix_objectstore_total_deletes• nutanix_objectstore_total_heads• nutanix_objectstore_total_lists• nutanix_objectstore_total_list_versions• nutanix_objectstore_total_multipart_lists• nutanix_objectstore_total_multipart_uploads• nutanix_objectstore_total_posts• nutanix_objectstore_total_requests_sec• nutanix_objectstore_total_select_content_ops• nutanix_objectstore_total_throughput_in_sec• nutanix_objectstore_total_throughput_out_sec• nutanix_objectstore_usage_bytes

List of resource stats for services of an object storeCPU and memory usage for Atlas, Object Controller and Metadata Server.For more information on the integration steps with external Prometheus and Grafana, contact your Nutanix account team for further guidance. Objects | Nutanix Objects Prometheus Exporter |

NUTANIX OBJECTS CRUD OPERATIONS

BY USING S3 APIS

Create and manage buckets and objects by using S3 APIs in Nutanix Objects.Nutanix Objects provides S3-compatible object storage, enabling users to create, manage, and interact with buckets and objects using standard Amazon S3 APIs. You can interact with the service via REST API or AWS SDKs. All API interactions with Nutanix Objects are authenticated to ensure secure access. The object store supports Amazon S3 features such as tagging (key-value labels), S3 Select for partial content retrieval, and server-side encryption with customer-provided keys (SSE-C).

Nutanix Objects Authentication

You can send requests to Nutanix Objects by using the REST API or the Amazon Web Services Software Development Kit (AWS SDK) wrapper libraries that wrap the underlying S3 REST API. Every interaction with Nutanix Objects is authenticated. In this authentication process, the identity of the requester who is trying to access Nutanix Objects is verified with a signature value. The signature value is generated from the AWS access keys (access key ID and secret access key) of the requester. This AWS access keys and endpoint URL is provided by the administrator to the user.If you are using the AWS SDK, the libraries compute the signature from the keys you provide. However, if you make direct REST API calls, the signature is computed from the request.For creating the buckets and objects, you need the following information from the administrator:

• Endpoint URL (Static IP address and the Port number)• Access key ID• Secret access keyOnce you get this information, you can import the SDK libraries, create a session and a client, and then

you can start making the requests (for example, creating buckets and objects).

Note: Nutanix Objects supports the following:

• Signature Version 2 and Signature Version 4 (regular and pre-signed)• Streaming signed payloads for PUT requests with Signature Version 4

Nutanix Objects Supported and Unsupported APIs

This section describes Nutanix Objects support for Amazon S3 API. The object store service is available on the following ports:

Note:

• Transport Layer Security (TLS) 1.2 is supported on Nutanix Objects.• Support for all CBC based ciphers are deprecated.

If you are using RSA certificate, the following ciphers are allowed. TLS/1.2 Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

IANA : TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (OpenSSL : ECDHE-RSA-AES256-GCM- SHA384) IANA : TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (OpenSSL : ECDHE-RSA-AES128-GCM- SHA256) If you are using EC certificate, the following ciphers are allowed. TLS/1.2 IANA : TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 (OpenSSL : ECDHE-ECDSA-AES256- GCM-SHA384) IANA : TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 (OpenSSL : ECDHE-ECDSA-AES128- GCM-SHA256)

Nutanix Objects Supported APIs

The following table lists the supported S3 API methods.

Table 45: Supported S3 APIs and Parameters

Note:

• User-provided metadata header names are stored in lowercase.• User-defined object metadata is supported for the PUT Object and PUT Object-Copy APIs

and is limited to 2 KB in size.

• For bucket tagging, tags that begin with the prefix ntnx: are reserved for internal services and

cannot be used by external clients.

• The maximum size limit of a multipart object is 16 TiB. This limit is different from the standard

S3 API limit of 5 TiB. For more information on objects tagging API, see Buckets and Nutanix Objects Tagging APIs Overview on page 255.For more information on S3 Select API, see Nutanix Objects S3 Select API Overview on page 256. Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

You can generate Presigned URLs for Nutanix Objects and restrict access by specifying an expiration time. The expiration time can exceed seven days. For more information, see Signing and authenticating REST requests in the Amazon Simple Storage Service Developer Guide.

Table 46: Supported APIs That Use Only Common Headers

The following table lists the supported APIs that use only Nutanix Objects Common Headers on page 253: Supported APIsGET Bucket lifecycle configurationPUT Bucket lifecycle configurationGET Bucket Object Lock ConfigurationGET Bucket LocationGET Bucket PolicyGET Bucket versioningGET Bucket ACLGET Bucket notification configurationGET Bucket corsGET Bucket websiteGET Bucket replicationPUT Bucket corsPUT Bucket notification configurationPUT Bucket websitePUT Bucket replicationDELETE Bucket corsDELETE Bucket websiteDELETE Bucket LifecycleDELETE Bucket Policy Note: DELETE Bucket Policy is only supported for regular buckets and not federated buckets. DELETE Bucket replicationDELETE ObjectHEAD BucketLIST BucketABORT Multipart Upload

Nutanix Objects Common Headers

You can use the following headers while making requests: Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

Table 47: List of Common Headers

AuthorizationContent-LengthContent-TypeContent-MD5DateExpectHostx-amz-content-sha256x-amz-datex-amz-security-token For more information on common headers, see Common Request Headers in the Amazon Simple Storage Service API Reference Guide.

Nutanix Objects Unsupported APIs

The following table lists the unsupported S3 API methods:

Table 48: Unsupported S3 APIs

Unsupported S3 APIsGET Bucket accelerate configurationGET Bucket analytics configurationGET Bucket encryptionGET Bucket inventory configurationGET Bucket loggingGET Bucket metrics configurationGET Bucket requestPaymentList Bucket Analytics ConfigurationsList Bucket Inventory ConfigurationsList Bucket Metrics ConfigurationsPUT Bucket accelerate configurationPUT Bucket aclPUT Bucket analytics configurationPUT Bucket encryptionPUT Bucket inventory configurationPUT Bucket loggingPUT Bucket metrics configurationDELETE Bucket analytics configuration Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

Unsupported S3 APIsDELETE Bucket inventory configurationDELETE Bucket metrics configurationDELETE Bucket encryptionCopyGET Object ACLPUT Object ACLRestore Object

Buckets and Nutanix Objects Tagging APIs Overview

A tag is a label that you assign to a bucket or an object, and it consists of a key and a value pair that you can define.The tagging APIs feature allows you to add, retrieve, and remove tags for your buckets and objects.

Buckets Tagging

• Retrieving bucket metadata also returns the number of tags associated with the bucket, if any.• The maximum number of tags allowed per bucket is 50.• Tag keys can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode

characters in length.

• Tag keys and values are case-sensitive.

Nutanix Objects Tagging

• Retrieving objects metadata also returns the number of tags associated with the object, if any.• Tagging is also supported with a few other Object APIs.• The maximum number of tags allowed per object is 10.• Tag keys can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode

characters in length.

• Tag keys and values are case-sensitive.

API Operations Supported for Buckets and Nutanix Objects Tagging

Nutanix Objects supports APIs for tagging both buckets and objects. Tag-based bucket lifecycle policy management and object listing are not supported. Bucket Tagging API OperationsNutanix Objects supports the following bucket tagging API operations.

Note: For bucket tagging, tags starting with prefix ntnx: are reserved for internal services and not allowed

by external clients. Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

• You can add tags to a bucket with no tags associated with it.• You can replace the existing tags associated with the bucket.

For more information on bucket tagging, see PutBucketTagging in the Amazon Simple Storage Service API Reference guide. Object Tagging API OperationsNutanix Objects supports the following object tagging API operations.

body.The following two scenarios are involved:

• You can add tags to an object with no tags associated with it.• You can replace the existing tags associated with an object.

The following Object APIs also support tagging:

• GET Object (returns tag count, if any)• PUT Object• PUT Object-Copy• Initiate Multipart Upload

Nutanix Objects S3 Select API Overview

S3 Select is a feature to select the partial content of an object and returns the result.With the S3 Select feature, you can only fetch the content of interest. This allows applications to speed up their queries drastically as the size of the sub-set of the object is smaller compared to the actual size of the entire object. S3 Select is supported on objects stored in CSV format and returns the result in CSV format. Note: S3 select does not support compression. The SelectObjectContent API filters the contents of an object located in Nutanix Objects using an SQL statement. In the request, you must specify the SQL expression and data serialization format (CSV) of the object. Nutanix Objects use this format to parse object data into records, and it returns only records that match the specified SQL expression. You must also specify the data serialization format (CSV) for the response. Basic Command SupportNutanix Objects S3 Select feature supports only the SELECT SQL command. Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

The S3 Select query operates on a single object. The primary commands involve data selection and filtering.The following clauses are supported for the SELECT command.

• SELECT list: The SELECT list names the columns, functions, and expressions that you want the query to

return.The following are supported:

• Aggregate operators such as AVG, COUNT, MAX, MIN• Arithmetic operations (For example, +, /)

• FROM clause: Using FROM clause, you can select from arrays or objects within a JSON object. You can

use S3Object as a basic reference.

• WHERE clause: The WHERE clause filters rows based on the condition. A condition is an expression that

has a Boolean result.The following conditions are supported:

• AND, NOT, OR operators• Comparison (For example, <, >=)• Pattern matching (For example, LIKE, %)

• LIMIT clause: The LIMIT clause limits the number of records that you want the query to return based on

the number. The following is the general syntax of a SELECT query. SELECT fields FROM S3Object WHERE condition LIMIT num Note: The specific parameters differ based on the format and schema of the object. For more information on the supported SQL functions, seeSupported SQL Functions by Nutanix Objects S3 Select on page 257.

RequirementsThe following is the requirement for using S3 SELECT:

• You must have s3:GetObject permission for the object you are querying.

LimitationsThe following are limitations for using S3 SELECT:

• The maximum length of a SQL expression is 256 KB.• The maximum length of a record in the input or result is 1 MB.• Complex operations like sub-queries or joins are not supported.

Supported SQL Functions by Nutanix Objects S3 Select

S3 Select supports the following SQL functions. Objects | Nutanix Objects CRUD Operations by Using S3 APIs |

Table 49: Type of Supported Functions

Server-Side Encryption with Customer-Provided Keys Supported APIs

Server-side encryption with customer-provided keys (SSE-C) encrypts objects using Advanced Encryption Standard with Galois Counter Mode (AES-256-GCM), ensuring data integrity and enabling efficient range reads.Each object is encrypted using AES-256-GCM, which generates an authentication tag to ensure data integrity. Decryption requires the same encryption key used during encryption. Nutanix Objects are divided into blocks, and block-level encryption enables efficient range reads without requiring decryption of the entire object.The following table lists the S3 API methods that require additional parameters to support this feature.

Table 50: S3 API Methods Requiring Additional Parameters for Feature Support

Note: SSE-C is incompatible with buckets with Network File System access, buckets in the Federated

namespace, and buckets with replication configured. An object which is stored with SSE-C, cannot be accessed through S3 Select API. The following table lists the compatibility of SSE-C with other Nutanix Objects features and the expected behavior when used together.

Table 51: SSE-C Compatibility with other Nutanix Objects Features

The following table lists alerts related to SSE-C, along with their descriptions.

Table 52: Alerts

KAFKA NOTIFICATION SCHEMA

Kafka messages follow a structured JSON schema for object events, including creation, access, and deletion.

Table 53: Top Level Fields

Table 54: Record Fields

Table 55: S3 Top Level Fields

Table 56: Bucket Fields

Table 57: Object Fields

NUTANIX OBJECTS REST ERROR

RESPONSES

This section provides reference information about Nutanix Objects error responses and codes.When Nutanix Objects request returns an error, the client receives an error response. The format of the error response is API specific; however, all the error responses have common elements.When an error occurs, the header information includes the following:

• Content-Type: application/xml• An appropriate status codeThe following elements are included in REST error responses:

• Code. For more information, see List of Error Codes for Nutanix Objects on page 268.• Error• Message• RequestId• ResourceFor more information on the error responses, see REST Error Responses in the Amazon Simple Storage

Service API Reference Guide.

List of Error Codes for Nutanix Objects

The following table lists the error codes:

Table 58: Error Codes for Nutanix Objects

For more information on the error codes, see List of Error Codes in the Amazon Simple Storage Service API Reference Guide. Objects | Nutanix Objects REST Error Responses |

NUTANIX OBJECTS INTEGRATION WITH

BACKUP APPLICATIONS

Nutanix Objects is ideal for cost-effective, scale-out storage. It provides a fully distributed, API-accessible storage platform that integrates directly into applications or is used for backup, archiving, and data retention. Nutanix Objects offers you a seamless way to switch from your traditional backup to object store backup. You can also perform multipart uploads. Nutanix Objects supports integration with back up applications such as Commvault, HYCU, Veeam and Veritas.

Note: Some backup vendors have configurable size limits if larger than 5 TiB VM images need to be

backed up (For example, HYCU). The backup appliance configuration needs to be changed in order to take advantage of the larger size limit in Nutanix Objects. For more information on Commvault Integration, see Commvault with Nutanix guide on the Nutanix Support Portal. Objects | Nutanix Objects Integration with Backup Applications |

Last updated Oct 08, 2026