Recupera un abbonamento
GET /accounts/{account_id}/core/v1/subscriptions/{subscription_id}
Restituisce la risorsa API di sottoscrizione memorizzata nel corpo della risposta JSON.
Parametri
| Nome | Tipo | In | Obbligatorio | Descrizione |
|---|---|---|---|---|
ID account |
stringa |
percorso |
Vero |
ID della risorsa account contenitore
|
subscription_id |
stringa |
percorso |
Vero |
ID della raccolta di abbonamenti da elencare |
Risposta
Status: 200, Returns the stored Subscription API resource in the JSON response body.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
Tipo di media della risorsa. I valori definiti sono:
|
versione |
stringa |
Vero |
Versione della risorsa. I valori definiti sono:
|
id |
stringa |
Vero |
Identificatore univoco globale della risorsa. I valori definiti sono:
|
customerProfileID |
stringa |
Vero |
La stringa JSON contenente l'ID del profilo del cliente da "Authorize.net", che è stata richiamata dall'interfaccia utente, non è impostata per il periodo di prova. Restituisce una stringa vuota durante l'operazione di lettura, se non impostata. I valori definiti sono:
|
paymentProfileID |
stringa |
Falso |
Stringa JSON contenente l'ID del profilo di pagamento da "Authorize.net" che è stato richiamato dall'interfaccia utente, non impostato per il grace period. Restituisce una stringa vuota durante l'operazione di lettura se non impostato. I valori definiti sono:
|
paymentExpiry |
stringa |
Falso |
Stringa JSON contenente un timestamp che indica quando il metodo di pagamento scade. Questo è ottenuto da authorize.net(http://authorize.net e viene impostato dall'interfaccia utente. I valori definiti sono:
|
purchaseOrderNumber |
stringa |
Falso |
Stringa JSON contenente il numero dell'ordine di acquisto per il metodo di pagamento. I valori definiti sono:
|
marketplace |
stringa |
Falso |
Stringa JSON che indica il marketplace per un account in cui verranno registrati i pagamenti. Valori definiti:
|
licenseSN |
stringa |
Falso |
Stringa JSON contenente il numero di serie della licenza per il metodo di pagamento. I valori definiti sono:
|
termini |
stringa |
Vero |
Stringa JSON che indica il livello attuale dell'account. I valori definiti sono:
|
stato |
stringa |
Vero |
Stringa JSON che indica lo stato attuale dell'abbonamento. I valori definiti sono:
|
appLimit |
numero |
Vero |
Numero JSON che indica il limite di applicazioni per questo abbonamento. Il valore -1 indica nessun limite. |
namespaceLimit |
numero |
Vero |
Numero JSON che indica il limite di namespace per questo abbonamento. Il valore -1 indica nessun limite. |
subscriptionPeriod |
numero |
Vero |
Numero JSON che indica il periodo di abbonamento. Il valore -1 indica nessun limite. Unità: giorni |
gracePeriod |
numero |
Vero |
Numero JSON che indica il grace period successivo alla scadenza del periodo di prova o all'annullamento di un abbonamento a pagamento. Unità: giorni |
reminderBeforePeriod |
numero |
Vero |
Numero JSON che indica il numero di giorni prima della fine del periodo di prova in cui inizieranno le notifiche al cliente. Il valore è espresso in giorni con un valore di -1 che indica che non è applicabile. |
onboardStatus |
stringa |
Vero |
Stringa JSON che indica lo stato attuale dell'onboarding del cliente. I valori validi sono "non avviato", "in corso", "riuscito", "fallito". I valori definiti sono:
|
costPerAppUnit |
numero |
Vero |
Numero JSON che indica il costo per unità dell'app. Per la versione di prova, il valore è 0. Unità: dollari statunitensi |
costPerNamespaceUnit |
numero |
Vero |
Numero JSON che indica il costo per unità di namespace. Per la versione di prova, il valore è 0. Unità: dollari statunitensi |
metadati |
Vero |
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
|
Risposta tipo
{
"type": "application/astra-subscription",
"version": "1.2",
"id": "40b4106f-b743-5d83-95c7-d539b2b45f63",
"customerProfileID": "2157047189",
"paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
"paymentExpiry": "2022-02-01T00:00:00Z",
"purchaseOrderNumber": "72384632",
"marketplace": "netapp",
"licenseSN": "278343",
"terms": "trial",
"status": "active",
"onboardStatus": "success",
"costPerAppUnit": 0,
"costPerNamespaceUnit": 0.005,
"appLimit": 0,
"namespaceLimit": 10,
"subscriptionPeriod": 90,
"gracePeriod": 7,
"reminderBeforePeriod": 30,
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Risposta
Status: 401, Unauthorized
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Risposta
Status: 400, Bad request
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
|
invalidParams |
vettore["invalidParams"] |
Falso |
Elenco dei parametri di query non validi |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Risposta
Status: 403, Forbidden
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Risposta tipo
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Errore
Status: 404, Not found
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
tipo |
stringa |
Vero |
|
titolo |
stringa |
Vero |
|
dettaglio |
stringa |
Vero |
|
stato |
stringa |
Vero |
|
ID correlazione |
stringa |
Falso |
Esempio di risposta di errore
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definizioni
Vedi definizioni
etichetta tipo_astra
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
|
valore |
stringa |
Vero |
aggiornamento dei metadati di tipo Astra
Metadati specificati dal client e dal servizio associati alla risorsa. I valori definiti sono:
-
Conforme allo schema dei metadati di Astra. Se non specificato in fase di creazione, verrà creato un oggetto metadati senza etichette. Se non specificato in fase di aggiornamento, le etichette dell'oggetto metadati, creationTimestamp e createdBy, verranno conservate senza modifiche.
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
etichette |
vettore["etichetta tipo_astra"] |
Falso |
|
CreationTimestamp |
stringa |
Falso |
|
ModificationTimestamp |
stringa |
Falso |
|
CreatedBy |
stringa |
Falso |
|
modifiedBy |
stringa |
Falso |
invalidParams
| Nome | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
nome |
stringa |
Vero |
Nome del parametro di query non valido |
motivo |
stringa |
Vero |
Motivo per cui il parametro di query non è valido |