Tous les produits
Search
Centre de documentation

:DeployFile

Dernière mise à jour :Aug 09, 2026

Déploie un fichier de DataStudio vers l'environnement de production. Après avoir appelé l'opération DeployFile, utilisez l'opération GetDeployment pour interroger le statut de la tâche de déploiement asynchrone, en vous basant sur la valeur du paramètre Data renvoyée par l'opération DeployFile.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. Celui-ci génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre

Type

Obligatoire

Exemple

Description

Action

String

Yes

DeployFile

L'action à effectuer. Définissez la valeur sur DeployFile.

ProjectId

Long

No

10000

L'ID de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Workspace pour obtenir cet ID. Renseignez ce paramètre ou le paramètre ProjectIdentifier afin d'identifier l'espace de travail DataWorks ciblé par l'opération.

ProjectIdentifier

String

No

dw_project

Le nom de l'espace de travail DataWorks. Connectez-vous à la console DataWorks et accédez à la page Workspace pour obtenir ce nom. Renseignez ce paramètre ou le paramètre ProjectId afin d'identifier l'espace de travail DataWorks ciblé par l'opération.

FileId

Long

Yes

10000001

L'ID du fichier. Appelez l'opération ListFiles pour récupérer cette information.

Renseignez ce paramètre ou le paramètre NodeId.

Comment

String

No

Deploy for the first time

La description de l'opération de déploiement.

NodeId

Long

No

2000001

L'ID du nœud correspondant au fichier à déployer dans le système d'ordonnancement. Renseignez ce paramètre ou le paramètre FileId.

Paramètres de réponse

Paramètre

Type

Exemple

Description

HttpStatusCode

Integer

200

Le code d'état HTTP.

Data

Long

30000001

L'ID du package de déploiement. Utilisez cette valeur comme paramètre lors de l'appel à l'opération GetDeployment pour obtenir les détails du déploiement.

RequestId

String

0000-ABCD-EFG****

L'ID de la requête.

ErrorMessage

String

The connection does not exist.

Le message d'erreur.

Success

Boolean

true

Indique si la requête a abouti.

ErrorCode

String

Invalid.Tenant.ConnectionNotExists

Le code d'erreur.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=DeployFile
&ProjectId=10000
&ProjectIdentifier=dw_project
&FileId=10000001
&Comment=Deploy for the first time
&NodeId=2000001
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<DeployFileResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Data>30000001</Data>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <Success>true</Success>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
</DeployFileResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "Data" : 30000001,
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorMessage" : "The connection does not exist.",
  "Success" : true,
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists"
}

Codes d'erreur

Code d'état HTTP

Code d'erreur

Message d'erreur

Description

403

Forbidden.Access

Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.

Aucune autorisation.

429

Throttling.Api

The request for this resource has exceeded your available limit.

Le nombre de requêtes adressées à la ressource a dépassé la limite supérieure.

429

Throttling.System

The DataWorks system is busy. Try again later.

Le système DataWorks est occupé. Réessayez ultérieurement.

429

Throttling.User

Your request is too frequent. Try again later.

Trop de requêtes ont été soumises sur une courte période. Réessayez ultérieurement.

500

InternalError.System

An internal system error occurred. Try again later.

Une erreur interne s'est produite. Réessayez ultérieurement.

500

InternalError.UserId.Missing

An internal system error occurred. Try again later.

Une erreur interne s'est produite. Réessayez ultérieurement.

Pour consulter la liste des codes d'erreur, reportez-vous aux Codes d'erreur du service.