공유¶
POST /api/v1/snapshots/{snapshot_uuid}/share
개요¶
snapshot_uuid를 기반으로 지정된 스냅샷의 공유 링크를 생성합니다.
경로 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| snapshot_uuid | string | Y | 스냅샷 UUID |
Body 요청 파라미터¶
| 파라미터명 | 유형 | 필수 | 설명 |
|---|---|---|---|
| changeTime | boolean | 조회자가 시간 범위를 변경할 수 있는지 여부, 기본값 false 공백 허용: False |
|
| expirationAt | integer | 만료 시간(타임스탬프, 초 단위), 영구 유효 시 -1 전달 예시: 1577758776 공백 허용: False 빈 문자열 허용: True |
|
| extractionCode | string | 암호화된 공유 생성 시 접근 인증 코드 예시: 123455x 공백 허용: False 빈 문자열 허용: True 최대 길이: 12 |
|
| hiddenTopBar | boolean | 상단 바 숨김 여부, 기본값 false 공백 허용: False |
|
| showWatermark | boolean | 워터마크 표시 여부, 기본값 false 공백 허용: False |
|
| maskCfg | None | ||
| maskCfg.fields | string | 마스킹 필드, 여러 필드는 쉼표로 구분 예시: message,host 공백 허용: False 빈 문자열 허용: True |
|
| maskCfg.reExprs | array | 정규 표현식 목록 예시: [{'name': 'jjj', 'reExpr': 'ss', 'enable': 0}, {'name': 'lll', 'reExpr': 'ss', 'enable': 1}] 공백 허용: False |
|
| ipWhitelistSet | None | ||
| ipWhitelistSet.isOpen | boolean | IP 허용 목록 활성화 여부 공백 허용: False |
|
| ipWhitelistSet.type | string | IP 허용 목록 활성화 유형, followWorkspace 예시: 123455x 공백 허용: False 빈 문자열 허용: True 최대 길이: 12 사용 가능한 값: ['followWorkspace', 'custom'] |
|
| ipWhitelistSet.ipWhitelist | array | IP 허용 목록, type이 custom일 때 사용 예시: [] 공백 허용: False |
파라미터 추가 설명¶
요청 파라미터 설명
| 파라미터명 | type | 설명 |
|---|---|---|
| changeTime | boolean | 조회자가 시간 범위를 변경할 수 있는지 여부 |
| expirationAt | integer | 만료 시간(초 단위 타임스탬프), 영구 유효 시 -1 전달 |
| extractionCode | string | 암호화된 공유 생성 시 접근 인증 코드, 기본값 공개 |
| hiddenTopBar | boolean | 상단 바 숨김 여부, 기본값 false |
| showWatermark | boolean | 워터마크 표시 여부 |
| maskCfg | dict | 마스킹 설정 |
| ipWhitelistSet | dict | 스냅샷 IP 허용 목록 설정 |
maskCfg 내부 필드 설명
| 파라미터명 | type | 설명 |
|---|---|---|
| fields | string | 마스킹 필드, 여러 필드는 쉼표로 구분 |
| reExprs | array | 정규 표현식 목록 |
maskCfg.reExprs 내부 필드 설명
| 파라미터명 | type | 설명 |
|---|---|---|
| name | string | 마스킹 필드 이름 |
| reExpr | string | 정규 표현식 |
| enable | integer | 활성화 여부 (0, 1) |
ipWhitelistSet 내부 필드 설명
| 파라미터명 | type | 설명 |
|---|---|---|
| isOpen | boolean | 만료 시간(초 단위 타임스탬프), 영구 유효 시 -1 전달 |
| type | string | IP 허용 목록 활성화 유형, 워크스페이스 IP 허용 목록 설정 따르기: followWorkspace, 사용자 정의: custom |
| ipWhitelist | boolean | IP 허용 목록, type이 custom일 때 사용 |
요청 예시¶
curl 'https://openapi.guance.com/api/v1/snapshots/snap_xxxx32/share' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"changeTime":true,"expirationAt":1730874467,"hiddenTopBar":false,"showWatermark":true,"maskCfg":{"fields":"","reExprs":[]},"ipWhitelistSet":{"isOpen":false},"changeTime":true}' \
--compressed
응답¶
{
"code": 200,
"content": {
"declaration": {
"asd": "aa,bb,cc,1,True",
"asdasd": "dawdawd",
"business": "aaa",
"dd": "dd",
"fawf": "afawf",
"organization": "64fe7b4062f74d0007b46676"
},
"isHidden": false,
"shortUrl": "https://aa.com/rj6mm3",
"token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-67FFC05B-64BA-4A56-B831-D3FCEFE4451C"
}