DescribeCommands - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte les commandes Cloud Assistant que vous avez créées manuellement ou les commandes publiques fournies par Alibaba Cloud.

Description de l'opération

Si vous spécifiez uniquement les paramètres Action et RegionId sans spécifier d'autres paramètres de requête, toutes les commandes actives (CommandId) que vous avez créées manuellement sont interrogées par défaut.
Lors de l'interrogation de la première page de résultats avec une requête paginée, définissez uniquement MaxResults pour limiter le nombre d'entrées renvoyées. La valeur NextToken dans la réponse sert de jeton pour interroger les pages suivantes. Lors de l'interrogation des pages suivantes, définissez le paramètre NextToken sur la valeur NextToken obtenue dans la réponse précédente comme jeton de requête, et définissez MaxResults pour limiter le nombre d'entrées renvoyées.

Paramètres : Lors de la pagination, utilisez NextToken et MaxResults pour obtenir des résultats optimaux.

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.

ecs:DescribeCommands

get

Command.

acs:ecs:{#regionId}:{#accountId}:command/*

Command.

acs:ecs:{#regionId}:{#accountId}:command/{#commandId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
Provider	string	Non	Le fournisseur de la commande publique. Valeurs valides : Si ce paramètre n'est pas spécifié, toutes les commandes Cloud Assistant que vous avez créées manuellement sont interrogées par défaut. Si ce paramètre est défini sur AlibabaCloud, toutes les commandes publiques fournies par Alibaba Cloud sont interrogées. Si ce paramètre est défini sur un fournisseur de commandes publiques spécifique, toutes les commandes publiques fournies par ce fournisseur sont interrogées. Exemples : Si Provider=AlibabaCloud.ECS.GuestOS, les commandes publiques fournies par AlibabaCloud.ECS.GuestOS sont interrogées. Si Provider=AlibabaCloud.ECS.GuestOSDiagnose, les commandes publiques fournies par AlibabaCloud.ECS.GuestOSDiagnose sont interrogées.	AlibabaCloud
CommandId	string	Non	L'identifiant de la commande.	c-hz01272yr52****
Name	string	Non	Le nom de la commande. Lorsque le paramètre Provider est spécifié pour interroger les commandes publiques, la correspondance approximative est prise en charge par défaut. Lorsque le paramètre Provider n'est pas spécifié pour interroger les commandes privées, la correspondance approximative est prise en charge. Par exemple, saisissez command* pour rechercher toutes les commandes dont le nom commence par command, saisissez command pour rechercher toutes les commandes dont le nom se termine par command, ou saisissez command* pour rechercher toutes les commandes dont le nom contient command.	testName
Description	string	Non	La description de la commande. Lorsque le paramètre Provider est spécifié pour interroger les commandes publiques, la correspondance approximative est prise en charge par défaut. Lorsque le paramètre Provider n'est pas spécifié pour interroger les commandes privées, la correspondance approximative est prise en charge. Par exemple, saisissez test* pour rechercher toutes les commandes dont la description commence par test, saisissez test pour rechercher toutes les commandes dont la description se termine par test, ou saisissez test* pour rechercher toutes les commandes dont la description contient test.	testDescription
Type	string	Non	Le type de la commande. Valeurs valides : RunBatScript : script Bat qui s'exécute sur les instances Windows. RunPowerShellScript : script PowerShell qui s'exécute sur les instances Windows. RunShellScript : script Shell qui s'exécute sur les instances Linux.	RunShellScript
ContentEncoding	string	Non	Le mode d'encodage des champs CommandContent et Output dans la réponse. Valeurs valides : PlainText : renvoie le contenu et la sortie du script d'origine. Base64 : renvoie le contenu et la sortie du script encodés en Base64. Valeur par défaut : Base64.	PlainText
PageNumber	integer	Non	Remarque Ce paramètre est sur le point d'être mis hors service. Utilisez NextToken et MaxResults pour effectuer des opérations de requête paginée. Pour la pagination, utilisez NextToken et MaxResults à la place.	1
PageSize	integer	Non	Remarque Ce paramètre est sur le point d'être mis hors service. Utilisez NextToken et MaxResults pour effectuer des opérations de requête paginée. Pour la pagination, utilisez NextToken et MaxResults à la place.	10
MaxResults	integer	Non	Le nombre maximal d'entrées par page pour une requête paginée. Valeur maximale : 50. Valeur par défaut : 10.	10
NextToken	string	Non	Le jeton de pagination. Définissez ce paramètre sur la valeur NextToken renvoyée dans l'appel d'API précédent.	AAAAAdDWBF2
Latest	boolean	Non	Indique si seule la dernière version des commandes publiques doit être interrogée lorsque les résultats de la requête incluent des commandes publiques. Ce paramètre n'affecte pas l'interrogation des commandes privées. true : interroge uniquement la dernière version des commandes publiques. false : interroge toutes les versions des commandes publiques. Valeur par défaut : false.	true
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel la commande appartient.	rg-123******
Tag	array<object>	Non	Les balises.
	object	Non	L'objet balise.
Value	string	Non	La valeur de la balise de la commande. Valeurs valides de N : 1 à 20. La valeur de la balise peut être une chaîne vide. La valeur de la balise peut comporter jusqu'à 128 caractères et ne peut pas contenir http:// ou https://.	TestValue
Key	string	Non	La clé de la balise de la commande. Valeurs valides de N : 1 à 20. La clé de la balise ne peut pas être une chaîne vide. Si vous utilisez une seule balise pour filtrer les ressources, le nombre de ressources avec cette balise ne peut pas dépasser 1 000. Si vous utilisez plusieurs balises pour filtrer les ressources, le nombre de ressources avec toutes les balises spécifiées attachées ne peut pas dépasser 1 000. Si le nombre de ressources dépasse 1 000, utilisez l'opération ListTagResources pour interroger les ressources. La clé de la balise peut comporter jusqu'à 64 caractères et ne peut pas commencer par aliyun ou acs:, ni contenir http:// ou https://.	TestKey

Éléments de réponse

Élément	Type	Description	Exemple
	object
PageSize	integer	Le nombre d'entrées par page.	10
RequestId	string	L'identifiant de la requête.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
PageNumber	integer	Le numéro de page de la liste des commandes.	1
TotalCount	integer	Le nombre total de commandes.	5
NextToken	string	Le jeton de pagination renvoyé dans cet appel.	AAAAAdDWBF2
Commands	object
Command	array<object>	Le jeu de données des commandes.
	array<object>	L'objet commande.
ParameterDefinitions	object
ParameterDefinition	array<object>	La liste des détails des paramètres personnalisés.
	array<object>	L'objet paramètre personnalisé.
DefaultValue	string	La valeur par défaut du paramètre personnalisé.	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm
Description	string	La description du paramètre personnalisé.	Chemin du package d'installation de l'agent Cloud Assistant
Required	boolean	Indique si le paramètre personnalisé est requis. true : requis. false : non requis. Valeur par défaut : false.	true
ParameterName	string	Le nom du paramètre personnalisé.	DownloadUrl
PossibleValues	object
PossibleValue	array	La liste des valeurs possibles pour le paramètre personnalisé de type énumération.
	string	La valeur possible pour le paramètre personnalisé de type énumération.	"Linux","Windows"
PatternRegex	string	La règle d'expression régulière pour le paramètre personnalisé.	^[a-zA-Z0-9_-]{4,32}$
Description	string	La description de la commande.	testDescription
Category	string	La catégorie de la commande publique.	“”
ResourceGroupId	string	L'identifiant du groupe de ressources auquel la commande appartient.	rg-123******
ParameterNames	object
ParameterName	array	La liste des noms de paramètres personnalisés analysés à partir de CommandContent lors de la création de la commande, renvoyée sous forme de liste. Si la fonctionnalité de paramètre personnalisé n'est pas utilisée, une liste vide est renvoyée.
	string	Le nom du paramètre personnalisé.	['parameter1','parameter2']
Timeout	integer	Le délai d'expiration. Unité : secondes.	3600
Provider	string	Le fournisseur de la commande publique.	AlibabaCloud.ECS.GuestOS
Name	string	Le nom de la commande.	testName
WorkingDir	string	Le chemin d'exécution.	/home/
CommandContent	string	Le contenu de la commande, transmis en encodage Base64. Si ContentEncoding est défini sur PlainText, le contenu du script d'origine est renvoyé. Si ContentEncoding est défini sur Base64, le contenu du script encodé en Base64 est renvoyé.	Y2QgL3Jvb3Q=
Type	string	Le type de la commande.	RunShellScript
Version	integer	La version de la commande publique. Si plusieurs commandes appartiennent au même fournisseur et ont le même nom et la même catégorie, ces commandes sont différentes versions de la même commande. Cette valeur n'est pas renvoyée pour les commandes Cloud Assistant que vous avez créées manuellement.	1
InvokeTimes	integer	Le nombre de tâches créées à l'aide de cette commande.	2
CreationTime	string	L'heure de création de la commande.	2020-11-17T06:52Z
Launcher	string	Le lanceur pour l'exécution du script. Le lanceur ne peut pas dépasser 1 Ko de longueur.	python3 -u {{ACS::ScriptFileName\|Ext(".py")}}
Latest	boolean	Indique si la commande publique est la dernière version. Si plusieurs commandes appartiennent au même fournisseur et ont le même nom et la même catégorie, ces commandes sont différentes versions de la même commande. Cette valeur n'est pas renvoyée pour les commandes Cloud Assistant que vous avez créées manuellement.	true
EnableParameter	boolean	Indique si la fonctionnalité de paramètre personnalisé est activée pour la commande.	true
CommandId	string	L'identifiant de la commande.	c-hz01272yr52****
Tags	object
Tag	array<object>	La liste des balises de la commande.
	object	L'objet d'informations de balise de la commande.
TagKey	string	La clé de la balise de la commande.	owner
TagValue	string	La valeur de la balise de la commande.	zhangsan

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber": 1,
  "TotalCount": 5,
  "NextToken": "AAAAAdDWBF2",
  "Commands": {
    "Command": [
      {
        "ParameterDefinitions": {
          "ParameterDefinition": [
            {
              "DefaultValue": "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
              "Description": "Chemin du package d'installation de l'agent Cloud Assistant",
              "Required": true,
              "ParameterName": "DownloadUrl",
              "PossibleValues": {
                "PossibleValue": [
                  "\"Linux\",\"Windows\""
                ]
              },
              "PatternRegex": "^[a-zA-Z0-9_-]{4,32}$\u0000"
            }
          ]
        },
        "Description": "testDescription",
        "Category": "“”",
        "ResourceGroupId": "rg-123******",
        "ParameterNames": {
          "ParameterName": [
            "['parameter1','parameter2']"
          ]
        },
        "Timeout": 3600,
        "Provider": "AlibabaCloud.ECS.GuestOS",
        "Name": "testName",
        "WorkingDir": "/home/",
        "CommandContent": "Y2QgL3Jvb3Q=",
        "Type": "RunShellScript",
        "Version": 1,
        "InvokeTimes": 2,
        "CreationTime": "2020-11-17T06:52Z",
        "Launcher": "python3 -u {{ACS::ScriptFileName|Ext(\".py\")}}",
        "Latest": true,
        "EnableParameter": true,
        "CommandId": "c-hz01272yr52****",
        "Tags": {
          "Tag": [
            {
              "TagKey": "owner",
              "TagValue": "zhangsan"
            }
          ]
        }
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	L'appel d'API n'est pas pris en charge dans la région spécifiée. Vérifiez que la valeur du paramètre RegionId est correcte.
400	NumberExceed.Tags	The Tags parameter number is exceed.	Le nombre de balises dépasse la limite maximale. Vous pouvez traiter un maximum de 20 balises par opération.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	Des clés en double existent dans les balises. Assurez-vous que toutes les clés sont uniques.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Le paramètre de clé de balise spécifié n'est pas valide.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Le paramètre de valeur de balise spécifié n'est pas valide.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Spécifiez une clé de balise.
400	InvalidParam.PageNumber	The specified parameter is invalid.
400	InvalidParam.PageSize	The specified parameter is invalid.
400	InvalidParameter.NextToken	The specified parameter NextToken is not valid.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	Le paramètre MaxResults spécifié n'est pas valide.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	Une erreur s'est produite lors de l'envoi de la requête. Réessayez plus tard.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.
500	InternalError	The request processing has failed due to some unknown error.
403	Operation.Forbidden	The operation is not permitted.	L'opération n'est pas autorisée.
403	InvalidName.LengthLimitExceeded	The length of the parameter Name exceeds the upper limit.
403	InvalidDescription.LengthLimitExceeded	The length of the parameter Description exceeds the upper limit.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Le paramètre RegionId spécifié n'existe pas. Vérifiez si le produit est disponible dans cette région.
404	InvalidCommandType.NotFound	The specified parameter Type does not exist.
404	InvalidCommandId.NotFound	The specified commandId does not exist

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

Notes de version

Consultez Notes de version pour la liste complète.