Featureの削除

Prev Next

VPC環境で利用できます。

使用しなくなったか、不要な Featureを削除します。

Featureの削除条件は次の通りです。

削除できるかどうか Featureの状態 Featureの使用有無
可能
  • registered: 登録完了
  • completed: 使用可能
  • failed: 失敗
  • 削除対象の Featureを使用する機能(Task Model、Task Model Run、Custom Attributesのうち1つ)がない場合
  • 削除対象の Featureを使用する機能があっても、開始前か(registered)、既に完了した(completed、failed)場合
    不可
    • pending: 待機中
    • in_progress: 作成中
    		 削除対象の Featureを使用する機能(Task Model、Task Model Run、Custom Attributesのうち1つ)の中でその機能が実行中(pending、in_progress)の場合
    参考

    削除できない場合はエラーメッセージが返されます。削除可能な条件で再試行してください。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッド URI
    DELETE /features/{feature_id}

    リクエストヘッダ

    NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

    リクエストパスパラメータ

    リクエストパスパラメータの説明は次の通りです。

    フィールド タイプ 必須の有無 説明
    feature_id String Required Feature ID

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location --request DELETE 'https://nclue.apigw.ntruss.com/api/v1/features/{feature_id}' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}'

    レスポンス

    レスポンス形式を説明します。

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールド タイプ 必須の有無 説明
    feature_id String - Feature ID

    レスポンスステータスコード

    NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

    レスポンス例

    レスポンスのサンプルコードは次の通りです。

    {
    "feature_id": "848c80c1-****-****-****-120a617b1f2e"
}