DescribeChangeOrder - - Centre de documentation Alibaba Cloud

Obtient les informations relatives à un ordre de modification.

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:DescribeChangeOrder

get

*All Resource

*

Aucune

Syntaxe de la requête

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

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ChangeOrderId	string	Oui	L'identifiant de l'ordre de modification. Vous pouvez l'obtenir en appelant l'API ListChangeOrders(~~126615~~). ListChangeOrders	76fa5c0-9ebb-4bb4-b383-1f885447****

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données renvoyées.
RequestId	string	L'identifiant de la requête.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	Le message renvoyé pour la requête.	success
TraceId	string	L'identifiant de trace de la requête. Cet identifiant est utilisé pour le dépannage.	0a98a02315955564772843261e****
Data	object	Les détails de l'ordre de modification.
Status	integer	L'état de l'ordre de modification. Valeurs valides : 0 : En préparation 1 : En cours 2 : Réussi 3 : Échoué 6 : Terminé 8 : En attente de confirmation manuelle 9 : En attente de confirmation automatique 10 : Échoué en raison d'une erreur système 11 : En attente d'approbation 12 : Approuvé et en attente d'exécution	2
SubStatus	integer	Le sous-état de l'ordre de déploiement. Ce paramètre indique si une exception s'est produite pendant le déploiement. Valeurs valides : 0 : Normal. 1 : Anormal. Par exemple, si un déploiement par lot échoue, vous devez effectuer manuellement un retour arrière, laissant l'ordre de déploiement dans l'état En cours.	0
ApprovalId	string	L'identifiant d'approbation pour l'opération.	67de0b39-a9d4-4c09-a170-cf438208****
ErrorMessage	string	Le message d'erreur.	success
BatchWaitTime	integer	Le temps d'attente, en minutes, entre les lots lors d'un déploiement automatique.	0
CreateTime	string	L'heure à laquelle l'ordre de modification a été créé.	2020-12-17 21:06:45
BatchCount	integer	Le nombre de lots.	1
CoTypeCode	string	Le code du type de modification. Valeurs valides : CoBindSlb : Lie une instance SLB. CoUnbindSlb : Délie une instance SLB. CoCreateApp : Crée une application. CoDeleteApp : Supprime une application. CoDeploy : Déploie une application. CoRestartApplication : Redémarre une application. CoRollback : Effectue un retour arrière d'une application. CoScaleIn : Réduit une application. CoScaleOut : Étend une application. CoStart : Démarre une application. CoStop : Arrête une application. CoRescaleApplicationVertically : Modifie les spécifications des instances. CoDeployHistroy : Effectue un retour arrière vers une version historique. CoBindNas : Lie un système de fichiers NAS. CoUnbindNas : Délie un système de fichiers NAS. CoBatchStartApplication : Démarre des applications par lots. CoBatchStopApplication : Arrête des applications par lots. CoRestartInstances : Redémarre des instances. CoDeleteInstances : Supprime des instances. CoScaleInAppWithInstances : Réduit une application en spécifiant des instances.	CoRestartInstances
SupportRollback	boolean	Indique si le retour arrière est pris en charge. Valeurs valides : true : Le retour arrière est pris en charge. false : Le retour arrière n'est pas pris en charge.	false
ChangeOrderId	string	L'identifiant de l'ordre de modification.	765fa5c0-9ebb-4bb4-b383-1f885447**
AppName	string	Le nom de l'application.	app-test
BatchType	string	Le mode de déploiement par lots. Valeurs valides : auto : Déploiement automatique. manual : Déploiement manuel.	auto
Description	string	La description de l'ordre de modification.	description
CoType	string	Le type de modification. Ce paramètre est une description de CoTypeCode.	Redémarrage des instances par lots
Auto	boolean	Indique si la modification doit être déployée automatiquement par lots. Valeurs valides : true : La modification est déployée automatiquement. false : La modification n'est pas déployée automatiquement.	true
CurrentPipelineId	string	L'identifiant du lot actuel.	0e4acf82-c9b1-4c1e-ac28-55776338****
Pipelines	array<object>	Les informations sur les lots.
	object	Les informations relatives à un lot.
Status	integer	The status of the batch. Valid values: 0: Preparing 1: In progress 2: Succeeded 3: Failed 6: Terminated 8: Awaiting manual confirmation 9: Awaiting automatic confirmation 10: Failed due to a system error 11: Pending approval 12: Approved and pending execution	2
StartTime	integer	The start time of the batch.	1562831689704
UpdateTime	integer	The time when the batch was last updated.	1562847178007
BatchType	integer	The batch type.	0
ParallelCount	integer	The number of parallel tasks in a batch.	0
PipelineName	string	The batch name.	Batch 1 Change
PipelineId	string	The batch ID.	0e4acf82-c9b1-4c1e-ac28-55776338****
AppId	string	L'identifiant de l'application.	bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****
ApplicationUpdateStrategy	string	La stratégie de mise à jour de l'application.
ApplicationEnableGreyTagRoute	boolean	Indique si le routage par balise grise est activé.
ErrorCode	string	Le code d'erreur. Si la requête aboutit, ce paramètre n'est pas renvoyé. Si la requête échoue, ce paramètre est renvoyé. Pour plus d'informations, consultez la section codes d'erreur de cette rubrique.
Code	string	Le code d'état HTTP ou le code d'erreur POP. Valeurs valides : 2xx : La requête a abouti. 3xx : La requête a été redirigée. 4xx : Une erreur côté client s'est produite. 5xx : Une erreur côté serveur s'est produite.	200
Success	boolean	Indique si la requête a abouti. Valeurs valides : true : La requête a abouti. false : La requête a échoué.	true

Exemples

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a98a02315955564772843261e****",
  "Data": {
    "Status": 2,
    "SubStatus": 0,
    "ApprovalId": "67de0b39-a9d4-4c09-a170-cf438208****",
    "ErrorMessage": "success",
    "BatchWaitTime": 0,
    "CreateTime": "2020-12-17 21:06:45",
    "BatchCount": 1,
    "CoTypeCode": "CoRestartInstances",
    "SupportRollback": false,
    "ChangeOrderId": "765fa5c0-9ebb-4bb4-b383-1f885447**",
    "AppName": "app-test",
    "BatchType": "auto",
    "Description": "description",
    "CoType": "Batch Restart Instances",
    "Auto": true,
    "CurrentPipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****",
    "Pipelines": [
      {
        "Status": 2,
        "StartTime": 1562831689704,
        "UpdateTime": 1562847178007,
        "BatchType": 0,
        "ParallelCount": 0,
        "PipelineName": "Batch 1 Change",
        "PipelineId": "0e4acf82-c9b1-4c1e-ac28-55776338****"
      }
    ],
    "AppId": "bbbbb-3fd370b2-3646-4ba6-91f9-9423e19ab0cd-*****",
    "ApplicationUpdateStrategy": "",
    "ApplicationEnableGreyTagRoute": false
  },
  "ErrorCode": "",
  "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.
400	Resouce.no.permission	You are not authorized to operate on the specified resources.	You are not authorized to operate on the specified resources.
400	InvalidChangeOrder.NotFound	The current change order does not exist.	The current change order does not exist.
404	InvalidAppId.NotFound	The specified AppId does not exist.

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

Notes de version

Consultez Notes de version pour la liste complète.