이미지 정보 수정

Classic/VPC 환경에서 이용 가능합니다.

Container Registry의 레지스트리에 등록된 이미지에 대한 짧은 설명(description), 상세 설명(full_description) 정보를 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
PATCH	/ncr/kr/v2/repositories/{registry}/{imageName} (수도권 리전)
PATCH	/ncr/krs/v2/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://gov-ncr.apigw.gov-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}' \
--data '{
  "description": "string",
  "full_description": "string"
}'

응답

응답 형식을 설명합니다.

응답 구문

응답 구문은 다음과 같습니다.

없음

응답 상태 코드

Container Registry API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Container Registry 응답 상태 코드를 참조해 주십시오.