クラスター用スクリプトの宣言

クラスター用の実行可能スクリプトを宣言します。

クラスターがデプロイされた後に、スクリプトファイルのパスや実行の詳細を更新できます。クラスターがスケーリングされる際に最新のスクリプトが実行されます。

リクエスト

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

パス変数

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

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

ヘッダーのパラメータ

パラメータ	例	必須	タイプ	説明
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	はい	String	CelerData Cloud BYOC API にアクセスするためのアクセストークンです。フォーマット: `Bearer <access_token>`。

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

リクエストボディ

{
    "scripts": [
        {
            "script_path": "s3://<path_to_script>",
            "logs_dir":"s3://<path_for_log>/"
        },
    ],
    "parallel": true,
    "timeout":3600
}

パラメータ	例	必須	タイプ	説明
scripts	`{"script_path": "s3://bucket/path/aaa.sh","logs_dir":"s3://bucket/log/"}`	はい	List	スクリプトとログのS3パスを宣言するオブジェクトのリストです。
parallel	`true`	いいえ	Boolean	複数のスクリプトがある場合にスクリプトを並行して実行するかどうか。
timeout	`3600`	いいえ	Int	スクリプトを実行するための合計タイムアウト時間。

レスポンス

サンプルレスポンス

{
    "code": 20000,
    "message": ""
}

レスポンス要素

パラメータ	例	タイプ	説明
code	20000	Integer	エラーコードです。返されたエラーコードが `20000` の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
message	-	String	エラーメッセージです。この要素は、返された `code` が `20000` でない場合にのみ返されます。注意リクエストが成功したか失敗したかを `message` の返り値に基づいて判断しないでください。

リクエスト​

パス変数​

ヘッダーのパラメータ​

リクエストボディ​

レスポンス​

サンプルレスポンス​

レスポンス要素​

関連情報​