CreateSnapshot
処理概要
スナップショットを作成します。
リクエストURL
POST /v1/snapshots指定するパラメーター
リクエストボディ
パラメーター | 型 | 説明 | 必須 |
---|---|---|---|
snapshot | object |
|
|
␣name | string |
スナップショット名 使用可能文字: 半角英数小文字またはハイフン(先頭と末尾を除く)40文字以内 |
○ |
␣cluster | object |
|
|
␣␣name | string |
スナップショットの元になるクラスター名 |
○ |
␣expirationTime | string |
スナップショット有効期限 Default: unlimited (無期限) 使用可能文字: unlimited(無期限にする場合) | yyyy-mm-ddThh:mm:ss+09:00 等のISO8601形式(期限を指定するする場合) |
|
␣description | string |
メモ 使用可能文字: UTF-8で全角半角255文字以内 |
|
␣tags[] | object[] |
|
|
␣␣key | string |
付与したいタグキー 使用可能文字: UTF-8で全角半角128文字以内 |
|
␣␣value | string |
付与したいタグ値 使用可能文字: UTF-8で全角半角256文字以内 |
応答フィールド
フィールド (項目) | 型 | 説明 |
---|---|---|
snapshot | object |
|
␣name | string |
スナップショット名 |
␣cluster | object |
|
␣␣name | string |
スナップショット元クラスター名 |
␣␣kubernetesVersion | string |
スナップショット作成時のクラスターのKubernetesのバージョン |
␣␣nodePools[] | object[] |
|
␣␣␣name | string |
スナップショット作成時のノードプール名 |
␣␣␣instanceType | string |
スナップショット作成時のノードプール内のノードのサーバータイプ |
␣␣␣nodeCount | integer |
スナップショット作成時のノードプールのノード数 |
␣expirationTime | string |
スナップショット有効期限 |
␣description | string |
メモ |
␣resourceVersion | string |
スナップショット取得時点で最後に生成されたKubernetesリソースバージョン |
␣createTime | string |
スナップショット作成完了日時 |
␣status | string |
ステータス 値:
|
␣nrn | string |
NRN |
␣tags[] | object[] |
|
␣␣id | string |
タグID |
␣␣key | string |
タグキー |
␣␣value | string |
タグ値 |
リクエストサンプル
curl -XPOST https://jp-east-1.hatoba.api.nifcloud.com/v1/snapshots
-H "X-Amz-Date: 20190724T000000Z"
-H "Authorization: AWS4-HMAC-SHA256 ..."
-d {
"snapshot": {
"name": "snapshot01",
"cluster": {
"name": "cluster01"
},
"expirationTime": "2019-07-25T15:00:00Z",
"description": "memo",
"tags": [
{
"key": "key01",
"value": "value01"
}
]
}
}
応答サンプル
{
"snapshot": {
"name": "snapshot01",
"cluster": {
"name": "cluster01",
"kubernetesVersion": "v1.20.1",
"nodePools": [
{
"name": "nodepool01",
"instanceType": "e-medium",
"nodeCount": 1
}
]
},
"expirationTime": "2019-07-25T15:00:00Z",
"description": "memo",
"resourceVersion": "2576505",
"createTime": "",
"status": "CREATING",
"nrn": "nrn:nifcloud:hatoba:jp-east-1:xxxxxxxx:snapshot:68632048-c720-4903-83b7-4860a15dffbf",
"tags": [
{
"id": "31fac2be-013e-4702-b5ba-5d49b7d8e7b7",
"key": "key01",
"value": "value01"
}
]
}
}