Skip to main content
Astra Automation
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Énumérer tous les droits

PDF

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

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 : produit,entitlementType,entitlementValue,allocation

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' »

Orderby

chaîne

requête

Faux

Indique l'ordre de tri des ressources lors de l'affichage d'une collection.

Exemples d'URL : « orderBy=name », « orderBy=name%20desc »

Exemples OpenAPI : « name desc »

ignorer

chaîne

requête

Faux

Indique le nombre de ressources à ignorer lors de l'énumération d'une collection.

Exemples d'URL : « skip=1 »

Exemples OpenAPI : « 1 »

nombre

chaîne

requête

Faux

Indique si le nombre total de ressources doit être renvoyé dans l'objet métadonnées.

Exemples d'URL : « count=true »

Exemples OpenAPI : "true"

continuer

requête

Faux

Indique le jeton à partir duquel reprendre la liste.

Exemples d'URL : « continue= »

Exemples OpenAPI : ""</continue>

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 : "entitlement_1.0_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-entitlements",
  "version": "1.0",
  "items": [
    [
      "Astra SDS",
      "capacity",
      "2",
      null
    ],
    [
      "Astra Enterprise",
      "clusters",
      "100",
      "5e9fe8f7-4c54-441c-ac94-fd8451f9ca38"
    ]
  ],
  "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

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

Nom Type Obligatoire Description

étiquettes

tableau["type_astra_label"]

Vrai

CréationTimestamp

chaîne

Vrai

ModificationTimestamp

chaîne

Vrai

CreatedBy

chaîne

Vrai

modifiedBy

chaîne

Faux

entitlement_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-entitlement"

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 l'identifiant de l'objet auquel le droit est attribué. Présente uniquement lorsque le droit est attribué. Le contenu de la chaîne n'est pas validé par le schéma.

produit

chaîne

Faux

Chaîne JSON contenant la chaîne de produit extraite de la licence ou de l'abonnement. Contenu de la chaîne non validé par le schéma.

productVersion

chaîne

Faux

Chaîne JSON contenant la chaîne de version extraite de la licence ou de l'abonnement. Contenu de la chaîne non validé par le schéma.

entitlementType

chaîne

Vrai

Chaîne JSON contenant le type de droit. Cette information est extraite de la licence ou de l'abonnement. Le contenu de la chaîne n'est pas validé par le schéma.

entitlementValue

chaîne

Vrai

Chaîne JSON contenant la capacité associée au droit. Contenu de la chaîne non validé par le schéma.

entitlementConsumption

chaîne

Faux

Chaîne JSON contenant la quantité de capacité associée au droit actuellement utilisée. Le contenu de cette chaîne n'est pas validé par le schéma.

sourceLicense

chaîne

Faux

Chaîne JSON contenant l'identifiant de l'objet de licence dont provient le droit d'utilisation. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

sourceSubscription

chaîne

Faux

Chaîne JSON contenant l'ID de l'objet d'abonnement dont provient le droit. Les valeurs définies sont :

  • Conforme au schéma d'identifiant Astra

validFromTimestamp

chaîne

Faux

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

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

validUntilTimestamp

chaîne

Faux

Chaîne JSON contenant un horodatage indiquant la date à laquelle le droit n'est plus valide. Les valeurs définies sont :

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

les métadonnées

"type_astra_metadata"

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

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