Afficher tous les paramètres
GET /accounts/{account_id}/core/v1/settings
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
|
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 » |
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 :
Exemple d'URL : « filter=field%20eq%20%27value%27 » Exemples OpenAPI : « field eq 'value' » |
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" |
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 » |
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 : "setting_1.1_get_response_body", tableau[]] |
Vrai |
|
les métadonnées |
Vrai |
Exemple de réponse
{
"type": "application/astra-settings",
"version": "1.1",
"items": [
{
"type": "application/astra-setting",
"version": "1.0",
"id": "5da0a2ed-c51d-4d91-8b98-ed3aa8a88cc5",
"name": "astra.account.smtp",
"currentConfig": {
"credential": "",
"isEnabled": "false",
"port": 587,
"relayServer": "smtp.sendgrid.net"
},
"configSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "astra.account.smtp",
"type": "object",
"properties": {
"credential": {
"type": "string",
"description": "The credential ID for SMTP authentication."
},
"isEnabled": {
"type": "string",
"description": "This property determines if this setting is enabled or not."
},
"port": {
"type": "integer",
"description": "The SMTP port. For an unencrypted or a TLS connection, use port 25, 2525, or 587."
},
"relayServer": {
"type": "string",
"description": "This setting is sometimes referred to as the external SMTP server or the SMTP relay."
}
},
"additionalProperties": false,
"required": [
"relayServer",
"port",
"isEnabled"
]
},
"state": "valid",
"stateUnready": [],
"metadata": {
"labels": [],
"creationTimestamp": "2021-06-04T20:14:52Z",
"modificationTimestamp": "2021-06-04T20:14:52Z",
"createdBy": "c9550bbb-e70b-4578-8504-07397f875bcb",
"modifiedBy": "65e1571b-1b46-4f05-95b0-7d7f5a93da6a"
}
}
],
"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"
}
Réponse
Status: 503, Service unavailable
| 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/41",
"title": "Service not ready",
"detail": "Currently, the service can't respond to this request.",
"status": "503"
}
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_json
Objet JSON contenant les clés et les valeurs qui constituent la configuration actuelle de ce paramètre. Le contenu de cet objet doit être conforme au schéma JSON contenu dans le champ configSchema. Les valeurs par défaut sont fournies par le configmap. Après modification des valeurs par défaut par l'utilisateur, elles ne seront pas écrasées.
type_json
Objet JSON contenant les clés et les valeurs qui composent la configuration demandée pour ce paramètre. Le contenu de cet objet doit être conforme au schéma JSON contenu dans le champ configSchema. L'objet n'existe pas tant qu'il n'est pas spécifié. Lorsqu'il est spécifié, cela déclenche le service de fonctionnalités pour notifier le service correspondant afin de demander que la configuration souhaitée puisse être appliquée. Le service correspondant peut alors effectuer la validation et appliquer la configuration souhaitée à la configuration actuelle.
propriétés
type_json_schema
Objet JSON contenant le schéma JSON de la propriété config dans cette ressource. Doit être conforme au brouillon 7 du schéma JSON. Si des valeurs de config sont présentes dans la ressource, la validation par rapport au configSchema indiqué est obligatoire. Par convention courante, il est recommandé que les configurations comportent un champ « isEnabled », lorsque cela est approprié. Le champ « isEnabled » contient une valeur indiquant si le paramètre est activé (« true ») ou désactivé (« false »).
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
$schema |
chaîne |
Vrai |
|
type |
chaîne |
Vrai |
|
propriétés |
Vrai |
||
additionalProperties |
booléen |
Vrai |
|
requis |
tableau[chaîne] |
Vrai |
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 non spécifié 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 |
setting_1.1_get_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 paramètre, au format hiérarchique pointé (.). Les valeurs définies sont :
|
currentConfig |
Vrai |
Objet JSON contenant les clés et les valeurs qui constituent la configuration actuelle de ce paramètre. Le contenu de cet objet doit être conforme au schéma JSON contenu dans le champ configSchema. Les valeurs par défaut sont fournies par le configmap. Après modification des valeurs par défaut par l'utilisateur, elles ne seront pas écrasées. |
|
desiredConfig |
Faux |
Objet JSON contenant les clés et les valeurs qui composent la configuration demandée pour ce paramètre. Le contenu de cet objet doit être conforme au schéma JSON contenu dans le champ configSchema. L'objet n'existe pas tant qu'il n'est pas spécifié. Lorsqu'il est spécifié, cela déclenche le service de fonctionnalités pour notifier le service correspondant afin de demander que la configuration souhaitée puisse être appliquée. Le service correspondant peut alors effectuer la validation et appliquer la configuration souhaitée à la configuration actuelle. |
|
configSchema |
Vrai |
Objet JSON contenant le schéma JSON de la propriété config dans cette ressource. Doit être conforme au brouillon 7 du schéma JSON. Si des valeurs de config sont présentes dans la ressource, la validation par rapport au configSchema indiqué est obligatoire. Par convention courante, il est recommandé que les configurations comportent un champ « isEnabled », lorsque cela est approprié. Le champ « isEnabled » contient une valeur indiquant si le paramètre est activé (« true ») ou désactivé (« false »). |
|
État |
chaîne |
Vrai |
Chaîne JSON contenant une valeur indiquant l'état opérationnel de l'application. Les valeurs définies sont :
|
stateUnready |
tableau[chaîne] |
Vrai |
Tableau JSON de chaînes JSON, chacune indiquant une raison pour laquelle le paramètre n'a pas pu être appliqué. Les valeurs définies sont :
|
les métadonnées |
Vrai |
Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :
|
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 |