Récupérer un planning
GET /accounts/{account_id}/k8s/v1/apps/{app_id}/schedules/{schedule_id}
Renvoie la ressource d'API Schedule stockée dans le corps de la réponse JSON.
Paramètres
| Nom | Type | Dans | Obligatoire | Description |
|---|---|---|---|---|
identifiant_compte |
chaîne |
chemin |
Vrai |
ID de la ressource de compte conteneur
|
app_id |
chaîne |
chemin |
Vrai |
ID de la ressource d'application contenant |
id_schedule |
chaîne |
chemin |
Vrai |
ID de la collection de planification à lister |
Réponse
Status: 200, Returns the stored Schedule API resource in the JSON response body.
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
Type de média de la ressource. Les valeurs définies sont :
|
version |
chaîne |
Vrai |
Version de la ressource. Les valeurs définies sont :
|
id |
chaîne |
Vrai |
Identifiant unique global de la ressource. Les valeurs définies sont :
|
nom |
chaîne |
Vrai |
Chaîne JSON contenant le nom du planning. Les valeurs définies sont :
|
activé |
chaîne |
Vrai |
Chaîne JSON indiquant si une planification est active. Les valeurs définies sont :
|
granularité |
chaîne |
Vrai |
Chaîne JSON indiquant la granularité de la planification. Les valeurs définies sont :
|
minute |
chaîne |
Vrai |
Chaîne JSON contenant une valeur numérique indiquant la minute de l'heure (0 - 59) à laquelle exécuter la planification. Les valeurs définies sont :
|
[1-5][0-9]$ ». Ce champ est présent si la granularité est définie sur « hourly », « daily », « weekly » ou « monthly ». Il sera renvoyé avec la valeur « 0 » pour les planifications personnalisées. |
heure |
chaîne |
Faux |
Chaîne JSON contenant une valeur numérique indiquant l'heure de la journée (0 - 23) à laquelle exécuter la planification. Les valeurs définies sont :
|
[1][0-9] |
[2][0-3]$" Ce champ est présent si la granularité est définie sur "daily", "weekly" ou "monthly". |
dayOfWeek |
chaîne |
Faux |
Chaîne JSON contenant une valeur numérique indiquant le jour de la semaine (0-7) pour exécuter la planification. Les valeurs définies sont :
|
dayOfMonth |
chaîne |
Faux |
Chaîne JSON contenant une valeur numérique indiquant le jour du mois (1-31) pour exécuter la planification. Les valeurs définies sont :
|
[1-2][0-9] |
[3][0-1]$" Ce champ n'est présent que si granularité est définie sur "monthly". |
recurrenceRule |
chaîne |
Faux |
Chaîne JSON contenant une RFC-5545 section 3.8.5.3. Règle de récurrence. Pour le paramètre DTSTART, seuls les horodatages UTC (indiqués par le suffixe « Z ») sont pris en charge, et seuls les horodatages antérieurs à l'heure actuelle sont pris en charge. Pour les parties de la règle RECUR, « FREQ » et « INTERVAL » sont les seules parties de règle prises en charge. Pour la partie de règle FREQ, « MINUTELY » et « HOURLY » sont les seules valeurs prises en charge. Ce champ est présent uniquement si granularité est définie sur « custom ». |
snapshotRetention |
chaîne |
Vrai |
Chaîne JSON contenant une valeur numérique positive indiquant combien d'instantanés conserver. Zéro indique que les instantanés doivent être supprimés après la sauvegarde. Les valeurs définies sont :
|
([1-9][0-9]*))$" |
backupRetention |
chaîne |
Vrai |
Chaîne JSON contenant une valeur numérique positive indiquant combien de sauvegardes doivent être conservées. Zéro indique qu'aucune sauvegarde ne doit être créée. Les valeurs définies sont :
|
([1-9][0-9]*))$" |
ID de compartiment |
chaîne |
Faux |
Chaîne JSON contenant un ID de compartiment optionnel indiquant où la sauvegarde doit être stockée lors de la création. Si non spécifié, un compartiment sélectionné par le système sera utilisé. Les valeurs définies sont :
|
répliquer |
chaîne |
Faux |
Chaîne JSON indiquant si la planification déclenche la réplication AppMirror pour chaque instantané. Ne prend effet que si l'application a une relation AppMirror définie. Les valeurs définies sont :
|
les métadonnées |
Exemple de réponse
{
"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"
}
}
Réponse
Status: 401, Unauthorized
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
Exemple de réponse
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Réponse
Status: 400, Bad request
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
|
invalidParams |
tableau["invalidParams"] |
Faux |
Liste des paramètres de requête invalides |
Exemple de réponse
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Réponse
Status: 403, Forbidden
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
Exemple de réponse
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Erreur
Status: 404, Not found
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
|
titre |
chaîne |
Vrai |
|
détail |
chaîne |
Vrai |
|
statut |
chaîne |
Vrai |
|
identifiant de corrélation |
chaîne |
Faux |
Exemple de réponse d'erreur
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Définitions
Voir les définitions
type_astra_label
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
nom |
chaîne |
Vrai |
|
valeur |
chaîne |
Vrai |
type_astra_metadata_update
Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :
-
Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
étiquettes |
tableau["type_astra_label"] |
Faux |
|
CréationTimestamp |
chaîne |
Faux |
|
ModificationTimestamp |
chaîne |
Faux |
|
CreatedBy |
chaîne |
Faux |
|
modifiedBy |
chaîne |
Faux |
invalidParams
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
nom |
chaîne |
Vrai |
Nom du paramètre de requête invalide |
raison |
chaîne |
Vrai |
Raison pour laquelle le paramètre de requête est invalide |