삭제¶
GET /api/v1/workspace/accesskey/{ak_uuid}/delete
개요¶
현재 워크스페이스의 API Key를 소프트 삭제하고 해당 자격 증명을 무효화합니다.
호출 전 및 사용 단계¶
현재 워크스페이스에서 workspace.openAPIKeyManage 권한이 있는 OpenAPI Key를 사용합니다. 라우트 선언에는 freeEdition 버전 제한이 표시되어 있지만 현재 OpenAPI 인증 체인에서는 해당 버전 검사를 수행하지 않으므로, 버전 자체를 반드시 403이라고 설명할 수는 없습니다. 가용성은 배포 및 실제 권한에 따라 확인해야 합니다. 리소스 범위는 항상 요청 헤더 Key가 속한 워크스페이스를 사용하며, Body로 워크스페이스를 전환할 수 없습니다. owner Key는 현재 ID에 owner가 포함되어야 하며, 인터페이스 관리 권한 자체가 이 검사를 대체하지 않습니다.
이것은 부수 효과가 있는 GET 인터페이스이므로 웹 페이지 링크, 자동 프리페치 또는 헬스 체크에 넣지 마십시오. 먼저 모든 사용처가 마이그레이션되었는지 확인한 후 리소스 UUID로 호출합니다. 시스템이 아니고 삭제되지 않은 Key는 삭제할 수 있으며, 비활성화된 이력 Key도 포함됩니다. Key 삭제 및 유효한 역할 연결을 완료한 후 제출하고, 그다음 이전 ak/sk를 무효 캐시로 기록합니다. 현재 Key는 자신을 삭제할 수 있으며 현재 요청은 종료될 수 있습니다. 후속 호출은 다른 유효한 Key를 사용해야 합니다.
일치하지 않는 경우(존재하지 않음/교차 워크스페이스/이미 삭제됨/시스템 Key)에도 content=true를 반환하며, 이번 호출에서 대상이 삭제되었음을 증명하지 않습니다. 이미 삭제된 원래 UUID로 재시도해도 이름을 기준으로 새 Key를 삭제하지 않습니다. 바인딩된 agent 계정에 해당하고 createdWay=agent인 경우 이 진입점에서 삭제할 수 없으며, 계정 전용 절차를 사용합니다. owner Key에는 owner 자격이 필요합니다. 삭제는 워크스페이스나 계정을 삭제하지 않으며, 이미 실행을 시작한 작업을 취소하지도 않습니다.
데이터베이스는 먼저 커밋한 후 캐시를 업데이트합니다. 500 또는 타임아웃 발생 시 다른 관리 Key로 대상과 역할 상태를 확인한 후 원래 UUID로 처리해야 하며, true 값만으로 모든 노드가 즉시 무효화되었다고 판단할 수는 없습니다.
라우트 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| ak_uuid | string | Y | 현재 워크스페이스의 Key 리소스 UUID이며, ak/sk 평문 또는 다른 워크스페이스 UUID를 입력할 수 없습니다. 예시: wsak_example가져오기 또는 입력 방법: API Key 목록의 content[].uuid 또는 생성 응답의 content.uuid에서 가져오며, 필요한 경우 API Key 상세로 확인합니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
파라미터 추가 설명¶
부수 효과가 있는 GET이며, 삭제 후 자격 증명이 무효화됩니다. 호출 전에 사용처를 마이그레이션하고 다른 유효한 관리 Key를 보관합니다.
요청 예시¶
curl --get 'https://openapi.guance.com/api/v1/workspace/accesskey/wsak_example/delete' \
-H 'DF-API-KEY: <DF-API-KEY>'
응답¶
HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여 줍니다.
| 필드 | 유형 | 설명 |
|---|---|---|
| content | boolean | 처리 완료 시 true이며, 일치하는 항목이 없어도 true입니다. 삭제 수/Key 정보는 반환하지 않습니다. |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하십시오.
| HTTP 상태 | errorCode | 발생 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 400 | ft.AgentWorkspaceAKCanNotDelete | accountUUID가 비어 있지 않고 createdWay=agent인 agent 계정 바인딩 자격 증명에 해당 | agent에 바인딩된 API Key는 삭제할 수 없습니다 | 바인딩 계정 전용 수명 주기 프로세스로 관리하고, 계정 공유 자격 증명은 삭제하지 않습니다. |
| 403 | ft.Forbidden | 관리 권한 부족 또는 owner가 아닌 사용자가 owner Key를 삭제 | 작업 권한이 없습니다 | 해당 권한과 owner 자격을 사용하십시오. |
| 500 | ft.InternalServerError | 데이터베이스 또는 자격 증명 캐시 무효화 실패; 로테이션/삭제가 이미 커밋된 후 오류가 반환될 수 있음 | 내부 오류 | 먼저 다른 유효한 관리 Key로 원래 UUID와 상태를 읽습니다. 로테이션 응답이 유실되고 이전 Key가 이미 무효화된 경우 다른 유효한 관리 Key로 다시 로테이션하고 새 자격 증명을 안전하게 수신합니다. 이미 무효화된 이전 Key로 반복 재시도하지 마십시오. |