クラスターのクエリステータス
CelerData クラスターのステータスをクエリします。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://cloud-api.celerdata.com/api/1.0/clusters/:cluster_id/state |
| HTTP メソッド | GET |
| 頻度 | 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>。 |
アクセストークンの取得 を参照してください。
レスポンス
サンプルレスポンス
{
"code": 20000,
"data": {
"abnormal_reason": "",
"cluster_state": "Suspended"
}
}
レスポンス要素
| パラメーター | サブ属性 | 例 | タイプ | 説明 |
|---|---|---|---|---|
| code | 20000 | Integer | エラーコード。返されたエラーコードが 20000 の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。 | |
| data | - | - | Object | API コールの結果。データオブジェクトは一部の API アクションでは返されない場合があります。次の要素で構成されています: account_idusagedetails。 |
| abnormal_reason | null | String | クラスターが異常である理由。クラスターが異常な場合、この要素に値が返されます。 | |
| cluster_state | Suspended | String | クラスターのステータス。有効な値:
|