BatchExport - - Centre de documentation Alibaba Cloud

Appelle l'opération BatchExport pour exporter les données de surveillance définies dans l'opération Cursor.

Description de l'opération

Prérequis

Assurez-vous d'avoir appelé l'opération Cursor pour obtenir le Cursor initial.

Remarques sur l'utilisation

Cette rubrique fournit un exemple montrant comment exporter les données de surveillance d'un Cursor initial de la métrique cpu_idle du service cloud acs_ecs_dashboard. Un maximum de 1 000 entrées de données sont renvoyées par appel.

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.

cms:BatchExport

list

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
Namespace	string	Oui	L'espace de noms des données du service cloud. Pour plus d'informations sur la façon d'obtenir l'espace de noms des données d'un service cloud, consultez Annexe 1 : Métriques. Remarque Ce paramètre doit être identique au paramètre de requête `Namespace` dans l'opération Cursor.	acs_ecs_dashboard
Metric	string	Oui	Le nom de la métrique du service cloud. Pour plus d'informations sur la façon d'obtenir le nom d'une métrique d'un service cloud, consultez Annexe 1 : Métriques. Remarque Ce paramètre doit être identique au paramètre de requête `Metric` dans l'opération Cursor.	cpu_idle
Cursor	string	Oui	Lorsque vous appelez cette opération dans une boucle pour exporter des données, vous devez spécifier la valeur de `Cursor`. Vous pouvez obtenir la valeur de `Cursor` en utilisant les méthodes suivantes : Lorsque vous appelez cette opération pour la première fois, vous devez d'abord appeler l'opération Cursor pour obtenir la valeur de `Cursor`. Pour plus d'informations, consultez Cursor. Lorsque vous appelez à nouveau cette opération, vous pouvez obtenir la valeur de `Cursor` à partir de la réponse du dernier appel.	eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0MzIwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQ3NTY2MzYzMjY3NmI2ZjM5MzU2YjY4MzAzMTYyNzg3MTcwNjkzMTM3MjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTQ3OTU4MjMsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDE5NTgyMywic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2****
Length	integer	Oui	Le nombre maximal d'entrées de données à renvoyer à chaque fois. Valeurs valides : 1 à 10000.	1000
Measurements	array	Non	Les mesures utilisées pour personnaliser les données renvoyées. Par défaut, toutes les mesures sont renvoyées. Par exemple, la métrique `cpu_idle` du service cloud `acs_ecs_dashboard` comporte trois colonnes de mesure : `Average`, `Maximum` et `Minimum`. Si vous avez uniquement besoin de renvoyer les colonnes `Average` et `Maximum`, définissez ce paramètre sur le tableau `["Average", "Maximum"]`. Pour plus d'informations sur la façon d'obtenir les mesures d'une métrique d'un service cloud, consultez la colonne `statistics` de l'Annexe 1 : Métriques.
	string	Non	Le nom de la colonne de la mesure.	Maximum

Pour plus d'informations sur les paramètres de requête courants, consultez Paramètres courants.

Éléments de réponse

Élément	Type	Description	Exemple
	object	Aucun.
Message	string	Le message renvoyé.	success
Code	integer	Le code d'état. Remarque La valeur 200 indique un succès.	200
Success	boolean	Indique si l'opération a réussi. Valeurs valides : true : réussite false : échec	true
RequestId	string	L'identifiant de la requête.	251402CD-305C-1617-808E-D8C11FC8138D
Cursor	string	Le curseur utilisé pour appeler à nouveau cette opération. Remarque Si le résultat renvoyé est `null`, les données de surveillance ont été exportées.	v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***
Length	integer	Le nombre d'entrées de données renvoyées pour cet appel.	1000
Anchor	integer	L'horodatage auquel le backend a demandé les données. Un horodatage plus grand indique que les données exportées sont plus proches de l'heure actuelle.	1678781819000
HasNext	boolean	Indique si les données ont été exportées. Valeurs valides : true : certaines données n'ont pas été exportées. false : toutes les données ont été exportées.	true
DataResults	array	Les données renvoyées par cet appel.
	MetricStat	Les données exportées. Les détails sont les suivants : Namespace : l'espace de noms des données du service cloud. Exemple : `acs_ecs_dashboard`. Metric : le nom de la métrique du service cloud. Exemple : `cpu_idle`. Timestamp : l'horodatage des données de surveillance. Unité : millisecondes. Exemple : 1641454680000. Period : la période statistique des données de surveillance. Unité : secondes. Exemple : 60. Dimensions : les informations de dimension utilisées pour identifier l'objet surveillé (instance). Exemple : `[{"Label":"userId", "Value":""20654616023382**"}, {"Label":"InstanceId", "Value":""i-2ze2d6j5uhg20x4"}]`. Associated : les informations supplémentaires sur l'objet surveillé (instance), telles que les informations de balise. La valeur est une collection de paires clé:valeur. Exemple : `{"group":"test**", "name":"Alice"}`. Measurements : les mesures de la métrique (mode multi-valeurs par défaut). Exemple : `{"Average":60,"Maximum":85}`. LogTime : l'heure d'enregistrement des données de surveillance. Unité : millisecondes. Pour les données non brutes (données agrégées), `LogTime` est vide (NULL).

Exemples

JSON format

{
  "Message": "success",
  "Code": 200,
  "Success": true,
  "RequestId": "251402CD-305C-1617-808E-D8C11FC8138D",
  "Cursor": "v2.5eyJidWNrZXRzIjo0LCJjdXJzb3IiOiIxNjQxNDU0ODAwMDAwMWUxY2YxNWY0NTU0MTliZjllYTY4OWQ2ODI1OTU1Yzc1NmZjMDQ2OTMxMzczMzM2MzUzMTMxMzEzMzM0MzMzODM5MzEzMTMwMjQyYzY5MmQzMjdhNjU2MjY3N2E2NjZhNzczOTY2NmM3Mjc0NjM3MzY5Njg3NDcyMjQyYyIsImN1cnNvclZlcnNpb24iOiJxdWVyeSIsImVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydEVuZFRpbWUiOjE2NDE0NTUyMzYxMTIsImV4cG9ydFN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwiZXhwcmVzc1JhbmdlIjpmYWxzZSwiaGFzTmV4dCI6dHJ1ZSwiaW5wdXRNZXRyaWMiOiJDUFVVdGlsaXphdGlvbiIsImlucHV0TmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJsaW1pdCI6MTAwMCwibG9nVGltZU1vZGUiOnRydWUsIm1hdGNoZXJzIjp7ImNoYWluIjpbeyJsYWJlbCI6InVzZXJJZCIsIm9wZXJhdG9yIjoiRVFVQUxTIiwidmFsdWUiOiIxNzM2NTExMTM0Mzg5MTEwIn1dfSwibWV0cmljIjoiQ1BVVXRpbGl6YXRpb24iLCJtZXRyaWNUeXBlIjoiTUVUUklDIiwibmFtZXNwYWNlIjoiYWNzX2Vjc19kYXNoYm9hcmQiLCJuZXh0UGtBZGFwdGVyIjp7fSwib2Zmc2V0IjowLCJwYXJlbnRVaWQiOjEyNzA2NzY2Nzk1NDY3MDQsInN0YXJ0VGltZSI6MTY0MTQ1NDYzNjExMiwic3RlcCI6LTEsInRpbWVvdXQiOjEyMCwid2luZG93Ijo2MH0***",
  "Length": 1000,
  "Anchor": 1678781819000,
  "HasNext": true,
  "DataResults": [
    {
      "Namespace": "acs_ecs_dashboard",
      "Metric": "cpu_idle",
      "Period": 60,
      "Timestamp": 1641454680000,
      "Dimensions": [
        {
          "Label": "instanceId",
          "Value": "i-dferwret*****"
        }
      ],
      "Associated": {
        "key": "{\"group\":\"test****\", \"name\":\"Alice\"}"
      },
      "Measurements": {
        "key": "{\"Average\":60,\"Maximum\":85}"
      },
      "LogTime": 1683686550073
    }
  ]
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur
400	%s	%s
500	InternalError	The request processing has failed due to some unknown error.
500	%s	%s
403	%s	%s
404	%s	%s
503	%s	%s

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

Notes de version

Consultez Notes de version pour la liste complète.