zone.site.describe

Retourne les attributs détaillées d’un site.

Exemple d’utilisation via l’API HTTP

zephir-client zone.site.describe '{"kwargs":{"site":1}}'
Type de message:
 rpc
Utilisable via l’API Gateway:
 oui
Domaine fonctionnel:
 zone-domain

Paramètres

siteid
Description:Identifiant du site à récupérer.
Type:Number
Requis:non

Réponse

Paramètres nommés

name
Description:Nom du site.
Type:String
description
Description:Desription du site
Type:String
parentid
Description:ID du site parent
Type:Number Zone.SiteId
siteid
Description:ID du site.
Type:Number Zone.SiteId

Erreurs

  • v1.zone.site.describe.error.database_not_available
  • v1.zone.site.describe.error.invalid_site_id
  • v1.zone.site.describe.error.unknown_site_id

Messages liés