CreateScheduledTask - - 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.

opensearch:CreateScheduledTask

create

*ScheduledTask

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

Aucune

Syntaxe de la requête

POST /v4/openapi/app-groups/{appGroupIdentity}/scheduled-tasks HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
appGroupIdentity	string	Oui	Le nom de l'application.	my_app_group_name

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
body	ScheduledTask	Non	Le corps de la requête.

Corps de la requête

Champ	Type	Obligatoire	Exemple	Description
type	String	Oui	"wipe"	Le type de la tâche planifiée. Valeurs valides : - wipe : nettoyage des données. - fork : importation de données avec reconstruction de l'index. - reindex : reconstruction de l'index. - clear : effacement des données.
cron	String	Oui	"10 20 * * 1,2,3,4,5"	L'expression cron pour la planification. Pour plus d'informations, consultez Règles de planification des tâches planifiées.
enabled	Boolean	Oui	true	Indique si la tâche planifiée doit être activée.
appStrategy	String	Non	delete-idle	La stratégie de création d'une nouvelle version. Valeurs valides : - delete-idle : si deux versions existent déjà, supprimer d'abord la version non en ligne, puis créer une nouvelle version. - need-slot : si une seule version existe, créer directement une nouvelle version.
filter	Object	Non		Les conditions de nettoyage des données.
filter.days	Integer	Oui	7	Le nombre de jours d'expiration. Valeurs valides : de 7 à 180.
filter.unit	String	Oui	"s"	L'unité du délai d'expiration. Valeurs valides : - s : secondes. - ms : millisecondes.
filter.field	String	Non	"cate_id"	Le champ d'expiration.
runNow	Boolean	Non	false	Indique si la tâche doit être exécutée immédiatement. Valeur par défaut : false.
permanent	Boolean	Non	true	Indique si la tâche doit être rendue persistante. Valeur par défaut : true.

Éléments de réponse

Élément	Type	Description	Exemple
	object
result	object	Les informations de la tâche planifiée. Pour plus d'informations, consultez ScheduledTask.	{}
requestId	string	L'identifiant de la requête.	ABCDEFGH

Exemples

JSON format

{
  "result": {},
  "requestId": "ABCDEFGH"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.