HeadContainer
    • PDF

    HeadContainer

    • PDF

    Article Summary

    The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

    Overview

    Searches the metadata of containers (buckets).

    Statement

    HEAD https://{endpoint}/swift/v1/{containerName}
    

    Request

    Request header

    Header nameDescription
    x-ncp-apigw-timestampThis is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
    If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-iam-access-keyThis is the access key ID issued by the NCP portal or Sub Account.
    x-ncp-apigw-signature-v2Signature used to encrypt the body of the above example with the SecretKey that maps with the access key ID.
    The HMAC encryption algorithm is HMACSHA256.
    x-ncp-region_codeThe region code of where the bucket of the data to be migrated from another cloud to NAVER Cloud is located

    Request parameter

    Parameter nameRequirement statusTypeRestrictionsDescription
    ContainerName-string-Name of the container to search

    Response

    Response header

    NameInTypeDescription
    X-Container-Meta-nameheaderstring- Metadata information for the container (bucket)
    - The name part of the header name serves as the metadata's key.
    Content-LengthheaderstringLength of the response result (bytes)
    X-Container-Object-CountheaderintegerNumber of objects in the container (bucket)
    X-Container-Bytes-UsedheaderintegerTotal capacity size used by the container (bucket) (bytes)
    X-Container-Meta-Temp-URL-Key (Optional)headerstringSecret key value for the temporary URL
    X-Container-Meta-Temp-URL-Key-2 (Optional)headerstringSecond secret key value for the temporary URL
    X-Container-Meta-Quota-Count (Optional)headerstringLimit for number of objects in the container (bucket)
    X-Container-Meta-Quota-Bytes (Optional)headerstringCapacity limit of the container (bucket)
    X-Storage-Policy (Optional)headerintegerStorage policy value of the container (bucket)
    X-Container-Read (Optional)headerintegerREAD ACL of the container (bucket)
    X-Container-Write (Optional)headerintegerWRITE ACL of the container (bucket)
    X-TimestampheaderintegerCreation time of the container (bucket) (Unix time)
    X-Trans-IdheaderstringTransaction ID of the request
    X-Openstack-Request-IdheaderstringTransaction ID of the request (same as X-Trans-Id)
    Content-TypeheaderstringFormat of the response result
    DateheaderstringResponse time of the request (UTC)

    Examples

    Request examples (JSON)

    curl -X HEAD "https://archivestorage.apigw.ntruss.com/swift/v1/{containerName}" -H "accept: application/json" -H "x-ncp-region-code: {regionCode}"
    -H "x-ncp-iam-access-key: {AccessKey} " 
    -H "x-ncp-apigw-timestamp: {current timestamp}" 
    -H "x-ncp-apigw-signature-v2: {generated signature}"
    

    Response examples

    HTTP/1.1 200 OK
    Accept: application/json
    connection: keep-alive
    Content-Length: 2577
    Keep-alive: timeout=60
    X-Container-Bytes-Used: 786133
    X-Container-Object-Count: 1
    X-Timestamp: 1634538594.09393
    Content-Type: application/json; charset=utf-8
    X-Trans-Id: tx274a77a8975c4a66aeb24-0052d95365
    X-Openstack-Request-Id: tx274a77a8975c4a66aeb24-0052d95365
    Date: Mon, 18 Apr 2022 11:07:18 GMT
    

    If the request is successful, metadata is returned for that container.


    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.