GetDeployment - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Par souci de simplicité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	GetDeployment	L'opération que vous souhaitez exécuter. Définissez la valeur sur GetDeployment.
ProjectId	Long	Non	10000	L'ID de l'espace de travail DataWorks. Cliquez sur l'icône Workspace Manage dans le coin supérieur droit de la page DataStudio pour accéder à la page Work space et afficher l'ID de l'espace de travail.
ProjectIdentifier	String	Non	dw_project	L'identifiant unique de l'espace de travail DataWorks. Cliquez sur l'identifiant dans le coin supérieur gauche de la page DataStudio pour basculer vers un autre espace de travail. Configurez ce paramètre ou le paramètre ProjectId pour déterminer l'espace de travail DataWorks auquel l'opération s'applique.
DeploymentId	Long	Oui	3000001	L'ID du package de déploiement. Un ID de package de déploiement est généré lorsque vous appelez l'opération SubmitFile ou DeployFile.

Paramètres de réponse

Paramètre	Type	Exemple	Description
HttpStatusCode	Integer	200	Le code d'état HTTP.
ErrorMessage	String	The connection does not exist.	Le message d'erreur.
RequestId	String	0000-ABCD-EFG****	L'ID de la requête.
ErrorCode	String	Invalid.Tenant.ConnectionNotExists	Le code d'erreur.
Success	Boolean	true	Indique si la requête a abouti.
Data	Object		Les données renvoyées.
Deployment	Object		Les détails du package de déploiement.
Status	Integer	1	Le statut du package de déploiement. Valeurs valides : 0, 1 et 2. La valeur 0 indique que le package de déploiement est prêt. La valeur 1 indique que le déploiement du package a réussi. La valeur 2 indique que le déploiement du package a échoué.
ErrorMessage	String	Success	Le message d'erreur renvoyé en cas d'échec du déploiement du package. Dans ce cas, la valeur du paramètre Status est 2.
FromEnvironment	Integer	0	L'environnement dans lequel le package de déploiement a été déployé. Valeurs valides : 0 et 1. La valeur 0 indique l'environnement local. La valeur 1 indique l'environnement de développement.
ToEnvironment	Integer	1	L'environnement vers lequel le fichier a été déployé. Valeurs valides : 1 et 2. La valeur 1 indique l'environnement de développement. La valeur 2 indique l'environnement de production.
CheckingStatus	Integer	7	Le statut de vérification d'un ou plusieurs fichiers dans le package de déploiement. Si la valeur du paramètre ToEnvironment est 1, les fichiers ne peuvent être déployés dans l'environnement de production que si la valeur du paramètre Status est 1 et que le paramètre CheckingStatus est vide. Valeurs valides : 7 : échec de la vérification 8 : vérification en cours
CreateTime	Long	1593877765000	L'heure de création du package de déploiement. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
HandlerId	String	2003****	L'ID du compte Alibaba Cloud utilisé par l'utilisateur qui a exécuté le package de déploiement.
CreatorId	String	20030****	L'ID du compte Alibaba Cloud utilisé par l'utilisateur qui a créé le package de déploiement.
ExecuteTime	Long	1593877765000	L'heure de déploiement du package de déploiement. Cette valeur est un horodatage UNIX représentant le nombre de millisecondes écoulées depuis le 1er janvier 1970, 00:00:00 UTC.
Name	String	ods_user_info_d-2020-07-04_20030****	Le nom du package de déploiement. La valeur correspond au nom du package de déploiement spécifique affiché sur la page Deployment Packages dans Deploy.
DeployedItems	Array of DeployedItem		Les éléments déployés.
FileId	Long	507642378	L'ID du fichier.
FileVersion	Long	7	La version du fichier.
Status	Integer	1	Le statut. Valeurs valides : UNPUBLISHED(0) : non déployé SUCCESS(1) : déployé ERROR(2) : échec du déploiement CLONED(3) : cloné DEPLOY_ERROR(4) : échec du déploiement CLONING(5) : clonage en cours REJECT(6) : demande de déploiement rejetée

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=GetDeployment
&ProjectId=10000
&ProjectIdentifier=dw_project
&DeploymentId=3000001
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<GetDeploymentResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <ErrorMessage>The connection does not exist.</ErrorMessage>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
    <Success>true</Success>
    <Data>
        <Deployment>
            <Status>1</Status>
            <ErrorMessage>Success</ErrorMessage>
            <FromEnvironment>0</FromEnvironment>
            <ToEnvironment>1</ToEnvironment>
            <CheckingStatus>7</CheckingStatus>
            <CreateTime>1593877765000</CreateTime>
            <HandlerId>2003****</HandlerId>
            <CreatorId>20030****</CreatorId>
            <ExecuteTime>1593877765000</ExecuteTime>
            <Name>ods_user_info_d-2020-07-04_20030****</Name>
        </Deployment>
        <DeployedItems>
            <FileId>507642378</FileId>
            <FileVersion>7</FileVersion>
            <Status>1</Status>
        </DeployedItems>
    </Data>
</GetDeploymentResponse>

JSON format

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

{
  "HttpStatusCode" : 200,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true,
  "Data" : {
    "Deployment" : {
      "Status" : 1,
      "ErrorMessage": "Success",
      "FromEnvironment" : 0,
      "ToEnvironment" : 1,
      "CheckingStatus" : 7,
      "CreateTime" : 1593877765000,
      "HandlerId" : "2003****",
      "CreatorId" : "20030****",
      "ExecuteTime" : 1593877765000,
      "Name" : "ods_user_info_d-2020-07-04_20030****"
    },
    "DeployedItems" : {
      "FileId" : 507642378,
      "FileVersion" : 7,
      "Status" : 1
    }
  }
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
429	Throttling.Api	The request for this resource has exceeded your available limit.	Le nombre de requêtes pour 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.	Un nombre excessif de requêtes a été soumis dans un court laps de temps. 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 obtenir la liste des codes d'erreur, consultez Codes d'erreur de service.