콘텐츠로 이동

조회 가능한 워크스페이스 목록



GET /api/v1/wksp_share/granted_ws_list

개요

권한 부여 측 사이트별로 현재 워크스페이스에서 조회할 수 있는 권한이 부여된 워크스페이스를 나열합니다.

호출 전 준비 및 사용 단계

대상 워크스페이스에 routine.defaultAccess 등 읽기 권한이 허용된 OpenAPI Key를 사용합니다. 현재 워크스페이스는 요청 헤더의 Key에서 가져오며, 이 진입점에서 workspaceUUID를 전달해 전환하지 않습니다.

현재 워크스페이스에 명시적으로 권한이 부여된 활성 권한 부여 기록을 반환하며, 전체 사이트 또는 동일 조직 워크스페이스 목록이 아닙니다. 권한 부여 상태는 유효한 active여야 합니다. 교차 사이트 mirror 동기화가 실패했고 리소스 요약이 전혀 없으면 제외되며, 이전 요약이 있으면 여전히 반환될 수 있습니다. 여러 namespace를 요구할 때는 동일한 권한 부여에 모든 유형이 포함되어야 하며, 서로 다른 권한 부여를 하나로 합쳐 조건을 충족시키지 않습니다.

먼저 content[].regionCode를 가져온 뒤 각 data[].workspaceUUID로 교차 워크스페이스 조회 대상을 구성합니다. type/indexes/conditions 및 실제 조회 권한은 여전히 준수해야 합니다. 목록에 표시된다고 해서 현재 호출 Key에 각 데이터 유형의 조회 권한이 있거나 소스 워크스페이스가 잠겨 있지 않거나 조회 다운스트림이 사용 가능한 것은 아닙니다. 동일 사이트의 잠금 상태 안내와 교차 사이트의 알 수 없음 null은 구분해야 합니다.

소스 사이트별로 그룹화하며 각 그룹은 독립적으로 페이지가 나뉩니다. 동일한 pageIndex/pageSize가 모든 그룹에 사용되며, 각 그룹의 pageInfo는 content[].pageInfo에 있고 최상위에는 pageInfo가 없습니다. 총 개수를 아직 다 읽지 못한 사이트는 각각 이어서 조회하고, regionCode로 한 그룹을 고정해 페이지 누락을 방지하는 것이 좋습니다. 사이트에 유효한 설정이 없는 일반 기록은 무시될 수 있으며, 외부 조직 교차 사이트에 자체 사이트 정보가 있으면 여전히 표시될 수 있습니다. 빈 결과는 []입니다.

요청 헤더

매개변수 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 매개변수

매개변수 이름 유형 필수 설명
filterWsUUIDs commaArray 선택 사항이며 이러한 소스 워크스페이스만 필터링합니다. 현재 구현은 쉼표로 분리할 때 각 항목의 공백을 자동으로 trim하지 않으므로 호출자는 공백을 피해야 합니다. 수신 측 워크스페이스 목록이 아닙니다.
null 허용: False
예시: wksp_source_example
가져오기 또는 입력 방법: 권한 부여 측 workspaceUUID를 사용하며, 여러 항목은 영문 쉼표로 구분합니다.
namespace commaArray 선택 사항이며 쉼표로 구분하고 trim 후 빈 항목을 제거합니다. 여러 유형은 동일한 유효 권한 부여에 모든 유형이 동시에 포함되어야 하며, 권한 부여 *는 전체 유형을 충족합니다. 알 수 없는 유형은 사용 가능한 권한 부여와 동일하지 않으며 일반적으로 일치하는 항목이 없습니다.
null 허용: False
예시: logging,tracing
가져오기 또는 입력 방법: 조회할 데이터 유형(예: logging/metric/tracing/rum/lineage/incidents)을 사용하며, 이미 부여된 type을 기준으로 합니다.
pageIndex integer 선택 사항, 기본값 1, 최소 1입니다. 동일한 페이지 번호가 각 사이트 그룹에 적용되며 전체 사이트 통합 페이징이 아닙니다.
null 허용: False
$minValue: 1
예시: 1
가져오기 또는 입력 방법: 1부터 시작하여 각 사이트 그룹별로 페이지를 각각 읽습니다.
pageSize integer 선택 사항, 기본값 100, 최대 100입니다. 총 반환 건수는 pageSize보다 클 수 있습니다.
null 허용: False
$maxValue: 100
$minValue: 1
예시: 100
가져오기 또는 입력 방법: 각 사이트에서 기대하는 페이지당 건수 1..100입니다.
regionCode string 선택 사항인 권한 부여 측 사이트 코드입니다. 서비스는 일반 접두사와 custom: 접두사가 동일한 코드인 경우를 호환하며, 이후 조회에서도 반환값에 따라 사용합니다.
null 허용: False
예시: site_example
가져오기 또는 입력 방법: 사이트 목록 또는 이 API의 content[].regionCode에서 가져옵니다.
search string 선택 사항이며 권한 부여 측 workspaceName/workspaceUUID에서 포함 검색을 수행하고 대상 이름은 검색하지 않습니다.
null 허용: False
예시: production
가져오기 또는 입력 방법: 소스 워크스페이스 이름 또는 UUID 키워드를 사용합니다.

추가 매개변수 설명

이 API는 query_data에서 대상 워크스페이스 UUID와 query.targetRegion을 가져오기 위한 권장 API입니다.

  • content[j].regionCode는 해당 그룹 내 권한이 부여된 워크스페이스가 속한 사이트를 나타내며, query.targetRegion으로 직접 사용할 수 있습니다. 그룹 내 data[k].regionCode도 같은 의미입니다.
  • content[j].data에서 workspaceUUID로 대상 워크스페이스를 찾은 뒤 동일 그룹의 regionCode를 사용합니다. toRegionCode를 대상 사이트로 간주하지 마세요. 이는 권한을 부여받은 측, 즉 현재 API Key가 속한 워크스페이스의 사이트를 나타냅니다.
  • namespace로 권한이 부여된 데이터 유형을 필터링할 수 있습니다. 예를 들어 로그를 조회할 때는 namespace=logging을 전달합니다.
  • API는 각 regionCode 그룹에 대해 독립적으로 페이지를 나누며, pageInfo.count는 현재 페이지 수량일 뿐입니다. 처음에는 regionCode를 전달하지 않아 대상 사이트를 발견할 수 있습니다. 이후에는 각 대상 사이트에 대해 regionCode를 명시적으로 전달하고 pageIndex=1부터 독립적으로 페이지를 넘깁니다. 해당 사이트의 pageInfo.totalCount에 도달하거나 pageIndex * pageSize >= totalCount를 만족하면 중지합니다. 권한 부여 uuid 및 (regionCode, workspaceUUID) 기준으로 중복을 제거하는 것이 좋습니다.

구체적인 요청 구성 방식은 OpenAPI 교차 사이트 데이터 조회를 참고하세요.

1. 반환 매개변수 설명:

매개변수 이름 매개변수 설명
regionCode 권한 부여 사이트
regionName 권한 부여 사이트 이름
workspaceName 권한 부여 워크스페이스 이름
workspaceUUID 권한 부여 워크스페이스 UUID
toRegionCode 권한을 부여받은 워크스페이스 사이트
toRegionName 권한을 부여받은 워크스페이스 사이트 이름
toWorkspaceName 권한을 부여받은 워크스페이스 이름
toWorkspaceUUID 권한을 부여받은 워크스페이스 UUID
type 워크스페이스 권한 부여 유형: network, object, dialtest, billing, logging, tracing, metric, rum, keyevent, custom_object, security, profiling, *는 모든 유형 권한 부여를 의미합니다.
indexes 권한이 부여된 로그 인덱스 이름이며, *는 전체를 의미합니다.

참고: 반환되는 content는 권한 부여 측 사이트별로 그룹화된 배열입니다. 각 요소의 data는 해당 사이트의 현재 페이지에서 조회 가능한 워크스페이스 정보입니다.

2. 예시 설명: 권한을 부여받은 측은 권한 부여 측이 권한을 부여한 데이터를 조회할 수 있습니다. 아래 예시에서 XX 워크스페이스는 YY 워크스페이스에 로그 testing 인덱스 조회 권한을 부여합니다. 즉, YY 워크스페이스는 XX 워크스페이스의 로그 testing 인덱스 데이터를 조회할 수 있습니다.

 {
          "createAt": 1749542060,
          "creator": "acnt_c956fd23a9c2427b96ee372c88ea9b60",
          "creatorInfo": {

          },
          "delayDeleteAt": -1,
          "deleteAt": -1,
          "id": 442,
          "indexes": [
              "testing"
          ],
          "regionCode": "daily",
          "regionName": "开发环境(daily)",
          "status": 0,
          "toRegionCode": "testing",
          "toRegionName": "测试环境(testing)",
          "toWorkspaceName": "YY",
          "toWorkspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d",
          "type": [
              "logging"
          ],
          "updateAt": -1,
          "updator": "",
          "updatorInfo": {

          },
          "uuid": "grant_02b04aec78c74f869151e3e8c3e54dae",
          "workspaceName": "XX",
          "workspaceUUID": "wksp_6e310e0c1cbd45b4a27a19bda0fd7582"
}

요청 예시

curl --get 'https://openapi.guance.com/api/v1/wksp_share/granted_ws_list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode namespace=logging \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=100

응답

HTTP 200, application/json. 아래 예시는 바로 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content array<object> 권한 부여 측 사이트별로 그룹화되며, 일치 항목이 없으면 []입니다.
content[].regionCode string 해당 그룹 소스 사이트 코드이며 query_data query.targetRegion으로 사용할 수 있습니다.
content[].regionName string 해당 그룹 사이트 표시 이름입니다.
content[].data array<object> 해당 그룹의 이번 페이지 권한 부여 기록이며 비어 있을 수 있습니다.
content[].data[].id integer 권한 부여 기록 숫자 번호입니다.
content[].data[].uuid string grant_ 권한 부여 기록 UUID이며 소스 워크스페이스 UUID가 아닙니다.
content[].data[].workspaceUUID string 권한 부여 측/데이터 소스 워크스페이스 UUID이며, 교차 워크스페이스 query 대상에서 이 필드를 사용합니다.
content[].data[].workspaceName string 권한 부여 측 워크스페이스 이름입니다.
content[].data[].toWorkspaceUUID string 권한을 부여받은 측 워크스페이스 UUID이며, 이 API에서는 일반적으로 현재 워크스페이스입니다.
content[].data[].toWorkspaceName string 권한을 부여받은 워크스페이스 이름입니다.
content[].data[].regionCode string 권한 부여 측 사이트 코드이며 custom: 접두사가 붙을 수 있습니다.
content[].data[].toRegionCode string 권한을 부여받은 측 사이트이며, 과거 동일 사이트 빈 값은 현재 사이트로 정규화될 수 있습니다.
content[].data[].regionName string 권한 부여 측 사이트의 현재 언어 표시 이름이며, 없으면 사이트 정보 또는 코드로 대체됩니다.
content[].data[].toRegionName string 권한을 부여받은 측 사이트 표시 이름입니다.
content[].data[].type array<string> 또는 string 또는 null 이 기록에서 허용된 데이터 유형입니다. 현재는 일반적으로 배열이며, 과거에는 쉼표 문자열/null일 수 있으므로 실제 유형을 먼저 판별해야 합니다. *는 모든 권한 부여 유형을 의미하며 다른 제약 조건을 무시하지 않습니다.
content[].data[].type[] string 단일 유형 코드입니다.
content[].data[].indexes array<string> 또는 null 로그 인덱스 권한 부여 범위이며 *일 수 있습니다. 모든 데이터 유형에 공통된 리소스 목록으로 간주해서는 안 됩니다. 과거에는 null일 수 있으므로 유형을 먼저 판별합니다.
content[].data[].indexes[] string 단일 인덱스 이름 또는 *입니다.
content[].data[].conditions object 또는 null 권한이 부여된 데이터 필터 조건이며 데이터 유형별로 저장됩니다. 임의로 삭제한 뒤 조회 권한 부여 근거로 사용할 수 없습니다. 과거에는 null일 수 있으며 이 formatter에서 정규화되지 않습니다.
content[].data[].conditions.데이터 유형 JSON 해당 유형에 저장된 전체 필터 규칙입니다. 구조는 권한 부여 설정을 따르며 조건 배열/객체일 수 있습니다.
content[].data[].siteRelationType string same_site/same_org_cross_site/external_org_cross_site이며, 과거 값은 사이트를 기준으로 추론합니다.
content[].data[].grantMode string same_site 또는 cross_site이며 사이트 관계에서 추론됩니다.
content[].data[].grantStatus string 현재 유효한 권한 부여는 active입니다. pending/revoked 등은 유효성 필터링에서 제외됩니다.
content[].data[].syncStatus string 교차 사이트 리소스 요약 동기화 상태(예: 빈 값/success/failed)입니다. failed이지만 이전 요약이 있으면 여전히 반환될 수 있습니다.
content[].data[].lastSyncAt integer 또는 null 마지막 동기화 Unix 초이며, 동기화되지 않았으면 null일 수 있습니다.
content[].data[].sourceBaseUrl string 권한 부여 측 서비스 루트 주소의 과거 필드이며 비어 있을 수 있습니다. 클라이언트의 교차 워크스페이스 조회는 여전히 권한이 있는 공개 진입점을 통해 수행합니다.
content[].data[].targetBaseUrl string 권한을 부여받은 측 서비스 주소이며 비어 있을 수 있습니다.
content[].data[].delayDeleteAt integer 삭제 예정 Unix 초이며, 예정되지 않았으면 -1입니다. 현재 유효한 권한 부여 및 조회 시 검증을 대체하지 않습니다.
content[].data[].sourceWorkspaceAccess object 소스 워크스페이스 잠금 상태 객체이며 항상 객체입니다. 동일 사이트에서 확인 가능하면 내부 필드에 값이 있고, 교차 사이트/확인 불가 시 내부 isLocked/lockMode는 null입니다.
content[].data[].sourceWorkspaceAccess.isLocked integer 또는 null 0 잠금 없음/1 잠김, 알 수 없음 null입니다.
content[].data[].sourceWorkspaceAccess.lockMode string 또는 null none/writeLocked/readWriteLocked, 알 수 없음 null이며, 최종 조회는 실제 권한 부여/잠금 검사 기준입니다.
content[].data[].status integer 유효 기록 0입니다.
content[].data[].creator string 생성 주체입니다.
content[].data[].updator string 업데이트 주체입니다.
content[].data[].createAt integer 생성 Unix 초입니다.
content[].data[].updateAt integer 업데이트 Unix 초이며, 미업데이트 -1입니다.
content[].data[].deleteAt integer 삭제 Unix 초이며, 미삭제 -1입니다.
content[].data[].extra object 교차 사이트 권한 부여 확장 정보입니다. tempAuthCode/tempAuthCodeHash는 재귀적으로 제거되며 최상위 authorizationCode는 반환되지 않습니다. 기타 과거 키는 기록에 따라 존재할 수 있습니다.
content[].data[].extra.recordRole string authority 권한 부여 원본 기록 또는 mirror 미러이며, 일반 동일 사이트에서는 생략될 수 있습니다.
content[].data[].extra.grantStatus string 확장 상태이며 최상위 출력 상태와 통일됩니다. 생략될 수 있습니다.
content[].data[].extra.syncStatus string 확장 동기화 상태이며 생략될 수 있습니다.
content[].data[].extra.lastSyncAt integer 마지막 동기화 Unix 초이며 생략될 수 있습니다.
content[].data[].extra.lastSyncError JSON 최근 동기화 실패 정보이며 생략될 수 있습니다. 이번 HTTP 실패가 아닙니다.
content[].data[].extra.lastSyncErrorAt integer 최근 동기화 실패 Unix 초이며 생략될 수 있습니다.
content[].data[].extra.tempAuthCodeExpireAt integer 과거 임시 권한 부여 유효기간 Unix 초이며 생략될 수 있습니다. 대응하는 키는 반환되지 않습니다.
content[].data[].extra.resourceSummary object 교차 사이트 미러의 소스 리소스 요약이며 생략될 수 있습니다. 사용 가능한 카탈로그는 동기화 상태에 따라 달라집니다.
content[].data[].extra.resourceSummary.데이터 유형 object logging/rum/tracing/metric/lineage/incidents 등 범주별로 저장된 요약입니다.
content[].data[].extra.resourceSummary.데이터 유형.workspaceUUIDs array<string> 해당 유형과 관련된 소스 워크스페이스 UUID 배열이며 생략될 수 있습니다.
content[].data[].extra.resourceSummary.데이터 유형.workspaceUUIDs[] string 단일 소스 워크스페이스 UUID입니다.
content[].data[].extra.resourceSummary.데이터 유형.indexInfos array<object> 로그 인덱스 요약(과거 indexes 키를 사용할 수도 있음)이며, 각 항목의 필드는 동기화 버전에 따릅니다.
content[].data[].extra.resourceSummary.데이터 유형.indexInfos[].name string 인덱스 이름입니다.
content[].data[].extra.resourceSummary.데이터 유형.indexInfos[].uuid string 인덱스 UUID이며, 존재하는 경우에만 제공됩니다.
content[].data[].extra.resourceSummary.데이터 유형.rumCfgInfos array<object> RUM 애플리케이션 요약이며, 존재하는 경우에만 제공됩니다.
content[].data[].extra.resourceSummary.데이터 유형.기타 필드 JSON 해당 유형 소스 요약의 기타 공개 저장 필드이며, 현재 API의 쓰기 가능한 매개변수가 아닙니다.
content[].data[].extra.sourceSite object 교차 사이트 소스/대상 사이트 정보이며 생략될 수 있습니다.
content[].data[].extra.sourceSite.regionCode string 사이트 코드입니다.
content[].data[].extra.sourceSite.siteCode string 사이트 식별 별칭입니다.
content[].data[].extra.sourceSite.issuer string 발급자 식별자입니다.
content[].data[].extra.sourceSite.baseUrl string 사이트 서비스 루트 URL입니다.
content[].data[].extra.sourceSite.jwksUri string 공개 서명 검증 키 디렉터리 URL입니다.
content[].data[].extra.sourceSite.kid string 서명 공개 키 ID입니다.
content[].data[].extra.sourceSite.name string 표시 이름이며 비어 있을 수 있습니다.
content[].data[].extra.sourceSite.publicKeys array 공개 서명 검증 정보 배열이며, 기록에 포함된 경우 제공됩니다. 개인 키가 아닙니다.
content[].data[].extra.sourceSite.publicKeys[] object 공개 서명 검증 정보 하나입니다.
content[].data[].extra.sourceSite.publicKeys[].kid string 공개 키 ID입니다.
content[].data[].extra.sourceSite.publicKeys[].publicKey string 공개 서명 검증 공개 키 내용이며 개인 키가 아닙니다.
content[].data[].extra.targetSite object 교차 사이트 소스/대상 사이트 정보이며 생략될 수 있습니다.
content[].data[].extra.targetSite.regionCode string 사이트 코드입니다.
content[].data[].extra.targetSite.siteCode string 사이트 식별 별칭입니다.
content[].data[].extra.targetSite.issuer string 발급자 식별자입니다.
content[].data[].extra.targetSite.baseUrl string 사이트 서비스 루트 URL입니다.
content[].data[].extra.targetSite.jwksUri string 공개 서명 검증 키 디렉터리 URL입니다.
content[].data[].extra.targetSite.kid string 서명 공개 키 ID입니다.
content[].data[].extra.targetSite.name string 표시 이름이며 비어 있을 수 있습니다.
content[].data[].extra.targetSite.publicKeys array 공개 서명 검증 정보 배열이며, 기록에 포함된 경우 제공됩니다. 개인 키가 아닙니다.
content[].data[].extra.targetSite.publicKeys[] object 공개 서명 검증 정보 하나입니다.
content[].data[].extra.targetSite.publicKeys[].kid string 공개 키 ID입니다.
content[].data[].extra.targetSite.publicKeys[].publicKey string 공개 서명 검증 공개 키 내용이며 개인 키가 아닙니다.
content[].data[].extra.resourceSummary.updatedAt number 요약 업데이트 시간이며 소스 동기화 정보에서 제공되며 생략될 수 있습니다.
content[].data[].extra.resourceSummary.sourceGrantUUID string 소스 사이트 권한 부여 기록 UUID이며 생략될 수 있습니다.
content[].data[].extra.resourceSummary.logging.indexes array 현재 교차 사이트 미러에서 유지하는 로그 인덱스 요약입니다. 요소는 인덱스 이름 또는 소스에서 반환된 객체일 수 있습니다.
content[].data[].extra.resourceSummary.logging.indexes[] string 또는 object 단일 로그 인덱스 이름 또는 요약 객체이며, 고정된 객체 필드를 보장하지 않습니다.
content[].data[].extra.resourceSummary.rum.applications array 현재 교차 사이트 미러에서 유지하는 RUM 애플리케이션 요약입니다.
content[].data[].extra.resourceSummary.rum.applications[] string 또는 object 단일 애플리케이션 식별자 또는 소스 요약 객체이며, 실제 동기화 버전에 따라 해석합니다.
content[].pageInfo.pageIndex integer 해당 그룹의 현재 페이지 번호입니다.
content[].pageInfo.pageSize integer 해당 그룹의 페이지당 건수입니다.
content[].pageInfo.count integer 해당 그룹의 이번 페이지 건수입니다.
content[].pageInfo.totalCount integer 해당 그룹의 유효 권한 부여 총 건수입니다.
content[].declaration object 현재 호출 워크스페이스의 공통 선언이며, data의 각 기록에 삽입되지 않습니다.
{
  "code": 200,
  "content": [
    {
      "regionCode": "site_example",
      "regionName": "示例站点",
      "data": [
        {
          "id": 10,
          "uuid": "grant_example",
          "workspaceUUID": "wksp_source_example",
          "workspaceName": "production",
          "toWorkspaceUUID": "wksp_example",
          "toWorkspaceName": "示例空间",
          "regionCode": "site_example",
          "toRegionCode": "site_example",
          "regionName": "示例站点",
          "toRegionName": "示例站点",
          "type": [
            "logging",
            "tracing"
          ],
          "indexes": [
            "default"
          ],
          "conditions": {},
          "siteRelationType": "same_site",
          "grantMode": "same_site",
          "grantStatus": "active",
          "syncStatus": "",
          "lastSyncAt": null,
          "sourceBaseUrl": "",
          "targetBaseUrl": "",
          "delayDeleteAt": -1,
          "sourceWorkspaceAccess": {
            "isLocked": 0,
            "lockMode": "none"
          },
          "status": 0,
          "creator": "acnt_example",
          "updator": "",
          "createAt": 1785427200,
          "updateAt": -1,
          "deleteAt": -1,
          "extra": {}
        }
      ],
      "pageInfo": {
        "pageIndex": 1,
        "pageSize": 100,
        "count": 1,
        "totalCount": 1
      },
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참고하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 매개변수를 사용했거나 매개변수가 규칙을 위반함 매개변수 파싱 실패 Query 매개변수 표 및 예시를 확인합니다.
500 ft.InternalServerError 워크스페이스/사이트/권한 부여 설정, 데이터베이스 또는 캐시 읽기 및 응답 포매팅 실패 내부 오류 traceId와 조회 조건을 보관하고, 재시도해도 계속 실패하면 관리자에게 설정 확인을 요청하세요. 빈 결과만으로 사이트에 데이터가 없다고 추론하지 마세요.

문서 평가

이 페이지가 도움이 되었나요?