Récupérer une licence
GET /accounts/{account_id}/core/v1/licenses/{license_id}
Renvoie la ressource API de licence 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
|
identifiant_de_licence |
chaîne |
chemin |
Vrai |
ID de la collection de licences à lister |
Réponse
Status: 200, Returns the stored License 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 :
|
allocation |
chaîne |
Faux |
Chaîne JSON contenant un identifiant indiquant à quoi la licence est attribuée. Présent uniquement lorsque la licence est attribuée. Pour les licences Astra Control Center, ce champ doit être renseigné avec l'identifiant du compte et doit correspondre à l'identifiant du compte spécifié dans l'URI POST. Valeurs définies :
|
ID hôte |
chaîne |
Faux |
Chaîne JSON contenant un identifiant d'hôte auquel une licence est associée. Présente uniquement si la licence est liée à un hôte. Valeurs définies :
|
identifiant d’identification de l’appareil |
chaîne |
Faux |
Chaîne JSON contenant l'identifiant du deviceCredential associé à l'API Credential. Présente uniquement pour les licences Astra Data Store. Les valeurs définies sont :
|
isEvaluation |
chaîne |
Vrai |
Chaîne JSON indiquant si la licence est une licence d'évaluation. Les valeurs définies sont :
|
licenseProtocol |
chaîne |
Vrai |
Chaîne JSON contenant le protocole de licence extrait de la licence. Les valeurs définies sont :
|
licenseText |
chaîne |
Vrai |
Chaîne JSON contenant une représentation encodée en base64 du JSON de la licence, telle qu'obtenue auprès du système de licences NetApp. Cette chaîne doit être fournie dans l'ordre d'octets d'origine pour permettre la vérification de la signature. Les valeurs définies sont :
|
validFromTimestamp |
chaîne |
Vrai |
Chaîne JSON contenant un horodatage indiquant quand la licence devient valide. Les valeurs définies sont :
|
validUntilTimestamp |
chaîne |
Vrai |
Chaîne JSON contenant un horodatage indiquant quand la licence n'est plus valide. Valeurs définies :
|
produit |
chaîne |
Vrai |
Chaîne JSON contenant la chaîne de produit extraite de la licence. Les valeurs définies sont :
|
productVersion |
chaîne |
Vrai |
Chaîne JSON contenant la chaîne de version extraite de la licence. Les valeurs définies sont :
|
productSN |
chaîne |
Vrai |
Chaîne JSON contenant le numéro de série extrait de la licence. Les valeurs définies sont :
|
caractéristiques |
chaîne |
Vrai |
Chaîne JSON contenant la valeur du package extraite de la licence. Les valeurs définies sont :
|
capacité |
chaîne |
Vrai |
Chaîne JSON contenant la capacité extraite de la licence. |
capacity2 |
chaîne |
Vrai |
Chaîne JSON contenant la capacité secondaire extraite de la licence. |
modules complémentaires |
tableau["modules complémentaires"] |
Faux |
Tableau JSON d'objets JSON contenant la liste des add-ons de la licence. Un add-on correspond à une modification de la licence pouvant intervenir à une date ultérieure. |
les métadonnées |
Vrai |
Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :
|
Exemple de réponse
{
"type": "application/astra-license",
"version": "1.0",
"id": "6db53b32-8417-5d3c-8ef0-552fc602c78f",
"allocation": "4185d09b-6687-4801-a832-c005a9d94f41",
"hostID": "99132549-e0c2-4203-9d1e-598628b4ff9b",
"isEvaluation": "false",
"licenseProtocol": "ASTRASDS-ENT-SUBS",
"licenseText": "ewogICAic3RhdHVzUmVzcCI6ewogMTYwNzAwIgp9",
"validFromTimestamp": "2020-08-06T00:00:00.000000Z",
"validUntilTimestamp": "2021-08-06T00:00:00.000000Z",
"product": "Astra Control Center",
"productVersion": "1.0",
"productSN": "320000046",
"features": "ASTRA-ENT-STD",
"capacity": "4000",
"capacity2": "0",
"addons": [
{
"startDate": "2020-08-06T00:00:00.000000Z",
"endDate": "2021-08-06T00:00:00.000000Z",
"capacity": "4000",
"licenseProtocol": "ASTRA-ENT-STD",
"features": "p-nfs,dm-storage-policy-based-pvs-for-k8s,dm-spbm-based-vvols-for-vms,dm-storage-efficiency,dm-data-at-rest-encryption"
}
],
"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
modules complémentaires
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
startDate |
chaîne |
Faux |
Chaîne JSON contenant un horodatage indiquant quand cette extension devient valide. Les valeurs définies sont :
|
endDate |
chaîne |
Faux |
Chaîne JSON contenant un horodatage indiquant la date à laquelle ce module complémentaire n'est plus valide. Les valeurs définies sont :
|
caractéristiques |
chaîne |
Faux |
Chaîne JSON contenant la liste des fonctionnalités associées à ce module complémentaire. Les valeurs définies sont :
|
capacité |
chaîne |
Faux |
Chaîne JSON contenant la capacité extraite du module complémentaire. Les valeurs définies sont :
|
licenseProtocol |
chaîne |
Faux |
Chaîne JSON contenant le protocole de licence associé à ce module complémentaire. Les valeurs définies sont :
|
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 |