manager/client.ts

Source : sdks/typescript/packages/sdk/src/manager/client.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Interface ManagerClientOptions

Options de ManagerClient : URL, jeton, utilisateur représenté, langue, fetch, nouvelles tentatives, délai d'expiration et en-têtes.

Champs :

Nom	Type	Requis	Description
baseUrl	string	oui	URL du Platform Manager, par exemple <manager-url> (https, ou http sur localhost).
token	string | (() => string | Promise<string>)	non	Jeton d'accès au Hub. En écriture seule, scellé ; nul conserve le jeton enregistré.
onBehalfOf	string	non	Utilisateur pour lequel agit le jeton de service : envoie X-NM-On-Behalf-Of (jeton doté de la permission explicite auth:delegate).
locale	Locale	non	Langue des messages, en (par défaut) ou fr.
fetch	FetchLike	non	Implémentation de fetch à utiliser ; par défaut, le fetch global.
retries	number	non	Nombre de nouvelles tentatives de GET, PUT et DELETE sur 429, 5xx et erreurs réseau (2 par défaut) ; POST n'est jamais réessayé.
timeoutMs	number	non	Délai d'expiration par requête en ms (60000 par défaut, 0 le désactive).
headers	Record<string	non	En-têtes de l'événement, valeurs textuelles. Le contexte de trace y est ajouté.
sleep	(ms: number) => Promise<void>	non	Fonction d'attente utilisée entre les tentatives (injectable pour les tests).

Interface ManagerClient

Client de l'API du Platform Manager (hôtes, clusters, services, HA, sauvegardes, restaurations, PRA), avec un sous-client généré par groupe de manager-openapi.json.

Groups

Ce modèle ne déclare aucun champ.

Classe ManagerClient

Client de l'API du Platform Manager (hôtes, clusters, services, HA, sauvegardes, restaurations, PRA), avec un sous-client généré par groupe de manager-openapi.json.

Attributs :

Nom	Type	Requis	Description
http	HttpClient	oui	Transport HTTP partagé par tous les sous-clients.

Constructeur ManagerClient

new ManagerClient(options: ManagerClientOptions)

Vérifie le format du jeton nmt_<12 hex>_<secret>, ajoute X-NM-On-Behalf-Of si demandé et crée tous les sous-clients.

Nom	Type	Défaut	Requis	Description
options	ManagerClientOptions		oui	Options de l'appel (clé d'idempotence, traceparent, en-têtes, signal d'annulation).

ManagerClient.onBehalfOf

onBehalfOf(user: string): ManagerClient

Un client avec les mêmes réglages, agissant pour le compte de user.

Nom	Type	Défaut	Requis	Description
user	string		oui	Utilisateur pour lequel agit le jeton de service, envoyé en X-NM-On-Behalf-Of.

Retour : ManagerClient. Un nouveau ManagerClient ; le client courant n'est pas modifié.

ManagerClient.operation

operation(operationId: string): (...args: unknown[]) => Promise<unknown>

Appelle une opération de manager-openapi.json par son operationId (paramètres de chemin dans l'ordre du gabarit).

Nom	Type	Défaut	Requis	Description
operationId	string		oui	operationId de manager-openapi.json ; un identifiant inconnu lève une Error.

Retour : (...args: unknown[]) => Promise<unknown>. La méthode liée du sous-client qui encapsule l'opération.

Erreurs levées : Error.

ManagerClient.toJSON

toJSON(): Record<string, unknown>

Vue sûre du client pour les journaux : URL de base, langue, jeton masqué et onBehalfOf.

Cet élément ne prend aucun paramètre.

Retour : Record<string, unknown>. Objet sans aucun secret en clair.