DescribePipeline - - Centre de documentation Alibaba Cloud

Consulte les informations du lot.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

sae:DescribePipeline

get

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

GET /pop/v1/sam/changeorder/DescribePipeline HTTP/1.1

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
PipelineId	string	Oui	L'identifiant du lot. Vous pouvez récupérer cet identifiant en appelant l'opération DescribeChangeOrder.	917660ba-5092-44ca-b8e0-80012c96****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse pour les informations du lot.
RequestId	string	L'identifiant de la requête.	559B4247-C41C-4D9E-B866-B55D360B****
Message	string	Les informations supplémentaires sur le résultat de l'appel.	success
TraceId	string	L'identifiant de trace utilisé pour interroger avec précision les informations d'appel.	0be3e0c316390414649128666e****
Data	object	Les informations du lot.
ShowBatch	boolean	Indique si l'exécution du lot suivant peut démarrer. Valeurs valides : false : L'exécution du lot suivant ne peut pas démarrer. true : L'exécution du lot suivant peut démarrer.	false
PipelineStatus	integer	L'état du lot. Valeurs valides : 0 : Prêt. 1 : En cours d'exécution. 2 : Réussi. 3 : Échoué. 6 : Abandonné. 10 : Échoué en raison d'une exception système.	2
CurrentStageId	string	L'identifiant de l'étape en cours d'exécution dans le lot.	c3a55592-4c30-4d84-ac2d-e98c18ec****
PipelineName	string	Le nom du lot.	First batch
StageList	array<object>	La liste des étapes du lot.
	array<object>	La structure de la liste des informations d'étape.
Status	integer	L'état de l'étape. Valeurs valides : 0 : Prêt. 1 : En cours d'exécution. 2 : Réussi. 3 : Échoué. 6 : Abandonné.	2
StageId	string	L'identifiant de l'étape.	c3a55592-4c30-4d84-ac2d-e98c18ec****
ExecutorType	integer	Le type d'étape. Valeurs valides : 0 : Séquentiel. 1 : Parallèle.	0
TaskList	array<object>	La liste des informations d'état des tâches.
	object	La structure des informations d'état de la tâche.
Status	integer	L'état de la tâche. Valeurs valides : 0 : Prêt. 1 : En cours d'exécution. 2 : Réussi. 3 : Échoué. 5 : En attente de nouvelle tentative. 6 : Abandonné.	2
StageId	string	L'identifiant de l'étape.	c3a55592-4c30-4d84-ac2d-e98c18ec****
ErrorMessage	string	Le message d'erreur pour l'exécution de la tâche. Ce message n'est pas renvoyé si la tâche réussit.	EDAS-10022
ErrorCode	string	Le code d'erreur pour l'échec de l'exécution de la tâche. Ce code n'est pas renvoyé si la tâche réussit.	EDAS-10022
TaskName	string	Le nom de la tâche.	Environment initialization
ErrorIgnore	integer	Indique si les tâches suivantes peuvent être exécutées après un échec. Valeurs valides : 0 : Non pris en charge. 1 : Pris en charge.	0
Message	string	Les informations d'exécution de la tâche.	init Namespace success
ShowManualIgnore	boolean	Indique si une tâche en cours d'exécution peut être ignorée manuellement. Valeurs valides : true : Pris en charge. false : Non pris en charge.	false
TaskId	string	L'identifiant de la tâche.	bef0122f-de9a-4ab0-8223-b88bf8ad****
StageName	string	Le nom de l'étape.	Application Deployment
NextPipelineId	string	L'identifiant du lot suivant.	b77b1c98-5772-4f05-95fc-c7bee5fa****
PipelineId	string	L'identifiant du lot.	917660ba-5092-44ca-b8e0-80012c96****
CoStatus	string	L'état de l'ordre de modification associé au lot.	Executed successfully
ErrorCode	string	Le code d'erreur. Valeurs valides : Requête réussie : Le champ ErrorCode n'est pas renvoyé. Requête échouée : Le champ ErrorCode est renvoyé. Pour plus d'informations, consultez la section Codes d'erreur de cette rubrique.	InvalidParameter.NotEmpty
Code	string	Le code d'état de l'API ou le code d'erreur POP. Valeurs valides : 2xx : Succès. 3xx : Redirection. 4xx : Erreur de requête. 5xx : Erreur de serveur.	200
Success	boolean	Indique si les informations du lot ont été interrogées avec succès. Valeurs valides : true : La requête a réussi. false : La requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "559B4247-C41C-4D9E-B866-B55D360B****",
  "Message": "succès",
  "TraceId": "0be3e0c316390414649128666e****",
  "Data": {
    "ShowBatch": false,
    "PipelineStatus": 2,
    "CurrentStageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
    "PipelineName": "Premier lot",
    "StageList": [
      {
        "Status": 2,
        "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
        "ExecutorType": 0,
        "TaskList": [
          {
            "Status": 2,
            "StageId": "c3a55592-4c30-4d84-ac2d-e98c18ec****",
            "ErrorMessage": "EDAS-10022",
            "ErrorCode": "EDAS-10022",
            "TaskName": "Initialisation de l'environnement",
            "ErrorIgnore": 0,
            "Message": "succès de l'initialisation de l'espace de noms",
            "ShowManualIgnore": false,
            "TaskId": "bef0122f-de9a-4ab0-8223-b88bf8ad****"
          }
        ],
        "StageName": "Déploiement de l'application"
      }
    ],
    "NextPipelineId": "b77b1c98-5772-4f05-95fc-c7bee5fa****",
    "PipelineId": "917660ba-5092-44ca-b8e0-80012c96****",
    "CoStatus": "Exécuté avec succès"
  },
  "ErrorCode": "Null",
  "Code": "200",
  "Success": true
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidParameter.NotEmpty	You must specify the parameter %s.	Paramètre non valide : %s ne peut pas être vide.
400	InvalidParameter.NoPermission	Resource no permission	Vous n'avez pas l'autorisation d'accéder à la ressource demandée.

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.