ListBatches - - Centre de documentation Alibaba Cloud

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.

imm:ListBatches

list

*Batch

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}/batch/*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ProjectName	string	Oui	Le nom du projet.	test-project
State	string	Non	L'état de la tâche. Ready : la tâche vient d'être créée et est prête. Running : la tâche est en cours d'exécution. Failed : la tâche a échoué et ne peut pas être récupérée automatiquement. Suspended : la tâche est suspendue. Succeeded : la tâche a réussi.	Succeed
Sort	string	Non	Le champ de tri. Valeurs valides : CreateTime UpdateTime	2020-11-11T06:51:17.5Z
Order	string	Non	L'ordre de tri. Valeurs valides : ASC : trie les résultats par ordre croissant. Il s'agit de l'ordre de tri par défaut. DES : trie les résultats par ordre décroissant.	ASC
TagSelector	string	Non	La balise personnalisée. Vous pouvez utiliser ce paramètre pour interroger les tâches qui possèdent la balise spécifiée.	test=val1
NextToken	string	Non	Le jeton de pagination. Le jeton de pagination est utilisé dans la requête suivante pour récupérer une nouvelle page de résultats si le nombre total de résultats dépasse la valeur du paramètre MaxResults. L'appel suivant à l'opération renvoie les résultats situés lexicographiquement après la valeur du paramètre NextToken. Vous n'avez pas besoin de spécifier ce paramètre dans votre requête initiale.	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpwZw==
MaxResults	integer	Non	Le nombre maximal de résultats à renvoyer. Valeurs valides : 0 à 100. Si vous ne spécifiez pas ce paramètre ou si vous le définissez sur 0, la valeur par défaut de 100 est utilisée.	10

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
Batches	array	Les tâches de traitement par lots.
	DataIngestion	Les informations sur la tâche de traitement par lots.
NextToken	string	Le jeton de pagination. Le jeton de pagination est utilisé dans la requête suivante pour récupérer une nouvelle page de résultats si le nombre total de résultats dépasse la valeur du paramètre MaxResults. L'appel suivant à l'opération renvoie les résultats situés lexicographiquement après la valeur du paramètre NextToken.	MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****
RequestId	string	L'identifiant de la requête.	FEDC9B1F-30F2-4C1F-8ED2-B7860187****

Exemples

JSON format

{
  "Batches": [
    {
      "Id": "trigger-9f72636a-0f0c-4baf-ae78-38b27bfe****",
      "Input": {
        "OSS": {
          "Bucket": "test-bucket",
          "Prefix": "test-object",
          "MatchExpressions": [
            "key prefix (abc)"
          ]
        }
      },
      "Actions": [
        {
          "Name": "doc/convert",
          "Parameters": [
            "pages=3"
          ],
          "FastFailPolicy": {
            "Action": "abort"
          }
        }
      ],
      "Notification": {
        "Endpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com",
        "Topic": "topic1",
        "MNS": {
          "TopicName": "topic1",
          "Endpoint": "http://1111111111.mns.cn-hangzhou.aliyuncs.com"
        },
        "RocketMQ": {
          "Endpoint": "http://11111111111.mqrest.cn-hangzhou.aliyuncs.com",
          "TopicName": "topic1",
          "InstanceId": "MQ_INST_11111111111_BYcNy2Nc"
        }
      },
      "Statistic": {
        "SubmitSuccess": 10,
        "SubmitFailure": 1,
        "SkipFiles": 0
      },
      "State": "Succeeded",
      "Marker": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****",
      "CreateTime": "2020-11-10T03:50:28Z",
      "UpdateTime": "2021-12-18T07:40:29Z",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "Error": "api returns error: SDKError: StatusCode: 404 Code: ResourceNotFound",
      "Phase": "IncrementalScanning",
      "ServiceRole": "AliyunIMMBatchTriggerRole"
    }
  ],
  "NextToken": "MTIzNDU2Nzg6aW1tdGVzdDpleGFtcGxlYnVja2V0OmRhdGFzZXQwMDE6b3NzOi8vZXhhbXBsZWJ1Y2tldC9zYW1wbGVvYmplY3QxLmpw****",
  "RequestId": "FEDC9B1F-30F2-4C1F-8ED2-B7860187****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.