@akamai/openapi-ts
    Preparing search index...

    Type Alias GetObjectStorageBucketResponses

    type GetObjectStorageBucketResponses = {
        "200": {
            cluster: string;
            created: string;
            endpoint_type: "E0" | "E1" | "E2" | "E3";
            hostname: string;
            label: string;
            objects: number;
            region: string;
            s3_endpoint: string;
            size: number;
        };
    }
    Index

    Properties

    Properties

    "200": {
        cluster: string;
        created: string;
        endpoint_type: "E0" | "E1" | "E2" | "E3";
        hostname: string;
        label: string;
        objects: number;
        region: string;
        s3_endpoint: string;
        size: number;
    }

    An Object Storage bucket.

    Type Declaration

    • cluster: string

      Deprecated The legacy clusterId equivalent for the regionId where this bucket lives. The API maintains this for backward compatibility.

      📘

      • This value and the regionId are interchangeable when used in requests. Best practice is to use the regionId.

      • This value is empty for newer regions that don't have a legacy clusterId.

    • created: string

      When this bucket was created.

    • endpoint_type: "E0" | "E1" | "E2" | "E3"

      The type of s3_endpoint available to the active user in this region. See Endpoint types for more information.

    • hostname: string

      The hostname where this bucket can be accessed. This hostname can be accessed through a browser if the bucket is made public.

    • label: string

      The name of this bucket.

    • objects: number

      The number of objects stored in this bucket.

    • region: string

      The id of the region where this Object Storage bucket lives.

    • s3_endpoint: string

      The active user's S3-compatible endpoint URL, based on the endpoint_type and region.

    • size: number

      The size of the bucket in bytes.