콘텐츠로 이동

나열¶

GET /api/v1/workspace/accesskey/list

개요¶

키 목록 가져오기

쿼리 요청 매개변수¶

매개변수명	유형	필수	설명
search	string		이름으로 검색 예시: supper_workspace 비워 두기 가능: False
orderBy	string		정렬 필드, createAt / callCount / lastCallAt 지원 예시: callCount 비워 두기 가능: False 선택 가능 값: ['createAt', 'callCount', 'lastCallAt']
order	string		정렬 방향, asc / desc 지원, 기본값 desc 예시: desc 비워 두기 가능: False 선택 가능 값: ['asc', 'desc']

매개변수 추가 설명¶

생성 API는 여전히 새 API Key의 평문 ak/sk를 반환합니다. 본 API를 호출하는 OpenAPI API Key가 owner 역할을 가지고 있는 경우, 조회 API는 워크스페이스 API Key의 평문 ak/sk를 반환합니다. owner 역할이 아닌 경우, 현재 호출 자격 증명 자체에 해당하는 워크스페이스 API Key 레코드만 평문 ak/sk를 반환하며, 다른 레코드는 마스킹된 ak/sk(마지막 4자리만 유지)를 반환합니다. 이 규칙은 개인 API Key에는 적용되지 않습니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/workspace/accesskey/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

응답¶

{
    "code": 200,
    "content": [
        {
            "callCount": 12,
            "createAt": 1677808718,
            "creator": "acnt_xxxx32",
            "creatorInfo": {
                "email": "xxx@guance.com",
                "iconUrl": "",
                "name": "88Test",
                "username": "Test"
            },
            "deleteAt": -1,
            "id": 4,
            "lastCallAt": 1677809718,
            "name": "test",
            "sk": "xxx",
            "status": 0,
            "updateAt": 1677808718,
            "updator": "acnt_xxxx32",
            "uuid": "xxx",
            "workspaceUUID": "wksp_xxxx32"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B73F5F23-046C-4A84-8B33-D028C92994C4"
}