• PDF


  • PDF


Searches the metadata of containers (buckets).


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


Request header

Header name Description
x-ncp-apigw-timestamp This 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-key This is the access key ID issued by the NCP portal or Sub Account.
x-ncp-apigw-signature-v2 Signature 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_code The region code of where the bucket of the data to be migrated from another cloud to NAVER Cloud is located

Request parameter

Parameter name Requirement status Type Restrictions Description
ContainerName - string - Name of the container to search


Response header

Name In Type Description
X-Container-Meta-name header string - Metadata information for the container (bucket)
- The name part of the header name serves as the metadata's key.
Content-Length header string Length of the response result (bytes)
X-Container-Object-Count header integer Number of objects in the container (bucket)
X-Container-Bytes-Used header integer Total capacity size used by the container (bucket) (bytes)
X-Container-Meta-Temp-URL-Key (Optional) header string Secret key value for the temporary URL
X-Container-Meta-Temp-URL-Key-2 (Optional) header string Second secret key value for the temporary URL
X-Container-Meta-Quota-Count (Optional) header string Limit for number of objects in the container (bucket)
X-Container-Meta-Quota-Bytes (Optional) header string Capacity limit of the container (bucket)
X-Storage-Policy (Optional) header integer Storage policy value of the container (bucket)
X-Container-Read (Optional) header integer READ ACL of the container (bucket)
X-Container-Write (Optional) header integer WRITE ACL of the container (bucket)
X-Timestamp header integer Creation time of the container (bucket) (Unix time)
X-Trans-Id header string Transaction ID of the request
X-Openstack-Request-Id header string Transaction ID of the request (same as X-Trans-Id)
Content-Type header string Format of the response result
Date header string Response time of the request (UTC)


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?

What's Next