DescribeCommands - - Centre de documentation Alibaba Cloud

Notes d'utilisation

Si vous spécifiez uniquement les paramètres Action et RegionId, le système interroge par défaut toutes les commandes disponibles (CommandId) que vous avez créées dans la région spécifiée.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, 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

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeCommands	L'opération à effectuer. Définissez la valeur sur DescribeCommands.
RegionId	String	Yes	cn-hangzhou	L'ID de région de la commande. Appelez l'opération DescribeRegions pour obtenir la liste des régions la plus récente.
Provider	String	No	AlibabaCloud	Le fournisseur de la commande courante. Tenez compte des éléments suivants : Si vous ne spécifiez pas ce paramètre, le système interroge toutes les commandes que vous avez créées. Si vous définissez ce paramètre sur `AlibabaCloud`, le système interroge toutes les commandes courantes fournies par Alibaba Cloud. Si vous définissez ce paramètre sur un fournisseur spécifique, le système interroge toutes les commandes courantes fournies par ce fournisseur. Exemples : Si vous définissez `Provider` sur AlibabaCloud.ECS.GuestOS, le système interroge toutes les commandes courantes fournies par `AlibabaCloud.ECS.GuestOS`. Si vous définissez `Provider` sur AlibabaCloud.ECS.GuestOSDiagnose, le système interroge toutes les commandes courantes fournies par `AlibabaCloud.ECS.GuestOSDiagnose`.
CommandId	String	No	c-hz01272yr52****	L'ID de la commande.
Name	String	No	testName	Le nom de la commande. Si vous spécifiez `Provider`, la recherche floue est activée par défaut.
Description	String	No	testDescription	La description de la commande courante. Ce paramètre prend effet et la recherche floue est activée par défaut uniquement lorsque `Provider` est spécifié.
Type	String	No	RunShellScript	Le type de la commande. Valeurs valides : RunBatScript : commande batch, applicable aux instances Windows RunPowerShellScript : commande PowerShell, applicable aux instances Windows RunShellScript : commande shell, applicable aux instances Linux
ContentEncoding	String	No	PlainText	Le mode d'encodage des valeurs `CommandContent` et `Output` dans la réponse. Valeurs valides : PlainText : renvoie le contenu original de la commande et la sortie de la commande. Base64 : renvoie le contenu de la commande et la sortie de la commande encodés en Base64. Valeur par défaut : Base64.
PageNumber	Long	No	1	Le numéro de page. La numérotation des pages commence à 1. Valeur par défaut : 1.
PageSize	Long	No	10	Le nombre d'entrées par page. Valeurs valides : 1 à 50. Valeur par défaut : 10.
Latest	Boolean	No	true	Indique s'il faut interroger uniquement la dernière version des commandes courantes. Ce paramètre n'affecte pas l'interrogation des commandes privées. true : interroge uniquement la dernière version des commandes courantes. false : interroge toutes les versions des commandes courantes. Valeur par défaut : false.
ResourceGroupId	String	No	rg-123******	L'ID du groupe de ressources auquel appartient la commande.
Tag.N.Key	String	No	TestKey	La clé du tag N de la commande. Valeurs valides de N : 1 à 20. La clé du tag ne peut pas être une chaîne vide. Si un seul tag est spécifié pour interroger les ressources, jusqu'à 1 000 ressources portant ce tag peuvent apparaître dans la réponse. Si plusieurs tags sont spécifiés, jusqu'à 1 000 ressources portant tous ces tags peuvent apparaître. Pour interroger plus de 1 000 ressources portant des tags spécifiques, appelez l'opération ListTagResources. La clé du tag peut comporter jusqu'à 64 caractères et ne peut pas commencer par `acs:` ou `aliyun`. Elle ne peut pas contenir `http://` ou `https://`.
Tag.N.Value	String	No	TestValue	La valeur du tag N de la commande. Valeurs valides de N : 1 à 20. La valeur du tag peut être une chaîne vide. Elle peut comporter jusqu'à 128 caractères et ne peut pas contenir `http://` ou `https://`.

Paramètres de réponse

Parameter	Type	Example	Description
PageSize	Long	10	Le nombre d'entrées par page.
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****	L'ID de la requête.
PageNumber	Long	1	Le numéro de page.
TotalCount	Long	5	Le nombre total de commandes.
Commands	Array of Command		Les commandes interrogées.
Command
CreationTime	String	2020-11-17T06:52Z	L'heure de création de la commande.
Type	String	RunShellScript	Le type de la commande.
Timeout	Long	3600	Le délai d'expiration. Unité : secondes.
InvokeTimes	Integer	2	Le nombre de tâches créées à l'aide de la commande.
CommandId	String	c-hz01272yr52****	L'ID de la commande.
WorkingDir	String	/home/	Le chemin d'exécution de la commande.
Description	String	testDescription	La description de la commande.
Version	Integer	1	La version de la commande courante. Si plusieurs commandes courantes du même fournisseur (`Provider`) appartiennent à la même catégorie et ont le même nom, elles constituent différentes versions de la même commande. Ce paramètre n'est pas renvoyé pour les commandes Cloud Assistant que vous avez créées.
Provider	String	AlibabaCloud.ECS.GuestOS	Le fournisseur de la commande courante.
CommandContent	String	Y2QgL3Jvb3Q=	Le contenu de la commande encodé en Base64. Si vous définissez ContentEncoding sur PlainText, le contenu original de la commande est renvoyé. Si vous définissez ContentEncoding sur Base64, le contenu de la commande encodé en Base64 est renvoyé.
Category	String	""	La catégorie de la commande courante.
Latest	Boolean	true	Indique si la commande courante est la dernière version. Si plusieurs commandes courantes du même fournisseur (`Provider`) appartiennent à la même catégorie et ont le même nom, elles constituent différentes versions de la même commande. Ce paramètre n'est pas renvoyé pour les commandes Cloud Assistant que vous avez créées.
Name	String	testName	Le nom de la commande.
EnableParameter	Boolean	true	Indique si la fonctionnalité de paramètre personnalisé est activée pour la commande.
ResourceGroupId	String	rg-123******	L'ID du groupe de ressources auquel appartient la commande.
ParameterNames	Array of String	['parameter1','parameter2']	La liste des noms de paramètres personnalisés extraits du contenu de la commande spécifié lors de sa création. Si la fonctionnalité de paramètre personnalisé est désactivée, une liste vide est renvoyée.
ParameterDefinitions	Array of ParameterDefinition		Les paramètres personnalisés.
ParameterDefinition
Required	Boolean	true	Indique si le paramètre personnalisé est obligatoire. true false Valeur par défaut : false.
Description	String	Download path of the Cloud Assistant Agent installation package	La description du paramètre personnalisé.
DefaultValue	String	https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm	La valeur par défaut du paramètre personnalisé.
ParameterName	String	DownloadUrl	Le nom du paramètre personnalisé.
PossibleValues	Array of String	"Linux","Windows"	Les valeurs valides du paramètre personnalisé de type énumération.
Tags	Array of Tag		Les tags de la commande.
Tag
TagKey	String	owner	La clé du tag de la commande.
TagValue	String	zhangsan	La valeur du tag de la commande.

Exemples

Exemples de requêtes

http(s)://ecs.aliyuncs.com/?Action=DescribeCommands
&RegionId=cn-hangzhou
&CommandId=c-hz01272yr52****
&PageNumber=1
&PageSize=10
&<Common request parameters>

Exemples de réponses réussies

XML format

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

<DescribeCommandsResponse>
    <PageSize>10</PageSize>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>5</TotalCount>
    <Commands>
        <CreationTime>2020-11-17T06:52Z</CreationTime>
        <Type>RunShellScript</Type>
        <Timeout>3600</Timeout>
        <InvokeTimes>2</InvokeTimes>
        <CommandId>c-hz01272yr52****</CommandId>
        <WorkingDir>/home/</WorkingDir>
        <Description>testDescription</Description>
        <Version>1</Version>
        <Provider>AlibabaCloud.ECS.GuestOS</Provider>
        <CommandContent>Y2QgL3Jvb3Q=</CommandContent>
        <Category>""</Category>
        <Latest>true</Latest>
        <Name>testName</Name>
        <EnableParameter>true</EnableParameter>
        <ParameterNames>['parameter1','parameter2']</ParameterNames>
        <ParameterDefinitions>
            <Required>true</Required>
            <Description>Download path of the Cloud Assistant Agent installation package</Description>
            <DefaultValue>https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm</DefaultValue>
            <ParameterName>DownloadUrl</ParameterName>
            <PossibleValues>"Linux","Windows"</PossibleValues>
        </ParameterDefinitions>
        <Tags>
            <TagKey>owner</TagKey>
            <TagValue>zhangsan</TagValue>
        </Tags>
    </Commands>
</DescribeCommandsResponse>

JSON format

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

{
  "PageSize" : 10,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "PageNumber" : 1,
  "TotalCount" : 5,
  "Commands" : [ {
    "CreationTime" : "2020-11-17T06:52Z",
    "Type" : "RunShellScript",
    "Timeout" : 3600,
    "InvokeTimes" : 2,
    "CommandId" : "c-hz01272yr52****",
    "WorkingDir" : "/home/",
    "Description" : "testDescription",
    "Version" : 1,
    "Provider" : "AlibabaCloud.ECS.GuestOS",
    "CommandContent" : "Y2QgL3Jvb3Q=",
    "Category" : """",
    "Latest" : true,
    "Name" : "testName",
    "EnableParameter" : true,
    "ParameterNames" : [ "['parameter1','parameter2']" ],
    "ParameterDefinitions" : [ {
      "Required" : true,
      "Description" : "Download path of the Cloud Assistant Agent installation package",
      "DefaultValue" : "https://aliyun-client-assist.oss-accelerate.aliyuncs.com/linux/aliyun_assist_latest.rpm",
      "ParameterName" : "DownloadUrl",
      "PossibleValues" : [ "\"Linux\",\"Windows\"" ]
    } ],
    "Tags" : [ {
      "TagKey" : "owner",
      "TagValue" : "zhangsan"
    } ]
  } ]
}

Codes d'erreur

HTTP status code	Error code	Error message	Description
400	RegionId.ApiNotSupported	The api is not supported in this region.	Cette opération n'est pas prise en charge dans la région spécifiée. Vérifiez la validité de la valeur du paramètre RegionId.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	La clé du tag existe déjà. Les clés de tag doivent être uniques.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	Valeur Tag.N.Key non valide.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	Valeur Tag.N.Value non valide.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	Le paramètre Tag.N.Key est requis.
400	InvalidParam.PageNumber	The specified parameter is invalid.	Valeur PageNumber non valide.
400	InvalidParam.PageSize	The specified parameter is invalid.	Valeur PageSize non valide.
403	Operation.Forbidden	The operation is not permitted.	L'opération n'est pas autorisée.
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 ultérieurement.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	La requête a échoué en raison d'une défaillance temporaire du serveur backend.
500	InternalError	The request processing has failed due to some unknown error.	Une erreur interne s'est produite. Réessayez ultérieurement.

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service.