head-object

Classic/VPC環境で利用できます。

Ncloud Storageに保存したオブジェクトのメタデータを照会します。

コマンド

コマンド構文は次の通りです。

aws s3api head-object --bucket <value> --key <value> [--options]

パラメータ

パラメータの説明は次の通りです。

パラメータ	タイプ	必須の有無	説明	制限事項
--bucket <value>	string	Y	オブジェクトが保存されているバケットの名前	-
--key <value>	string	Y	照会対象オブジェクトの名前(key値)	-
--endpoint-url <value>	string	Y	コマンド呼び出しのデフォルト URLを指定	krリージョンのみ対応、呼び出しドメイン情報はNcloud Storageの概要を参照
--range <value>	string	N		-
--version-id <value>	string	N	バージョン管理が適用されたバケットで特定のバージョンのオブジェクトを照会する場合、バージョン IDを指定	-
--part-number <value>	string	N	オブジェクトの一部パートのみ照会する場合、照会対象のパート番号を指定	-
--cli-input-json \| --cli-input-yaml	string	N	提供した jsonまたは yaml文字列で引数を入力	jsonと yamlは一緒に指定できない
--generate-cli-skeleton <value>	integer	N	APIコマンドを実行せずに、後に inputとして使用できるパラメータテンプレートを作成	-
--debug	boolean	N	デバッグロギングを使用	-
--no-verify-ssl	boolean	N	SSL証明書を検証する基本動作を再定義	-
--no-paginate	boolean	N	自動 pagination無効化、結果に対して最初のページが一度だけ呼び出される	-
--output <value>	string	N	レスポンスの形式を指定	選択可能なオプション json text table yaml yaml-stream
--query <value>	string	N	レスポンスデータの絞り込みに使用する JMESPathクエリ	-
--profile <value>	string	N	認証情報ファイルで特定の profileを使用	-
--region <value>	string	N	リージョンを指定	krのみ対応
--color <value>	string	N	output color設定	選択可能なオプション on off auto
--no-sign-request	boolean	N	認証情報のロードを無効化	-
--ca-bundle <value>	string	N	SSL証明書の確認時に使用する CA証明書を指定	-
--cli-read-timeout <value>	int	N	最大読み取り時間、0を入力するとタイムアウトではなく、ブロック状態に変更される	デフォルトは60秒に設定
--cli-connect-timeout <value>	int	N	最大接続時間、0を入力するとタイムアウトではなく、ブロック状態に変更される	デフォルトは60秒に設定
--no-cli-pager	boolean	N	レスポンスの cli pagerを無効化	-
--cli-auto-prompt	boolean	N	CLI入力パラメータの自動プロンプト設定	-
--no-cli-auto-prompt	boolean	N	CLI入力パラメータの自動プロンプトを無効化	-
--sse-customer-algorithm	string	N	ユーザー暗号化アルゴリズム (AES256)	-
--sse-customer-key	string	N	ユーザー提供の暗号化キー	-
--sse-customer-key-md5	string	N	ユーザー提供暗号化キーの MD5	-

権限

Sub Accountユーザーがこのコマンドを使用するには、View/GetObjectアクションの権限が必要です。

例

head-objectコマンドの呼び出し例とレスポンス例を説明します。

オブジェクトのメタデータの照会

呼び出し例

オブジェクトが保存されているバケットとオブジェクト名を指定してコマンドを呼び出すと、オブジェクトのメタデータを照会できます。呼び出しのサンプルコードは次の通りです。

aws s3api head-object --bucket bucket-a --endpoint-url=https://kr.ncloudstorage.com --key img/image.png

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "AcceptRanges": "bytes",
    "LastModified": "2025-03-25T06:20:52+00:00",
    "ContentLength": 81115,
    "ETag": "\"d1e234562633b9b9ab503cdef8b460bb\"",
    "VersionId": "4a784bcd-8765-11f0-954d-d4f5ef94c2b0",
    "ContentType": "binary/octet-stream",
    "Metadata": {},
    "StorageClass": "DEEP_ARCHIVE"
}