イメージ情報の変更

Prev Next

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

Container Registryのレジストリに登録されているイメージに関する短い説明(description)、詳細説明(full_description)情報を変更します。

リクエスト

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

メソッド URI
PATCH /repositories/{registry}/{imageName}

リクエストヘッダ

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

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

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

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

リクエスト構文

リクエスト構文は次の通りです。

{
  "description": "string",
  "full_description": "string"
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
description String Optional イメージについての短い説明を記入
  • 100文字以内
full_description String Optional イメージについての詳細説明を記入
  • Markdownをサポート

リクエスト例

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

curl -X PATCH "https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}" 
-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}"
-d "
{
  "description": "string",
  "full_description": "string"
}
"

レスポンス

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

レスポンス構文

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

なし

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

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