Skip to main content
Astra Automation
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Lister toutes les licences

PDF

GET /accounts/{account_id}/core/v1/licenses

Renvoie un tableau JSON contenant toutes les ressources correspondantes de la collection. Si des champs individuels sont spécifiés dans la requête, le tableau JSON items contiendra les champs demandés pour chaque ressource correspondante dans l'ordre indiqué.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

inclure

chaîne

requête

Faux

Indique les champs qui doivent être renvoyés lors de l’énumération d’une collection.

Exemples d'URL : « include=id », « include=id,name »

Exemples OpenAPI : « id »

  • Exemple : identifiant, produit

limite

chaîne

requête

Faux

Indique le nombre maximal de ressources à renvoyer lors de l’énumération d’une collection.

Exemples d'URL : « limit=2 »

Exemples OpenAPI : « 2 »

filtre

chaîne

requête

Faux

Indique les champs qui doivent être mis en correspondance pour renvoyer une ressource lors du listage d'une collection.

Les opérateurs pris en charge sont :

  • eq - Égalité

  • lt/gt - Inférieur à/Supérieur à

  • LTE/GTE - Inférieur ou égal à/Supérieur ou égal à

Exemple d'URL : « filter=field%20eq%20%27value%27 »

Exemples OpenAPI : « field eq 'value' »

Réponse

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Nom Type Obligatoire Description

articles

tableau[N'importe lequel de : "corps de réponse license_1.0_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-licenses",
  "version": "1.0",
  "items": [
    [
      "c8aa757a-5318-489f-8134-a2a1a6956a3e",
      "Astra SDS"
    ],
    [
      "0f7cc03d-9afc-4192-af7f-b29ab24f8f2a",
      "Astra Enterprise"
    ]
  ],
  "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 :

  • Conforme au schéma de date et d'heure ISO-8601

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 :

  • Conforme au schéma de date et d'heure ISO-8601

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 :

  • Contenu de la chaîne non validé par le schéma.

capacité

chaîne

Faux

Chaîne JSON contenant la capacité extraite du module complémentaire. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

licenseProtocol

chaîne

Faux

Chaîne JSON contenant le protocole de licence associé à ce module complémentaire. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

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

corps de réponse license_1.0_get_response_body

Nom Type Obligatoire Description

type

chaîne

Vrai

Type de média de la ressource. Les valeurs définies sont :

  • "application/astra-license"

version

chaîne

Vrai

Version de la ressource. Les valeurs définies sont :

  • "1,0"

id

chaîne

Vrai

Identifiant unique global de la ressource. Les valeurs définies sont :

  • Conforme au schéma UUIDv4

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. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

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. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

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 :

  • Conforme au schéma d'identifiant Astra

isEvaluation

chaîne

Vrai

Chaîne JSON indiquant si la licence est une licence d'évaluation. Les valeurs définies sont :

  • "true"

  • "false"

licenseProtocol

chaîne

Vrai

Chaîne JSON contenant le protocole de licence extrait de la licence. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

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 :

  • Conforme au schéma de données encodées en base64

validFromTimestamp

chaîne

Vrai

Chaîne JSON contenant un horodatage indiquant quand la licence devient valide. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

validUntilTimestamp

chaîne

Vrai

Chaîne JSON contenant un horodatage indiquant quand la licence n'est plus valide. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

produit

chaîne

Vrai

Chaîne JSON contenant la chaîne de produit extraite de la licence. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

productVersion

chaîne

Vrai

Chaîne JSON contenant la chaîne de version extraite de la licence. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

productSN

chaîne

Vrai

Chaîne JSON contenant le numéro de série extrait de la licence. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

caractéristiques

chaîne

Vrai

Chaîne JSON contenant la valeur du package extraite de la licence. Les valeurs définies sont :

  • Contenu de chaîne non validé par le schéma

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

"type_astra_metadata_update"

Vrai

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.

type_astra_metadata_list

Nom Type Obligatoire Description

continuer

chaîne

Faux

nombre

nombre

Faux

é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