共有¶
POST /api/v1/snapshots/{snapshot_uuid}/share
概要¶
snapshot_uuid に基づいて、指定されたスナップショットの共有リンクを生成します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| snapshot_uuid | string | 〇 | スナップショット 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 |
パラメータ補足説明¶
リクエストパラメータの説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| changeTime | boolean | 閲覧者が時間範囲を変更できるかどうか |
| expirationAt | integer | 有効期限は秒単位のタイムスタンプ。無期限の場合は -1 を指定 |
| extractionCode | string | 暗号化共有を作成する際のアクセス用抽出コード。デフォルトは公開 |
| hiddenTopBar | boolean | トップバーを非表示にするかどうか。デフォルトは false |
| showWatermark | boolean | ウォーターマークを表示するかどうか |
| maskCfg | dict | マスキング設定 |
| ipWhitelistSet | dict | スナップショットの IP ホワイトリスト設定 |
maskCfg 内部フィールドの説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| fields | string | マスキングフィールド。複数フィールドはカンマ区切り |
| reExprs | array | 正規表現のリスト |
maskCfg.reExprs 内部フィールドの説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| name | string | マスキングフィールド名 |
| reExpr | string | 正規表現 |
| enable | integer | 有効かどうか (0,1) |
ipWhitelistSet 内部フィールドの説明
| パラメータ名 | 型 | 説明 |
|---|---|---|
| isOpen | boolean | IP ホワイトリストを有効にするかどうか |
| 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"
}