レジストリリストの照会

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

Container Registryに登録されているレジストリリストを照会します。

リクエスト

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

メソッド	URI
GET	/repositories

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`page`	Number	Optional	照会するページ番号ページ番号は0より大きい値を入力
`pagesize`	Number	Optional	照会するページサイズページサイズは0より大きい値を入力

リクエスト例

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

curl -X GET "https://ncr.apigw.ntruss.com/ncr/api/v2/repositories" 
-H "Content-Type: application/json; charset=utf-8"
-H "x-ncp-apigw-timestamp: {Timestamp}"
-H "x-ncp-iam-access-key: {Sub Account Access Key}"
-H "x-ncp-apigw-signature-v2: {API Gateway Signature}"

レスポンス

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

レスポンス構文

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

{
    "count": "number",
    "next": "number",
    "previous": "number",
    "results": [
        {
            "bucket": "string",
            "created": "number",
            "end_point": "string",
            "end_point_enabled": "boolean",
            "name": "string",
            "private_end_point": "string",
            "private_id": "string",
            "public_reg_status": "boolean",
            "scan_on_push_enabled": "boolean",
            "status": "string"
        }
    ]
}

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`count`	Number	-	登録されているレジストリの総数
`next`	Number	-	次のページの番号次のページがない場合、`null`を返す
`previous`	Number	-	以前のページの番号以前のページがない場合、`null`を返す
`results[].bucket`	String	-	レジストリと連携されている Object Storageのバケット名
`results[].created`	Number	-	レジストリの作成日
`results[].end_point`	String	-	Dockerクライアントがレジストリにアクセスするためのエンドポイント
`results[].end_point_enabled`	Boolean	-	エンドポイントにアクセス可能かどうか
`results[].name`	String	-	レジストリ名
`results[].private_end_point`	String	-	Dockerクライアントがレジストリにアクセスするためのエンドポイント NAVERクラウドプラットフォームの VPCネットワークでのみ使用可能
`results[].private_id`	String	-	Privateエンドポイントの ID
`results[].public_reg_status`	Boolean	-	認証なしでアクセスしたユーザーの Pull権限の有無 `true` \| `false`
`results[].scan_on_push_enabled`	Boolean	-	コンテナイメージのアップロード時に脆弱性を自動でスキャンするかどうか `true` \| `false`
`results[].status`	String	-	レジストリと Object Storageの連携状態 `running` \| `disconnected` `running`: 正常 `disconnected`: バケットが削除される

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

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

レスポンス例

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

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "bucket": "ncpdocker",
            "created": 1711695272000,
            "end_point": "ncpdocker.kr.ncr.ntruss.com",
            "end_point_enabled": true,
            "name": "ncpdocker",
            "private_end_point": "pdxxxnzd.kr.private-ncr.ntruss.com",
            "private_id": "pdxxxnzd",
            "public_reg_status": false,
            "scan_on_push_enabled": false,
            "status": "running"
        }
    ]
}