HeadContainer
    • PDF

    HeadContainer

    • PDF

    Article summary

    Available in Classic and VPC

    View the metadata of a container (bucket).

    Note

    Sub accounts can use it through the external API Gateway dedicated to sub accounts.
    For more information, see the HeadContainer API of Sub Account.

    Requests

    The following describes the request format for the endpoint. The request format is as follows.

    MethodURI
    HEAD/v1/AUTH_{project_id}/{container}

    Request headers

    The following describes the headers.

    FieldTypeRequiredDescription
    X-Auth-TokenStringRequiredValue of the issued token
    X-NewestBooleanOptionalSet whether to respond with information from the most recent replica
    • true | false
      • true: Query all replicas and respond with information from the most recent replica
    • If the header is omitted, respond with the fastest information available

    Request path parameters

    The following describes the parameters.

    FieldTypeRequiredDescription
    project_idStringRequiredProject ID
    containerStringRequiredName of the container (bucket) to view

    Request example

    The following is a sample request.

    curl -X HEAD "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}" 
    -H "X-Auth-Token: $token"
    

    Responses

    The following describes the response format.

    Response headers

    The following describes the headers.

    FieldTypeRequiredDescription
    Content-TypeString-MIME type of the response result
    Content-LengthString-Length of the response result (bytes)
    X-Container-Object-CountInteger-Total number of objects in the container (bucket)
    X-Container-Bytes-UsedInteger-Total capacity size used by the container (bucket) (bytes)
    X-TimestampInteger-Creation time of the container (bucket) (Unix timestamp)
    X-Container-ReadString-READ ACL (access permissions) of the container (bucket)
    X-Container-WriteString-WRITE ACL (access permissions) of the container (bucket)
    Last-ModifiedString-Most recent modification time (UTC) of the container
    Accept-RangesString-Range types allowed by the container (bucket)
    X-Storage-PolicyString-Storage policy value of the container (bucket)
    X-Trans-IdString-Transaction ID of the request
    X-Openstack-Request-IdString-Transaction ID of the request
    • Identical to X-Trans-Id
    X-Container-Meta-nameString-Metadata of the container (bucket)
    • The name part of the header name acts as a key for metadata
    X-Container-Meta-Quota-CountString-Limit for number of objects in the container (bucket)
    X-Container-Meta-Quota-BytesString-Capacity limit of the container (bucket)
    X-Container-Meta-Access-Control-Allow-OriginString-CORS settings
    • Entered accessible domains
    X-Container-Meta-Access-Control-Max-AgeString-CORS settings
    • Maximum time (in seconds) for caching entered results
    X-Container-Meta-Access-Control-Expose-HeadersString-CORS settings
    • Entered accessible headers
    X-Container-Meta-Temp-URL-KeyString-Secret key value for the temporary URL
    X-Container-Meta-Temp-URL-Key-2String-Second secret key value for the temporary URL
    X-Container-Sync-KeyString-Not used
    X-Container-Sync-ToString-Not used
    X-Versions-LocationString-Not used
    X-History-LocationString-Not used
    DateString-Response time of the request (UTC)

    Response example

    The following is a sample response.

    HTTP/1.1 204 No Content
    Content-Length: 0
    X-Container-Object-Count: 3
    X-Timestamp: 1536631895.01856
    Accept-Ranges: bytes
    Last-Modified: Tue, 11 Sep 2018 02:11:36 GMT
    X-Container-Bytes-Used: 630036
    Content-Type: text/plain; charset=utf-8
    X-Trans-Id: tx51f8478e8e924403851a4-005b988014
    X-Openstack-Request-Id: tx51f8478e8e924403851a4-005b988014
    Date: Wed, 12 Sep 2018 02:55:16 GMT
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.