CreateDownload - - Centre de documentation Alibaba Cloud

Crée une tâche de téléchargement avancée.

Description de l'opération

Moteurs pris en charge.

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.

dbs:CreateDownload

create

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
RegionCode	string	Oui	L'identifiant de la région où se trouve l'instance. Vous pouvez appeler l'opération DescribeDBInstanceAttribute pour une instance ApsaraDB RDS ou l'opération DescribeDBClusterAttribute pour un cluster PolarDB afin d'interroger l'identifiant de la région.	cn-beijing
InstanceName	string	Oui	L'identifiant de l'instance.	rm-wz994c1t1****
BakSetType	string	Non	Le type de la tâche de téléchargement. Valeurs valides :	full
BakSetId	string	Non	L'identifiant du jeu de sauvegarde. Vous pouvez appeler l'opération DescribeBackups pour une instance ApsaraDB RDS ou l'opération DescribeBackups pour un cluster PolarDB afin d'obtenir l'identifiant du jeu de sauvegarde.	146005****
DownloadPointInTime	string	Non	Le point dans le temps pour le téléchargement. Spécifiez un horodatage Unix en millisecondes (ms).	1661331864000
BakSetSize	string	Non	La taille du jeu de sauvegarde complet, en octets. Vous pouvez appeler l'opération DescribeBackups pour une instance ApsaraDB RDS ou l'opération DescribeBackups pour un cluster PolarDB afin d'interroger la taille.	216****
FormatType	string	Non	Le format cible des données téléchargées. Valeurs valides : Valeurs valides : qp.xb : qp.xb csv : CSV. bson : Bson. csv-with-header : csv-with-header. parquet : Parquet. sql : SQL.	CSV
TargetType	string	Non	Le type de destination pour le téléchargement. Valeurs valides :	OSS
TargetBucket	string	Non	Le nom du compartiment OSS de destination.	test123
TargetPath	string	Non	Le chemin de destination pour les données téléchargées.	test_db/path
TargetOssRegion	string	Non	La région où se trouve le compartiment OSS de destination.	cn-beijing
PrimaryKeyTypeOnly	string	Non	Ce paramètre est requis uniquement pour les instances MongoDB. Il indique si la clé primaire d'une table est unique. Définissez la valeur sur true si la clé primaire est unique, ou sur false dans le cas contraire.	false
IsCluster	string	Non	Ce paramètre est requis uniquement pour les instances MongoDB. Définissez la valeur sur true si l'instance est un cluster fragmenté, ou sur false dans le cas contraire.	false
AdminDatabase	string	Non	Ce paramètre est requis uniquement pour les instances MongoDB. Il spécifie le nom de la base de données d'authentification. La valeur par défaut est admin.	admin
UseZstd	string	Non	Indique si l'algorithme de compression zstd doit être utilisé. Valeur par défaut : false.	false
ClusterName	string	Non	Ce paramètre est requis uniquement pour les clusters fragmentés MongoDB. Il spécifie l'identifiant du cluster fragmenté.	dds-0xid8e5336******
IsPhysical	boolean	Non	Ce paramètre est requis uniquement lorsque vous téléchargez des données au format qp.xb à partir d'une instance ApsaraDB RDS for MySQL. Dans ce cas, définissez la valeur sur true.	true

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de la réponse.
RequestId	string	L'identifiant de la requête.	A08F908D-2C35-583F-93C1-ED80753F****
ErrCode	string	Le code d'erreur.	DBS.ParamIsInValid
Success	string	Indique si la requête a réussi. Valeurs valides :	true
ErrMessage	string	Le message d'erreur.	formatType can not be empty
Code	string	Le code d'état.	DBS.ParamIsInValid
Message	string	Le message d'erreur.	formatType can not be empty
Data	object	Les détails de la tâche de téléchargement.
BakSetId	string	L'identifiant du jeu de sauvegarde complet.	146005****
DownloadStatus	string	L'état de la tâche de téléchargement. Valeurs valides :	initializing
Progress	string	Le nombre de tables téléchargées par rapport au nombre total de tables.	0/0
BackupSetTime	integer	Le point dans le temps du jeu de sauvegarde, renvoyé sous forme d'horodatage UNIX en millisecondes.	1661373070000
RegionCode	string	L'identifiant de la région.	cn-beijing
TargetPath	string	Le chemin de destination pour le téléchargement des données.	test_db/path
DbList	string	Si le téléchargement concerne des bases de données ou des tables spécifiques, ce paramètre répertorie leurs noms.	testdb
ExportDataSize	integer	La taille des données exportées, en octets.	0
ImportDataSize	integer	La taille des données traitées, en octets.	0
GmtCreate	integer	L'heure de création de la tâche, renvoyée sous forme d'horodatage UNIX en millisecondes.	1661940917570
TaskId	string	L'identifiant de la tâche de téléchargement.	dt-qxnsfq5s****
Format	string	Le format vers lequel les données sont converties.	CSV
TargetType	string	Le type de destination pour le téléchargement.	URL

Exemples

JSON format

{
  "RequestId": "A08F908D-2C35-583F-93C1-ED80753F****",
  "ErrCode": "DBS.ParamIsInValid",
  "Success": "true",
  "ErrMessage": "formatType can not be empty",
  "Code": "DBS.ParamIsInValid",
  "Message": "formatType can not be empty",
  "Data": {
    "BakSetId": "146005****",
    "DownloadStatus": "initializing",
    "Progress": "0/0",
    "BackupSetTime": 1661373070000,
    "RegionCode": "cn-beijing",
    "TargetPath": "test_db/path",
    "DbList": "testdb",
    "ExportDataSize": 0,
    "ImportDataSize": 0,
    "GmtCreate": 1661940917570,
    "TaskId": "dt-qxnsfq5s****",
    "Format": "CSV",
    "TargetType": "URL"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
200	DBS.DownloadTask.CannotFind	Can not find download task.	Can not find download task.
200	DBS.DownloadTask.JobAlreadyExist	Job already submit in recent days, please check it.	Job already submit in recent days, please check it.
200	DBS.DownloadTask.OnlyOneRunningOrFailedTask	There can be only one running or failed task for the instance.	The current instance can only have one running/failed task at the same time.
200	DBS.DownloadTask.OssForbid	OSS is forbidden to access. Please check your OSS bucket.	OSS is forbidden to access. Please check your OSS bucket.
200	DBS.DownloadTask.OssStorageTypeInvalid	Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.	Unsupported bucket storage. Please make sure that your OSS bucket's storgae type is standard.
200	Forbidden.InstanceNotFound	instance not found	The instance does not exist.
200	DBS.DownloadTask.BakSetError	DBS download task bak set error. Your backup set does not meet the requirements.	Your backup set does not meet the requirements.
200	DBS.DownloadTask.CustinIdNotSupport	DBS DownloadTask CustinIdNotSupport.	DBS DownloadTask CustinIdNotSupport.
200	DBS.DownloadTask.CustinNameNotSupport	DBS DownloadTask CustinNameNotSupport.	DBS DownloadTask CustinNameNotSupport.
200	DBS.DownloadTask.DbTypeNotSupport	DBS DownloadTask DbTypeNotSupport.	DBS DownloadTask DbTypeNotSupport.
200	DBS.DownloadTask.InstanceInfoNotSupport	DBS DownloadTask InstanceInfoNotSupport.	DBS DownloadTask InstanceInfoNotSupport.
200	DBS.DownloadTask.InstanceParamNotSupport	DBS DownloadTask InstanceParamNotSupport.	DBS DownloadTask InstanceParamNotSupport.
200	DBS.DownloadTask.InstanceStorageTypeNotSupport	DBS DownloadTask InstanceStorageTypeNotSupport.
200	DBS.DownloadTask.InstanceVersionNotSupport	DBS DownloadTask InstanceVersionNotSupport.	DBS DownloadTask InstanceVersionNotSupport.
200	DBS.DownloadTask.NotSupport	DBS DownloadTask NotSupport.	DBS DownloadTask NotSupport.
200	DBS.DownloadTask.RegionNotSupport	DBS DownloadTask RegionNotSupport.	DBS DownloadTask RegionNotSupport.
200	DBS.DownloadTask.UserNotSupport	DBS DownloadTask UserNotSupport.	DBS DownloadTask UserNotSupport.
403	Request.Forbidden	Have no Permissions
403	DBS.NoPermissionException	Rejected by ValidationChecker.
404	DBS.NotExists	data source do not existed.	DBS.NotExists