クラスターの一時停止

CelerData クラスターを一時停止します。

リクエスト

基本情報
HTTP URL	`https://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/suspend`
HTTP メソッド	PATCH
頻度	600/分

パス変数

パラメーター	例	必須	タイプ	説明
cluster_id	4ae48a3f-f840-46fa-b0e7-0709a220fa40	はい	String	クラスターの ID。 CelerData Cloud BYOC コンソールにサインインし、クラスターの `概要` ページの `クラスタープロパティ` セクションに移動してクラスター ID を取得できます。

:<variable_name> は、Postman などの Web 開発ツールでの URL パス変数を示します。上記の URL パスの :cluster_id は、一時停止したいクラスターの ID を示します。ただし、curl などの他のツールを使用する場合は、curl コマンドで :cluster_id を実際のクラスター ID に手動で置き換える必要があります。

ヘッダーパラメーター

パラメーター	例	必須	タイプ	説明
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	はい	String	CelerData Cloud BYOC API にアクセスするために使用されるアクセストークン。形式: `Bearer <access_token>`。

アクセストークンの取得を参照してください。

レスポンス

サンプルレスポンス

{
    "code": 20000,
    "data": {
        "action_id": "7b622922-2a25-4d24-aa6f-9be54c7a91e0"
    }
}

レスポンス要素

パラメーター	サブ属性	例	タイプ	説明
code		20000	Integer	エラーコード。返されたエラーコードが `20000` の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	-	Object	API 呼び出しの結果。データオブジェクトは、一部の API アクションでは返されない場合があります。次の要素で構成されています: `account_idusagedetails`。
	action_id	7b622922-2a25-4d24-aa6f-9be54c7a91e0	String	アクションの ID。

参照

クラスターの一時停止には数分かかる場合があります。前述の API 呼び出しを行った後、クラスターの状態を照会する手順に従ってクラスターの状態を照会できます。

リクエスト​

パス変数​

ヘッダー パラメーター​

レスポンス​

サンプルレスポンス​

レスポンス要素​

参照​