テンプレート - カスタムテンプレートの一括削除¶
POST /api/v1/sys_template/custom/batch_deletes
概要¶
カスタムシステムテンプレートを一括で論理削除します。
呼び出し前の確認と使用手順¶
これはサイトレベルのテンプレートライブラリであり、特定のワークスペースで作成済みのダッシュボード/モニター/Pipeline インスタンスではありません。ライブラリテンプレートを削除または上書きしても、インスタンス化済みリソースの削除/アップグレードにはなりません。本モジュールはデータクエリや実行中の収集設定の公開を行いません。w 権限が必要です。まずテンプレート一覧で isCustomSysTemp=true を絞り込み、内容と参照元をバックアップし、このライブラリテンプレートが不要であることを確認してから送信してください。論理削除は isCustomSysTemp=true のライブラリレコードのみに一致します。Pipeline の場合はさらに isSysTemplate=true が必要です。一致しないもの、未知の UUID、非カスタムレコードはすべて無視され true を返しますが、true によって対象が実際に存在する、または削除されたと断定することはできません。削除済みレコードが再度一致し、削除時刻が更新される可能性もあります。再実行は削除時刻を不変に保つ冪等操作ではありません。既存のワークスペースインスタンスはこれに伴って削除されません。項目ごとの件数/ステータスの返却はありません。削除後に一覧/詳細で再確認してください。詳細では、未知の認識済みプレフィックスが content=null となる可能性があり、必ず 404 になるわけではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 元のパスとリクエストボディの署名バージョン。省略したまま本ページのアルゴリズムを継続利用することはできません。 例: v20240417取得または入力方法: 本ページの例ではこの固定バージョンを使用し、例の署名アルゴリズムと組み合わせます。 |
|
| X-Df-Access-Key | string | Y | 読み取り API では r または w の資格情報を使用でき、書き込み API では w の資格情報が必要です。 例: <external-access-key>取得または入力方法: サイト管理者が割り当てた External API AK を使用します。ワークスペースの OpenAPI Key は使用できません。 |
| X-Df-Nonce | string | Y | 一時的なシリアル番号。失敗して再送する場合も新しい値を生成し、署名を再計算します。 例: 97d275ee9f774315a7885ba7347acbd9取得または入力方法: リクエストごとに uuid.uuid4().hex を再生成します。 |
| X-Df-Signature | string | Y | 大文字のメソッド、nonce、元の完全なパス、timestamp、および元の UTF-8 リクエストボディをスペースで連結し、HMAC-SHA256 を実行して hex ダイジェストを取得します。 例: <hmac-sha256-hex>取得または入力方法: External API 署名認証に従い、対応する SK を使用して計算します。完全な実行可能テンプレートは以下を参照してください。 |
| X-Df-Timestamp | string | Y | サイトで設定された署名有効時間枠内である必要があり、例の時刻を再利用できません。 例: 1785427200取得または入力方法: 送信時に str(int(time.time())) を使用して現在の Unix 秒文字列を生成します。 |
リクエストボディパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| systemplateUUIDs[*] | string | 単一の itgr_ または pl_ テンプレート UUID。Pipeline の場合はさらに isSysTemplate=true が必要で、通常のワークスペース Pipeline はこの削除対象ではありません。 例: itgr_example001取得または入力方法: テンプレート一覧から単一のカスタムテンプレート uuid を取得します。 |
|
| systemplateUUIDs | array | Y | 必須の配列。各項目はまず strip してからプレフィックスごとにグループ化して重複排除し、空文字列は無視します。[] の場合は削除を行わなくても true を返します。文字列以外の要素は 500 になる可能性があり、外部ビジネスリソースの UUID は使用できません。 null を許可: False 例: ["itgr_example001"]取得または入力方法: テンプレート一覧で isCustomSysTemp=true を絞り込み、テンプレート uuid の配列を取得します。 |
パラメータ補足説明¶
論理削除は isCustomSysTemp=true のライブラリレコードのみに一致します。Pipeline の場合はさらに isSysTemplate=true が必要です。一致しないもの、未知の UUID、非カスタムレコードはすべて無視され true を返しますが、true によって対象が実際に存在する、または削除されたと断定することはできません。削除済みレコードが再度一致し、削除時刻が更新される可能性もあります。再実行は削除時刻を不変に保つ冪等操作ではありません。既存のワークスペースインスタンスはこれに伴って削除されません。項目ごとの件数/ステータスの返却はありません。
リクエスト例¶
import hashlib
import hmac
import json
import time
import uuid
from urllib.parse import urlencode
from urllib.request import Request, urlopen
# 対象サイトのアドレス、および管理者が割り当てた External API AK/SK に置き換えます。
server = "https://external-api.guance.com"
access_key = "<external-access-key>"
secret_key = "<external-secret-key>"
method = 'POST'
path = '/api/v1/sys_template/custom/batch_deletes'
query = {}
data = {'systemplateUUIDs': ['itgr_example001']}
full_path = path + ("?" + urlencode(query) if query else "")
body = "" if data is None else json.dumps(data, ensure_ascii=False, separators=(",", ":"))
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
string_to_sign = " ".join([method, nonce, full_path, timestamp, body])
signature = hmac.new(secret_key.encode("utf-8"), string_to_sign.encode("utf-8"), hashlib.sha256).hexdigest()
headers = {
"X-Df-Access-Key": access_key,
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-Signature": signature,
"X-Df-SVersion": "v20240417",
}
if data is not None:
headers["Content-Type"] = "application/json"
request = Request(server + full_path, data=None if data is None else body.encode("utf-8"), headers=headers, method=method)
with urlopen(request) as result:
print(result.read().decode("utf-8"))
レスポンス¶
HTTP200、application/json の標準 External エンベロープです。content は本ページの分岐に応じてオブジェクト/配列/null/true となり、OpenAPI declaration には自動的に追加されません。リストのページネーションは content.pageInfo にあります。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 処理完了時は固定で true となり、項目ごとの削除結果/件数はありません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーの詳細は共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたは応答説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析に失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではない | 一部の JSON ファイルの形式エラー | systemplateUUIDs 配列を含む JSON オブジェクトを送信してください。 |
| 500 | ft.InternalServerError | jsonContents 要素/動的フィールドの型エラー、Base64 以外の未検証構造、データベース保存/削除の異常 | 内部エラー | まずテンプレート一覧と詳細で現在の状態を確認してから再試行してください。HTTP200 の診断は 500 とは異なり、エラーでは項目ごとの書き込み UUID は提供されません。traceId を保持し、むやみに繰り返し上書きしないでください。 |