목록¶
GET /api/v1/workspace/accesskey/list
개요¶
현재 워크스페이스 내에서 계정에 바인딩되지 않은 유효한 API Key 기록을 나열합니다.
호출 전 및 사용 단계¶
호출하려면 현재 워크스페이스의 workspace.openAPIKeyManage 권한이 필요합니다. 아래 예시는 일반적으로 사용되는 필드만 발췌한 것입니다. 목록에는 페이지네이션이 없으며, Owner가 아닌 사용자는 Owner Key를 볼 수 없습니다. 기본적으로 Owner 기록이 먼저 정렬되며, 같은 그룹에서는 기록 ID 기준 내림차순으로 정렬됩니다. uuid를 얻은 후 상세를 조회할 수 있습니다. 수동으로 생성되었고 계정에 바인딩되지 않은 워크스페이스 Key의 경우 워크스페이스 Owner가 전체 자격 증명을 읽을 수 있습니다. Owner가 아닌 사용자는 이번에 사용한 이 Key에 대해서만 전체 값을 읽을 수 있으며, 다른 기록은 마스킹됩니다. 개인, Agent 등 다른 출처의 Key도 마스킹됩니다. 로그와 티켓에 기록된 응답은 민감 정보를 제거해야 합니다.
요청 헤더¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스 호출 자격 증명입니다. 기록 UUID와 호출 자격 증명은 서로 다른 필드입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 현재 워크스페이스의 API Key 관리에서 전체 자격 증명을 가져옵니다. |
Query 요청 파라미터¶
| 파라미터명 | 타입 | 필수 | 설명 |
|---|---|---|---|
| search | string | 이름 기준 부분 일치로 검색하며, 생략하거나 비워 두면 필터링하지 않습니다. null 허용: False 예시: 应用가져오기 또는 입력 방법: 워크스페이스 API Key 관리 페이지에서 이름을 복사하거나 이름의 일부를 입력할 수 있습니다. |
|
| orderBy | string | 목록 정렬 필드이며, 생략하면 기본 정렬을 사용합니다. null 허용: False 선택 가능 값: ['createAt', 'callCount', 'lastCallAt'] 예시: lastCallAt가져오기 또는 입력 방법: 필요에 따라 생성 시간 createAt, 호출 횟수 callCount 또는 최근 호출 lastCallAt을 선택합니다. |
|
| order | string | 기본값 desc이며, orderBy와 함께 사용합니다. null 허용: False 선택 가능 값: ['asc', 'desc'] 예시: desc가져오기 또는 입력 방법: 오름차순 asc 또는 내림차순 desc를 선택합니다. |
파라미터 추가 설명¶
예시의 리소스 식별자는 자리 표시자이므로 대상 워크스페이스의 실제 값으로 바꿔야 합니다.
요청 예시¶
curl --get -H "DF-API-KEY: <DF-API-KEY>" \
'https://openapi.guance.com/api/v1/workspace/accesskey/list' \
--data-urlencode "search=应用" \
--data-urlencode "orderBy=lastCallAt" \
--data-urlencode "order=desc"
응답¶
HTTP 200, application/json.
| 필드 | 타입 | 설명 |
|---|---|---|
| content | array<object> |
조건에 맞는 Key 기록입니다. |
| content[].uuid | string | API Key 기록의 UUID이며, 일반적인 접두사는 wsak_입니다. API Key 관리 API의 경로에 사용됩니다. |
| content[].name | string | API Key의 이름입니다. |
| content[].workspaceUUID | string | 소속 워크스페이스입니다. |
| content[].createdWay | string | API Key의 생성 출처입니다. |
| content[].remark | string | API Key의 비고입니다. |
| content[].isOwnerRole | integer 또는 boolean | 해당 API Key에 워크스페이스 소유자 역할이 있는지 여부입니다. |
| content[].callCount | integer | 기록된 호출 횟수입니다. |
| content[].lastCallAt | integer | 마지막으로 기록된 호출 시간(Unix 초)이며, 기록이 없으면 -1일 수 있습니다. |
| content[].createAt | integer | 기록 생성 시간(Unix 초)입니다. |
| content[].accountUUID | string | 명시적으로 바인딩된 계정 UUID이며, 바인딩되지 않은 경우 빈 문자열입니다. |
| content[].effectiveAccountUUID | string | 인증에 사용되는 신원 식별자입니다. 바인딩되지 않은 경우 해당 API Key 기록의 UUID입니다. |
| content[].accountInfo | object 또는 null | 바인딩된 계정 정보이며, 바인딩되지 않은 경우 null입니다. |
| content[].roles | array<object> |
유효한 역할 집합이며, 순서는 고정되지 않습니다. |
| content[].roles[].uuid | string | 역할 UUID입니다. |
| content[].roles[].name | string | 역할 이름입니다. |
| content[].permissions | array<string> |
유효한 권한 식별자 집합이며, 순서는 고정되지 않습니다. |
| content[].rolePermissions | object | 각 역할이 보유한 권한 식별자로, 역할 UUID를 키로 하고 권한 문자열 배열을 값으로 합니다. |
| content[].declaration | object 또는 null | 워크스페이스 선언입니다. |
| content[].ak | string | Access Key 식별자입니다. 현재 신원에 따라 마스킹될 수 있습니다. |
| content[].sk | string | Secret Key 자격 증명입니다. 현재 신원에 따라 마스킹될 수 있습니다. 응답은 민감 정보로 처리해야 합니다. |
| content[].creatorInfo | object | 생성자 정보이며, 조회할 수 없으면 빈 객체입니다. |
{
"code": 200,
"content": [
{
"uuid": "wsak_example",
"name": "应用数据读取",
"workspaceUUID": "wksp_example",
"createdWay": "manual",
"remark": "",
"isOwnerRole": 0,
"callCount": 14,
"lastCallAt": 1785427200,
"createAt": 1785423600,
"accountUUID": "",
"effectiveAccountUUID": "wsak_example",
"accountInfo": null,
"roles": [
{
"uuid": "role_example",
"name": "应用数据只读"
}
],
"permissions": [
"routine.defaultAccess"
],
"rolePermissions": {
"role_example": [
"routine.defaultAccess"
]
},
"declaration": null,
"ak": "*************abcd",
"sk": "*************ef01",
"creatorInfo": {}
}
],
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
오류 응답¶
인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.
| HTTP 상태 | errorCode | 트리거 조건 | 메시지 또는 응답 설명 | 처리 방법 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 선언되지 않은 파라미터 전달 또는 파라미터 값 검증 실패 | 파라미터 검증에 실패했으며, 메시지에 유효하지 않은 필드가 표시됩니다. | 각 필드의 위치와 선택 가능한 값을 확인합니다. |