イメージの詳細情報の照会

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

Container Registryのレジストリに登録されているイメージの詳細情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/ncr/api/v2/repositories/{registry}/{imageName} (韓国リージョン)
GET	/ncr/sgn-api/v2/repositories/{registry}/{imageName} (シンガポールリージョン)
GET	/ncr/jpn-api/v2/repositories/{registry}/{imageName} (日本リージョン)

リクエストヘッダ

Container Registry APIで共通して使用されるヘッダの詳細は、Container Registryのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`registry`	String	Required	情報の照会対象のイメージが登録されているレジストリの名前
`imageName`	String	Required	詳細情報の照会対象イメージの名前 URIエンコード値を使用 <例> `hello/world`の場合、`hello%2Fworld`に変換して使用

リクエスト例

リクエストのサンプルコードは次の通りです。

curl -X GET 'https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}' \ 
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンス構文

レスポンス構文は次の通りです。

{
  "can_edit": "boolean",
  "description": "string",
  "full_description": "string",
  "is_automated": "boolean",
  "is_private": "boolean",
  "last_updated": "number",
  "name": "string",
  "namespace": "string",
  "private_id": "",
  "pull_count": "number",
  "repository_type": "string",
  "star_count": "number",
  "status": "number",
  "tag_mutability_enabled": true,
  "user": "string",
}

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`can_edit`	Boolean	-	使用しない
`description`	String	-	イメージについての short description
`full_description`	String	-	イメージについての詳細な description
`is_automated`	Boolean	-	使用しない
`is_private`	Boolean	-	使用しない
`last_update`	Number	-	イメージの最終更新日 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で返す
`name`	String	-	イメージ名
`namespace`	String	-	レジストリ名
`private_id`	String	-	privateエンドポイントの ID
`pull_count`	Number	-	イメージに対する総 Pull count値
`repository_type`	String	-	使用しない
`star_count`	Number	-	使用しない
`status`	Number	-	使用しない
`tag_mutability_enabled`	Boolean	-	Tag Mutability設定の有無
`user`	String	-	使用しない

レスポンスステータスコード

Container Registry APIで共通して使用されるレスポンスステータスコードの詳細は、Container Registryのレスポンスステータスコードをご参照ください。

レスポンス例

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

{
  "can_edit": true,
  "description": "ncp docker",
  "full_description": "Naver Cloud Platform Docker",
  "is_automated": null,
  "is_private": null,
  "last_updated": 1711928488000,
  "name": "ncpdocker",
  "namespace": "ncpdocker",
  "private_id": "",
  "pull_count": 0,
  "repository_type": "image",
  "star_count": null,
  "status": 0,
  "tag_mutability_enabled": true,
  "user": null
}

Documentation Index