updateTableTag

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

테이블의 태그를 수정합니다. 요청 바디로 전달한 태그 목록으로 기존 태그 전체가 대체됩니다.

요청

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

메서드	URI
PUT	/api/v1/catalogs/{catalogId}/databases/{databaseName}/tables/{tableName}/tag

요청 헤더

Data Catalog API에서 공통으로 사용하는 헤더에 대한 정보는 Data Catalog 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`catalogId`	Integer	Required	카탈로그 아이디 getCatalogs 참조
`databaseName`	String	Required	데이터베이스 이름 getDatabase 참조
`tableName`	String	Required	테이블 이름 getTable 참조

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`tagKeyTypeValueList`	Array	Optional	태그 목록: tagKeyTypeValueList 전달한 목록으로 태그 전체 대체 빈 배열(`[]`) 전달 시 모든 태그 삭제 필드 생략(`null`) 시 태그 변경하지 않음

`tagKeyTypeValueList`

tagKeyTypeValueList에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`tagKey`	String	Required	태그 키 1~64자
`tagType`	String	Required	태그 타입 `STRING` \| `DOUBLE` \| `BOOLEAN` \| `DATETIME`
`tagValue`	String	Required	태그 값 1~256자

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PUT 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/mydatabase/tables/mytable/tag' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "tagKeyTypeValueList": [
        {
            "tagKey": "owner",
            "tagType": "STRING",
            "tagValue": "data-team"
        },
        {
            "tagKey": "pii",
            "tagType": "BOOLEAN",
            "tagValue": "true"
        }
    ]
}'

응답

응답 형식을 설명합니다.

응답 바디

성공 시 본문 없이 204 No Content를 반환합니다.

응답 상태 코드

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

HTTP Status	설명
204	No Content (수정 성공)

Documentation Index