Login
      目次 x
      API V2ガイド
        • 印刷する
        • PDF
        目次

        API V2ガイド

          • 印刷する
          • PDF
          Article Summary

          基本情報

          API URL

          KR: https://ncr.apigw.ntruss.com/ncr/api
SGN: https://ncr.apigw.ntruss.com/ncr/sgn-api
JPN: https://ncr.apigw.ntruss.com/ncr/jpn-api

          API Header

          項目Mandatory説明
          Content-TypeMandatoryリクエストBody Content Typeをapplication/jsonに指定
          x-ncp-apigw-timestampMandatory1970年1月1日 00:00:00協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)に表したものです。
          API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとしてみなします。
          x-ncp-iam-access-keyMandatoryポータルまたはSub Accountから発行されたAccess Key ID
          x-ncp-apigw-signature-v2Mandatory上記の例題のBodyをAccess Key IdとマッピングされたSecretKeyで暗号化した署名
          HMAC暗号化のアルゴリズムはHmacSHA256を使用

          NAVER Cloud Platform認証キー及びSignature作成ガイドの表示

          Container Registry API V2

          Registryリスト返却

          Container Registryに登録されたRegistryリストを返します。

          リクエストURL

          GET https://ncr.apigw.ntruss.com/ncr/api/v2/repositories

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Headers

          API Headerの表示

          Parameters

          項目MandatoryType説明備考
          page-numberページ番号照会するページ番号、ページ番号は0より大きい値を入力
          pagesize-numberページサイズ照会するページサイズ、ページサイズは0より大きい値を入力

          レスポンスBody

          {
  "count": "number",
  "next": "number",
  "previous": "number",
  "results": [
    {
      "name": "string",
      "bucket": "string",
      "end_point": "string",
      "usage": "string",
      "created": "number",
      "status": "string"
    }
  ]
}
          項目Type説明備考
          countnumber登録されたレジストリの数
          nextnumber次ページの番号、次ページがない場合はNullを返却
          previousnumber以前ページの番号、 以前ページがない場合はNullを返却
          results[].namestringレジストリ名
          results[].bucketstringレジストリを連携されたObject StorageのBucket名
          results[].end_pointstringDocker Clientが Registryにアクセスするためのエンドポイント
          results[].creatednumberレジストリの作成日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却
          results[].statusstringレジストリのステータスを返却Object Storageとの連携ステータスを表示、正常状態であれば runningを返却、Bucketが削除されている場合は disconnectedを返却

          レスポンスStatus

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          500Internal Server Error

          新規Registry登録

          Object StorageのBucketと連携されたRegistryを作成します。

          リクエストURL

          POST https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名作成するレジストリ名

          Headers

          API Headerの表示

          リクエストBody

          {
  "bucket": "string"
}
          項目MandatoryType説明備考
          bucketMandatorystringBucket名作成されるレジストリと連携されるObject StorageのBucket名、重複使用不可

          レスポンスBody

          {
  "returnCode": "string",
  "returnMessage": "string"
}
          項目Type説明備考
          returnCodestringリターンコード
          returnMessagestringリターンメッセージ

          レスポンスStatus

          HTTP StatusDesc
          201OK
          400Bad Request
          401Unauthorized
          403Forbidden
          409Conflict
          500Internal Server Error

          Registry削除

          特定のRegistryを削除します。

          リクエストURL

          DELETE https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名削除するレジストリ名

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          なし

          レスポンスStatus

          HTTP StatusDesc
          204OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImageリスト返却

          レジストリ内に登録されたImageのリストを返します。

          リクエストURL

          GET https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名イメージリストを照会するレジストリ名

          Parameters

          項目MandatoryType説明備考
          page-numberページ番号照会するページ番号、ページ番号は0より大きい値を入力
          pagesize-numberページサイズ照会するページサイズ、ページサイズは0より大きい値を入力

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          {
  "count": "number",
  "next": "number",
  "previous": "number",
  "results": [
    {
      "user": "string",
      "name": "string",
      "namespace": "string",
      "repository_type": "string",
      "status": "number",
      "description": "string",
      "is_private": "boolean",
      "is_automated": "boolean",
      "can_edit": "boolean",
      "star_count": "number",
      "pull_count": "number",
      "last_updated": "number"
    }
  ]
}
          項目Type説明備考
          countnumber登録されたレジストリの数
          nextnumber次ページの番号、次ページがない場合はNullを返却
          previousnumber以前ページの番号、 以前ページがない場合はNullを返却
          result[].userstring不使用不使用
          result[].namestringイメージ名
          result[].namespacestringレジストリ名
          result[].repository_typestring不使用不使用
          result[].statusnumber不使用不使用
          result[].descriptionstringイメージに対するshort description
          result[].is_privateboolean不使用不使用
          result[].is_automatedboolean不使用不使用
          result[].can_editboolean不使用不使用
          result[].star_countnumber不使用不使用
          result[].pull_countnumberイメージ対する総Pull countの値
          result[].last_updatenumberイメージの最近変更日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却

          レスポンスStatus

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImage情報返却

          レジストリ内に登録されたImageの詳細情報を返します。

          リクエストURL

          GET https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名詳細イメージを照会するレジストリ名
          imageNameMandatorystringイメージ名詳細情報の照会対象イメージ名、URI Encodingした値を使う必要がある。(e.g. hello/worldの場合はhello%2Fworldに変換して使用)

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          {
  "user": "string",
  "name": "string",
  "namespace": "string",
  "repository_type": "string",
  "status": "number",
  "description": "string",
  "is_private": "boolean",
  "is_automated": "boolean",
  "can_edit": "boolean",
  "star_count": "number",
  "pull_count": "number",
  "last_updated": "number",
  "has_starred": "boolean",
  "full_description": "string",
  "affiliation": "string",
  "permissions": {
    "read": "boolean",
    "write": "boolean",
    "admin": "boolean"
  }
}
          項目Type説明備考
          userstring不使用不使用
          namestringイメージ名
          namespacestringレジストリ名
          repository_typestring不使用不使用
          statusnumber不使用不使用
          descriptionstringイメージに対するshort description
          is_privateboolean不使用不使用
          is_automatedboolean不使用不使用
          can_editboolean不使用不使用
          star_countnumber不使用不使用
          pull_countnumberイメージに対する総Pull countの値
          last_updatenumberイメージの最近変更日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却
          has_starredboolean不使用不使用
          full_descriptionstringイメージに対する詳細description
          affiliationboolean不使用不使用
          permissionsobject不使用不使用

          レスポンスStatus

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImageの情報修正

          レジストリに登録されたイメージに対するdescription、full_descriptionをアップデートします。

          リクエストURL

          PATCH https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名情報を変更するイメージがあるレジストリ名
          imageNameMandatorystringイメージ名情報を変更するイメージ名、URI Encodingした値を使用する必要がある。(e.g. hello/worldの場合、hello%2Fworldに変換して使用)

          Headers

          API Headerの表示

          リクエストBody

          {
  "description": "string",
  "full_description": "string"
}
          項目MandatoryType説明備考
          description-stringイメージに対する短い説明を作成
          full_description-stringイメージに対する詳細説明を作成Markdownサポート

          レスポンスBody

          なし

          レスポンスStatus

          HTTP StatusDesc
          204OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImage削除

          レジストリに登録されたイメージを削除します。

          リクエストURL

          DELETE https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名削除対象のイメージがあるレジストリ名
          imageNameMandatorystringイメージ名削除するイメージ名、URI Encodingした値を使用する必要がある。(e.g. hello/worldの場合、hello%2Fworldに変換して使用)

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          なし

          レスポンスStatus

          HTTP StatusDesc
          204OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImageのTagリスト返却

          レジストリのイメージに登録されたTagリストを返します。

          リクエストURL

          GET https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}/tags

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名タグを返却するイメージがあるレジストリ名
          imageNameMandatorystringイメージ名タグを返却するイメージ名、URI Encodingした値を使用する必要がある。(e.g. hello/worldの場合、hello%2Fworldに変換して使用)

          Parameters

          項目MandatoryType説明備考
          page-numberページ番号照会するページ番号、ページ番号は0より大きい値を入力
          pagesize-numberページサイズ照会するページサイズ、ページサイズは0より大きい値を入力

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          {
  "count": "number",
  "next": "number",
  "previous": "number",
  "results": [
    {
      "name": "string",
      "full_size": "number",
      "images": [
        {
          "size": "number",
          "architecture": "string",
          "variant": "string",
          "features": "string",
          "os": "string",
          "os_version": "string",
          "os_features": "string",
          "created": "number"
        }
      ],
      "id": "number",
      "repository": "number",
      "creator": "string",
      "last_updater": "string",
      "last_updated": "number",
      "image_id": "number",
      "v2": "boolean"
    }
  ]
}
          項目Type説明備考
          countnumber登録されたレジストリの数
          nextnumber次ページの番号、次ページがない場合はNullを返却
          previousnumber以前ページの番号、 以前ページがない場合はNullを返却
          result[].namestringタグ名
          result[].full_sizenumberタグサイズ
          result[].images[].sizenumberイメージサイズ
          result[].images[].architecturestringamd64あるいはppc64leのようなCPUアーキテクチャ
          result[].image[].featuresstring不使用不使用
          result[].image[].osstringlinux あるいはwindowsのようなオペレーティングシステム
          result[].image[].os_versionstring不使用不使用
          result[].image[].os_featuresstring不使用不使用
          result[].image[].createdstringイメージ作成日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却
          result[].idnumberタグID
          result[].repositorynumberレジストリID
          result[].creatorstringイメージ登録者ID不使用
          result[].last_updaterstringイメージ登録者ID不使用
          result[].last_updatedstringイメージの最近変更日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却
          result[].image_idnumberイメージID
          result[].v2booleanイメージに対するv2スペック適用有無

          レスポンスStatus

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImageの特定Tag情報返却

          レジストリのイメージに登録された特定Tagの詳細情報を返します。

          リクエストURL

          GET https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}/tags/{reference}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名詳細タグ 情報を返却するイメージがあるレジストリ名
          imageNameMandatorystringイメージ名詳細タグ情報を返却するイメージ名、URI Encodingした値を使用する必要がある。(e.g. hello/worldの場合、hello%2Fworldに変換して使用)
          referenceMadatorystringタグ名詳細情報を照会するタグ名

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          {
  "name": "string",
  "full_size": "number",
  "images": [
    {
      "size": "number",
      "architecture": "string",
      "variant": "string",
      "features": "string",
      "os": "string",
      "os_version": "string",
      "os_features": "string",
      "created": "number"
    }
  ],
  "id": "number",
  "repository": "number",
  "creator": "string",
  "last_updater": "string",
  "last_updated": "number",
  "image_id": "number",
  "v2": "boolean"
}
          項目Type説明備考
          namestringタグ名
          full_sizenumberタグサイズ
          images[].sizenumberイメージサイズ
          images[].architecturestringイメージの動作環境
          image[].featuresstring不使用不使用
          image[].osstringイメージ実行環境
          image[].os_versionstring不使用不使用
          image[].os_featuresstring不使用不使用
          image[].createdstringイメージ作成日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却
          idnumberタグID
          repositorynumberレジストリID
          creatorstringイメージ登録者ID不使用
          last_updaterstringイメージ登録者ID不使用
          last_updatedstringイメージ最近変更日1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で返却
          image_idnumberイメージID
          v2booleanイメージに対するv2スペック適用有無

          レスポンスStatus

          HTTP StatusDesc
          200OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Registry内に登録されたImageの特定Tag削除

          レジストリのイメージに登録された特定Tagを削除します。

          リクエストURL

          DELETE https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}/tags/{reference}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

          Path Variables

          項目MandatoryType説明備考
          registryMandatorystringレジストリ名削除するイメージのタグがあるレジストリ名
          imageNameMandatorystringイメージ名削除するタグのイメージ名、URI Encodingした値を使用する必要がある。(e.g. hello/worldの場合、hello%2Fworldに変換して使用)
          referenceMadatorystringタグ名削除するタグ名

          Headers

          API Headerの表示

          リクエストBody

          なし

          レスポンスBody

          なし

          レスポンスStatus

          HTTP StatusDesc
          204OK
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error
          この記事は役に立ちましたか?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          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.
          Logout