コンテンツにスキップ

テンプレート - カスタムテンプレートの削除



POST /api/v1/sys_template/custom/{systemplate_uuid}/delete

概要

カスタムシステムテンプレートを論理削除します。

呼び出し前の確認と使用手順

これはサイトレベルのテンプレートライブラリであり、特定のワークスペースで既に作成されたダッシュボード/モニター/Pipeline のインスタンスではありません。ライブラリのテンプレートを削除または上書きしても、インスタンス化済みのリソースを削除/アップグレードすることにはなりません。本モジュールはデータクエリを実行せず、実行中の収集設定を公開することもありません。w 権限が必要です。まずテンプレート一覧で isCustomSysTemp=true を絞り込んで内容と参照元をバックアップし、そのライブラリテンプレートが不要であることを確認してから送信してください。論理削除は isCustomSysTemp=true のライブラリレコードにのみ一致します。Pipeline の場合はさらに isSysTemplate=true であることが必要です。一致しないもの、未知の UUID、カスタムでないレコードはすべて無視され true を返しますが、true から対象が実際に存在する、または削除されたと断定することはできません。削除済みのレコードも再度一致して削除時刻が更新される可能性があり、リプレイは時刻を変えない冪等な操作ではありません。既存のワークスペースインスタンスはこれに伴って削除されません。件数/ステータスを個別に返すことはありません。削除後は一覧/詳細で再確認してください。詳細では未知の識別済みプレフィックスが content=null となる場合があり、必ず 404 になるわけではありません。

ルートパラメータ

パラメータ名 型 必須 説明
systemplate_uuid string Y プロトコル名は歴史的な綴り systemplate_uuid を保持します。単一の pl_ はシステム/カスタムテンプレートの両方である必要があり、それ以外はカスタム Integration として検索します。
例: itgr_example001
取得・入力方法: テンプレート一覧 で isCustomSysTemp=true を絞り込んで uuid を取得し、前後に空白を付けません。

リクエストヘッダー

パラメータ名 型 必須 説明
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 秒文字列を生成します。

パラメータの補足説明

論理削除は 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/itgr_example001/delete'
query = {}
data = None
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"))

レスポンス

HTTP 200、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 リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している パラメータの解析に失敗 パラメータの位置、フィールド名、型、値を確認してください。
500 ft.InternalServerError jsonContents の要素/動的フィールドの型エラー、Base64 以外の未検証構造、データベースの保存/削除例外 内部エラー まずテンプレート一覧と詳細で現在の状態を確認してから再試行してください。HTTP 200 の診断と 500 は異なり、エラーでは項目ごとの書き込み UUID は提供されません。traceId を保持し、むやみに繰り返し上書きしないでください。

フィードバック

このページは役に立ちましたか?