DescribeSendFileResults - Elastic Compute Service - Centre de documentation Alibaba Cloud

Consulte la liste et l'état des fichiers envoyés par Cloud Assistant.

Description de l'opération

Description de l'opération :

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

get

Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionId	string	Oui	L'identifiant de la région de l'instance ECS. Vous pouvez appeler DescribeRegions pour consulter la liste des régions la plus récente.	cn-hangzhou
ResourceGroupId	string	Non	L'identifiant du groupe de ressources auquel appartient la tâche d'envoi de fichier. Après avoir spécifié ce paramètre, vous devez également spécifier ResourceGroupId lors de l'envoi d'un fichier. Ce paramètre vous permet de filtrer les résultats d'envoi de fichiers par groupe de ressources.	rg-bp67acfmxazb4p****
InvokeId	string	Non	L'identifiant d'exécution.	f-hz0jdfwd9f****
Name	string	Non	Le nom du fichier. Si vous spécifiez ce paramètre, tous les enregistrements d'envoi du fichier portant le nom spécifié sont interrogés.	test.txt
InstanceId	string	Non	L'identifiant de l'instance. Si vous spécifiez ce paramètre, tous les enregistrements d'envoi de fichiers de l'instance spécifiée sont interrogés.	i-hz0jdfwd9f****
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.	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.	10
MaxResults	integer	Non	Le nombre maximal d'entrées par page dans une requête paginée.	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
InvocationStatus	string	Non	L'état d'envoi global du fichier. L'état global dépend de l'état d'exécution combiné de toutes les instances cibles. Valeurs valides :	Success
Tag	array<object>	Non	Les balises.
	object	Non	Les balises.
Key	string	Non	La clé de balise pour la tâche d'envoi de fichier. Valeurs valides de N : 1 à 20. La clé de balise ne peut pas être une chaîne vide.	TestKey
Value	string	Non	La valeur de balise pour la tâche d'envoi de fichier. Valeurs valides de N : 1 à 20. La valeur de balise peut être une chaîne vide.	TestValue

É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-A3DC0DE3C83E
PageNumber	integer	Le numéro de page du résultat de la requête.	1
TotalCount	integer	Le nombre total de scripts.	2
NextToken	string	Le jeton de pagination renvoyé dans cet appel.	AAAAAdDWBF2
Invocations	object
Invocation	array<object>	Les enregistrements d'envoi de fichiers.
	array<object>
CreationTime	string	The time when the file sending task was created.	2019-12-20T06:15:54Z
InvocationStatus	string	The overall sending status of the file. The overall status depends on the combined execution status of all instances in the sending task. Valid values: Pending: The system is validating or sending the file. The overall status is Pending if the file sending status of at least one instance is Pending. Running: The file is being sent on instances. The overall status is Running if the file sending status of at least one instance is Running. Success: The overall status is Success if the file sending status of all instances is Success. Failed: The overall status is Failed if the file sending status of all instances is Failed. The status is Failed if one or more of the following statuses apply to instances: The specified file parameters are invalid and validation failed (Invalid). The file failed to be sent to the instance (Aborted). The file failed to be created on the instance (Failed). The file sending timed out (Timeout). An exception occurred during file sending and the process cannot continue (Error). PartialFailed: The file is sent on some instances but failed on others. The overall status is PartialFailed if the file sending status of all instances is Success or Failed.	Success
ContentType	string	The content type of the file. Valid values: PlainText: plain text. Base64: Base64 encoding.	PlainText
TargetDir	string	The destination path.	/home/user
FileOwner	string	The owner of the file.	test
Description	string	The description.	This is a test file.
VmCount	integer	The number of instances to which the file was sent.	1
FileMode	string	The permissions on the file.	777
FileGroup	string	The user group of the file.	test
InvokeId	string	The execution ID.	f-hz0jdfwd9f****
Name	string	The file name.	test.txt
Content	string	The file content.	#!/bin/bash echo "Current User is :" echo $(ps \| grep "$$" \| awk '{print $2}')
Overwrite	string	Indicates whether overwriting is allowed.	false
InvokeInstances	object
InvokeInstance	array<object>	The target instances for file sending.
	object
CreationTime	string	The time when the file sending task was created.	2019-12-20T06:15:54Z
StartTime	string	The time when the sending task started to run on the instance.	2019-12-20T06:15:54Z
InvocationStatus	string	The sending status of the file on a single instance. Valid values: Pending: The system is validating or sending the file. Invalid: The specified file parameters are invalid and validation failed. Running: The file is being sent on the instance. Aborted: The file failed to be sent to the instance. Success: The file was sent. Failed: The file failed to be created on the instance. Error: An exception occurred during file sending and the process cannot continue. Timeout: The file sending timed out.	Success
FinishTime	string	The time when the sending task ended.	2019-12-20T06:15:54Z
UpdateTime	string	The time when the task status was updated.	2019-12-20T06:15:54Z
ErrorInfo	string	The details of the failure or execution failure reason for file sending. Valid values: Empty: The file was sent normally. the specified instance does not exists: The specified instance does not exist or has been released. the specified instance has been released.: The instance was released during file sending. the instance is not running when create task: The instance was not in the Running state when the file sending task was created. the specified account does not exists: The specified account does not exist. the aliyun service is not running on the instance: Cloud Assistant Agent is not running. the aliyun service in the instance does not response: Cloud Assistant Agent is not responding. the aliyun service in the instance is upgrading now: Cloud Assistant Agent is being upgraded. the aliyun service in the instance need upgrade: Cloud Assistant Agent needs to be upgraded. the command delivery has been timeout: The file sending timed out. the file creation is failed due to unknown error: The file failed to be created. the authority of file is invalid: The file permissions are invalid. File content is empty: The file content is empty. the content of file is invalid: The file content is invalid. File already exists: A file with the same name already exists in the same path. File name is invalid: The file name is invalid. File path is invalid: The file path is invalid. Owner not exists: The user does not exist. Group not exists: The user group does not exist. Mode is invalid: The file permission settings are invalid.	the instance is not running when create task
ErrorCode	string	The error code for file sending failure. Valid values: Empty: The file was sent normally. InstanceNotExists: The specified instance does not exist or has been released. InstanceReleased: The instance was released during file sending. InstanceNotRunning: The instance was not in the Running state when the file sending task was created. AccountNotExists: The specified account does not exist. ClientNotRunning: Cloud Assistant Agent is not running. ClientNotResponse: Cloud Assistant Agent is not responding. ClientIsUpgrading: Cloud Assistant Agent is being upgraded. ClientNeedUpgrade: Cloud Assistant Agent needs to be upgraded. DeliveryTimeout: The file sending timed out. FileCreateFail: The file failed to be created. FileAlreadyExists: A file with the same name already exists in the same path. FileContentInvalid: The file content is invalid. FileNameInvalid: The file name is invalid. FilePathInvalid: The file path is invalid. FileAuthorityInvalid: The file permissions are invalid. UserGroupNotExists: The user group specified during file sending does not exist.	InstanceNotExists
InstanceId	string	The instance ID.	i-uf614fhehhz****
Tags	object
Tag	array<object>	The tag information of the file sending task.
	object	The tag information of the file sending task.
TagKey	string	The tag key of the file sending task.	owner
TagValue	string	The tag value of the file sending task.	zhangsan

Exemples

JSON format

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "NextToken": "AAAAAdDWBF2",
  "Invocations": {
    "Invocation": [
      {
        "CreationTime": "2019-12-20T06:15:54Z",
        "InvocationStatus": "Success",
        "ContentType": "PlainText",
        "TargetDir": "/home/user",
        "FileOwner": "test",
        "Description": "This is a test file.",
        "VmCount": 1,
        "FileMode": "777",
        "FileGroup": "test",
        "InvokeId": "f-hz0jdfwd9f****",
        "Name": "test.txt",
        "Content": "#!/bin/bash  echo \"Current User is :\"  echo $(ps | grep \"$$\" | awk '{print $2}')",
        "Overwrite": "false",
        "InvokeInstances": {
          "InvokeInstance": [
            {
              "CreationTime": "2019-12-20T06:15:54Z",
              "StartTime": "2019-12-20T06:15:54Z",
              "InvocationStatus": "Success",
              "FinishTime": "2019-12-20T06:15:54Z",
              "UpdateTime": "2019-12-20T06:15:54Z",
              "ErrorInfo": "the instance is not running when create task",
              "ErrorCode": "InstanceNotExists",
              "InstanceId": "i-uf614fhehhz****"
            }
          ]
        },
        "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.	The API operation cannot be called in the specified region. Check whether the specified RegionId parameter is valid.
400	NumberExceed.Tags	The Tags parameter number is exceed.	The number of tags exceeds the maximum limit.
400	MissingParameter.TagKey	You must specify Tag.N.Key.	The tag key is not specified.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
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.	The specified parameter NextToken is illegal.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	The specified parameter MaxResults is illegal.
500	InternalError.Dispatch	An error occurred when you dispatched the request.	An error occurred while the request is being sent. Try again later.
403	Operation.Forbidden	The operation is not permitted.	The operation is not supported.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error

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

Notes de version

Consultez Notes de version pour la liste complète.