Skip to main content
24.02
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

スケジュールを取得する

PDF

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/schedules/{schedule_id}

JSONレスポンスボディに格納されたSchedule APIリソースを返します。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

  • 例：{{.Account}}

app_id

string

path（パス）

True

含まれるアプリリソースのID

schedule_id

string

path（パス）

True

リストするスケジュールコレクションのID

応答

Status: 200, Returns the stored Schedule API resource in the JSON response body.
Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • "application/astra-schedule"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

  • "1.1"

  • "1.2"

  • "1.3"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

名前

string

True

スケジュール名を含むJSON文字列。定義値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

有効

string

True

スケジュールが有効かどうかを示すJSON文字列。定義された値は次のとおりです：

  • 「true」 - スケジュールが有効です

  • 「false」 - スケジュールは有効ではありません。指定しない場合、デフォルト値は「true」です。

粒度

string

True

スケジュールの粒度を示すJSON文字列。定義された値は次のとおりです：

  • 「毎時」

  • "日次"

  • "週次"

  • "月次"

  • "カスタム"

分

string

True

スケジュールを実行する時刻（0～59分）を示す数値を含むJSON文字列。定義された値は次のとおりです：

  • 定義された正規表現は次のとおりです："^[0-9]

[1-5][0-9]$" このフィールドは、粒度が「hourly」、「daily」、「weekly」、または「monthly」に設定されている場合に存在します。カスタムスケジュールの場合、値「0」が返されます。

時間

string

False

スケジュールを実行する時刻（0～23時）を示す数値を含むJSON文字列。定義された値は次のとおりです：

  • 定義された正規表現は次のとおりです："^[0-9]

[1][0-9]

[2][0-3]$" このフィールドは、粒度が「日次」、「週次」、または「月次」に設定されている場合に存在します。

dayOfWeek

string

False

スケジュールを実行する曜日（0～7）を示す数値を含むJSON文字列。定義された値は次のとおりです：

  • 定義された正規表現は「^[0-7]$」です。このフィールドは、粒度が「weekly」に設定されている場合にのみ存在します。

dayOfMonth

string

False

スケジュールを実行する月の日（1～31）を示す数値を含むJSON文字列。定義された値は次のとおりです：

  • 定義された正規表現は次のとおりです："^[1-9]

[1-2][0-9]

[3][0-1]$" このフィールドは、粒度が「monthly」に設定されている場合にのみ存在します。

recurrenceRule

string

False

RFC-5545 セクション 3.8.5.3 を含む JSON 文字列。再帰ルール。DTSTART パラメータについては、UTC タイムスタンプ（末尾に「Z」が付く）のみがサポートされ、現在時刻より前のタイムスタンプのみがサポートされます。RECUR ルールパーツについては、「FREQ」と「INTERVAL」のみがサポートされています。FREQ ルールの部分では、「MINUTELY」と「HOURLY」のみがサポートされる値です。このフィールドは、粒度が「custom」に設定されている場合にのみ表示されます。

snapshotRetention

string

True

保持するスナップショットの数を示す正の数値を含むJSON文字列。ゼロは、バックアップ取得後にスナップショットを削除する必要があることを示します。定義値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • 定義された正規表現は次のとおりです："^(0

([1-9][0-9]*))$"

backupRetention

string

True

保持するバックアップの数を示す正の数値を含むJSON文字列。ゼロは、バックアップを作成しないことを示します。定義値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • 定義された正規表現は次のとおりです："^(0

([1-9][0-9]*))$"

bucketID

string

False

バックアップの作成時に保存する場所を示す、オプションのバケットIDを含むJSON文字列。指定がない場合は、システムが選択したバケットが使用されます。定義値は次のとおりです：

  • Astra識別子スキーマに準拠

レプリケート

string

False

スケジュールが各スナップショットのAppMirrorレプリケーションをトリガーするかどうかを示すJSON文字列。アプリケーションにAppMirror関係が定義されている場合にのみ有効になります。定義値は次のとおりです：

  • 「true」 - スケジュールがAppMirrorレプリケーションをトリガーします

  • 「false」 - スケジュールはAppMirrorレプリケーションをトリガーしません。指定しない場合、デフォルト値は「false」です。

メタデータ
回答例 
{
  "type": "application/astra-schedule",
  "version": "1.3",
  "id": "49cbc480-5f7d-51e2-8f30-52b9a83a03b1",
  "name": "Backup Schedule",
  "enabled": "true",
  "granularity": "monthly",
  "minute": "0",
  "hour": "0",
  "dayOfMonth": "1",
  "snapshotRetention": "12",
  "backupRetention": "12",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

応答

Status: 401, Unauthorized
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

応答

Status: 400, Bad request
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidParams

配列["invalidParams"]

False

無効なクエリパラメータのリスト
回答例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 403, Forbidden
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

エラー

Status: 404, Not found
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
エラー応答の例 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

用語の意味

定義を参照

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由