Commit e10c743b authored by Daniel Dehennin's avatar Daniel Dehennin
Browse files

Import API v1

parent cb2ae6a8
---
uri: server.error.database-not-available
sampleuse: ~
description: |
No available database service
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.list
- server.describe
- server.create
- server.update
- server.delete
---
uri: server.error.db-connection
sampleuse: ~
description: |
Database connection error
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.list
- server.describe
- server.create
- server.update
- server.delete
---
uri: server.error.invalid-server-id
sampleuse: ~
description: |
Invalid server ID
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.describe
- server.update
- server.delete
---
uri: server.error.invalid-servermodel-id
sampleuse: ~
description: |
Invalid servermodel ID
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.create
---
uri: server.error.peering-conf-not-available
sampleuse: ~
description: |
No available peering conf
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.get-peering-conf
---
uri: server.error.servername-not-provided
sampleuse: ~
description: |
Servername expected
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.create
- server.update
---
uri: server.error.unknown-server-id
sampleuse: ~
description: |
Unknown server ID
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.describe
- server.update
- server.delete
---
uri: server.error.unknown-servermodel-id
sampleuse: ~
description: |
Unknown servermodel ID
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.create
---
uri: server.error.db-connection
sampleuse: ~
description: |
Unattended error in server management
public: true
pattern: error
parameters:
reason:
type: String
description: human readable error message
domain: server-domain
related:
- server.list
- server.describe
- server.create
- server.update
- server.delete
---
uri: server.exec.command
description: |
Transmet une commande à exécuter sur un serveur donné.
sampleuse: |
zephir-client server.exec.command '{"server_id":1, "command":"reconfigure"}'
domain: server-domain
pattern: rpc
public: true
parameters:
server_id:
type: Number
description: Identifiant du serveur sur lequel la commande sera exécutée.
ref: Server.ServerId
command:
type: String
description: Commande à exécuter.
ref: salt.exec.availablecommands
response:
type: ServerExec
description: La commande exécutée.
errors:
- uri: server.exec.error.missing-command
- uri: server.exec.error.unmanaged-server
related:
- server.exec.error.missing-command
- server.exec.error.unmanaged-server
---
uri: server.exec.deploy
description: |
Déployer la configuration sur un serveur donné.
sampleuse: |
zephir-client server.exec.deploy '{"serverid":"1"}'
domain: server-domain
pattern: rpc
public: true
parameters:
server_id:
type: Number
description: Identifiant du serveur.
ref: Server.ServerId
response:
type: ServerExec
description: La commande exécutée.
---
uri: server.exec.describe
description: |
Liste les commandes exécuté pour un identifiant de tâche.
sampleuse: |
zephir-client server.exec.list '{"job_id":"1"}'
domain: execution-domain
pattern: rpc
public: true
parameters:
job_id:
type: String
description: Identifiant de la tâche.
ref: Server.JobId
automation:
type: String
description: Moteur d'exécution.
ref: Server.automation
response:
type: "[]ServerExec"
description: Liste des commandes exécutées.
---
uri: server.exec.error.missing-command
sampleuse: ~
description: |
the request did not provide the “command” keywork argument
public: true
pattern: error
parameters:
reason:
type: String
description: message of the error for humans
domain: server-domain
related:
- server.exec
---
uri: server.exec.error.unmanaged-server
sampleuse: ~
description: |
the server has no executor associated
public: true
pattern: error
parameters:
reason:
type: String
description: message of the error for humans
domain: server-domain
related:
- server.exec
---
uri: server.exec.list
description: |
Liste les commandes exécutées sur un serveur donné.
sampleuse: |
zephir-client server.exec.list '{"server_id":1}'
domain: execution-domain
pattern: rpc
public: true
parameters:
server_id:
type: Number
description: Identifiant du serveur.
ref: Server.ServerId
response:
type: "[]ServerExec"
description: Liste des commandes exécutées.
---
uri: server.executed
sampleuse: ~
description: |
La commande a été lancée sur le serveur
pattern: event
public: false
domain: server-domain
parameters:
arguments:
type: Dict
description: |
Liste des arguments utilisés
return:
type: Dict
description: |
Retour du message
---
uri: server.list
description: |
Liste les serveurs disponibles.
sampleuse: |
zephir-client server.list
public: true
pattern: rpc
domain: server-domain
response:
type: '[]Server'
description: Retourne la liste des serveurs.
---
uri: server.peer-connection.update
description: Updates the last peer connection of a server
public: false
sampleuse: zephir-client server.peer-connection.update '{"serverid":1}'
pattern: rpc
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: Server identifier
response:
type: Boolean
description: La mise à jour a réussi.
errors:
- uri: server.error.database-not-available
- uri: server.error.db-connection
- uri: server.error.invalid-server-id
- uri: server.error.unknown-server-id
- uri: server.error.servername-not-provided
related:
- servermodel.list
- servermodel.describe
- servermodel.create
- servermodel.delete
---
uri: server.peering-conf.get
description: |
Accès à la configuration d'appairage.
sampleuse: |
zephir-client server.peering-conf.get '{"serverid":1}'
pattern: rpc
public: true
domain: server-domain
parameters:
serverid:
type: Number
ref: Server.ServerId
description: ID du serveur.
response:
type: ServerPeeringConf
description: Configuration d'appairage.
errors:
- uri: server.error.peering-conf-not-available
related:
- server.list
- server.create
- server.update
- server.delete
---
uri: server.peering-conf.sent
sampleuse: ~
description: La configuration d'appairage du serveur a été envoyée à l'utilisateur.
pattern: event
public: false
domain: server-domain
parameters:
serverid:
type: Number
description: ID du serveur.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment