移動

• リクエスト
• レスポンス
• 例

コントロール・プレーン構成の削除

delete

/api/v1/configuration/cpConfig/{configName}

指定したコントロール・プレーン構成を削除します。

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• configName: string
  一意のコントロール・プレーン構成の識別子

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

OK

400レスポンス

不正なリクエスト

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

401レスポンス

未認可

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

409レスポンス

操作の競合

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array warnings
  警告のリスト

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

先頭に戻る

例

このエンドポイントは、Blockchain Platform内の指定されたコントロール・プレーン構成を削除するために使用します。

次の例は、cURLを使用してRESTリソースに対するDELETEリクエストを発行し、コントロール・プレーン構成を削除する方法を示しています。

curl -X DELETE \
  http://<hostname>:<port>/api/v1/configuration/cpConfig/<unique control plane config identifier>

例:

curl -X DELETE \
  http://localhost:17070/api/v1/configuration/cpConfig/myCPconfig

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "status": "200",
    "message": "Configuration deleted successfully"
}

先頭に戻る