ObjectStorageBucketResponse

Successful response with one ObjectStorageBucket

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Bucket of an object storage, with its usage from the latest daily usage data of the storage: a null figure means zero or not available yet

bucket_idintegerrequired

object_storage_idintegerrequired

Id of the object storage (GET /api/v3/object-storages/{object_storage_id})

sub_account_idinteger | nullnullablerequired

Id of the sub-account of the object storage, the account at the storage that holds its buckets and IAM users (not the account id of the storage)

region_idinteger | nullnullablerequired

Id of the storage region of the bucket

bucket_remote_idinteger | nullnullablerequired

codeinteger | nullnullablerequired

Progressive number of the bucket in the object storage

code_fullstring | nullnullablerequired

Same value as name

bucket_numberstring | nullnullablerequired

namestring | nullnullablerequired

versioningstring | nullnullablerequired

Versioning status of the bucket: ENABLED, SUSPENDED, or DISABLED if it has never been enabled

creation_datedatenullablerequired

Date the bucket was created on the storage

arnstring | nullnullablerequired

ARN (Amazon Resource Name) of the bucket, used in the policies (arn:aws:s3:::<name>)

policy_jsonstring | nullnullablerequired

Policy of the bucket on the storage, as a JSON string, with the firewall entries; null if the bucket has none

active_storage_bytesinteger | nullnullablerequired

Space used by the active objects, in bytes

deleted_storage_bytesinteger | nullnullablerequired

Space of the deleted objects that still counts toward the purchased space, in bytes

active_objectsinteger | nullnullablerequired

Number of active objects

deleted_objectsinteger | nullnullablerequired

Number of deleted objects still counted in deleted_storage_bytes

api_calls_countinteger | nullnullablerequired

Number of API calls in the day of the latest usage data

storage_wrote_bytesinteger | nullnullablerequired

Data written in the day of the latest usage data, in bytes

storage_read_bytesinteger | nullnullablerequired

Data read in the day of the latest usage data, in bytes

egress_traffic_bytesinteger | nullnullablerequired

Outgoing traffic in the day of the latest usage data, in bytes

ingress_traffic_bytesinteger | nullnullablerequired

Incoming traffic in the day of the latest usage data, in bytes

reference_datedatenullablerequired

metarequired

Always null: only the paginated lists have a meta

Constant value: null

ObjectStorageBucketResponse

{
  "error": 0,
  "message": "string",
  "data": {
    "bucket_id": 0,
    "object_storage_id": 0,
    "sub_account_id": 0,
    "region_id": 0,
    "bucket_remote_id": 0,
    "code": 0,
    "code_full": "string",
    "bucket_number": "string",
    "name": "string",
    "versioning": "string",
    "creation_date": "2024-07-29",
    "arn": "string",
    "policy_json": "string",
    "active_storage_bytes": 0,
    "deleted_storage_bytes": 0,
    "active_objects": 0,
    "deleted_objects": 0,
    "api_calls_count": 0,
    "storage_wrote_bytes": 0,
    "storage_read_bytes": 0,
    "egress_traffic_bytes": 0,
    "ingress_traffic_bytes": 0,
    "reference_date": "2024-07-29"
  }
}