DescribeLogBackupPolicy - - Centre de documentation Alibaba Cloud

Consulte la stratégie de rétention des données pour les sauvegardes de journaux d'un cluster PolarDB.

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.

polardb:DescribeLogBackupPolicy

get

*dbcluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
DBClusterId	string	Oui	L'identifiant du cluster. Remarque Vous pouvez appeler l'opération DescribeDBClusters pour obtenir les informations sur tous les clusters d'une région spécifique, y compris les identifiants des clusters.	pc-*****************

Éléments de réponse

Élément	Type	Description	Exemple
	object
LogBackupRetentionPeriod	integer	La période de rétention de la sauvegarde de journaux. Valeurs valides : 3 to 7300 : la sauvegarde de journaux est conservée pendant 3 à 7 300 jours. -1 : les sauvegardes de journaux sont conservées de manière permanente. Remarque Si la fonction de sauvegarde avancée est activée, ce paramètre n'est pas recommandé. Utilisez plutôt le paramètre AdvancedLogPolicies.	7
RequestId	string	L'identifiant de la requête.	62EE0051-102B-488D-9C79-D607B8******
LogBackupAnotherRegionRetentionPeriod	string	La période de rétention de la sauvegarde de journaux inter-régions. Valeurs valides : 0 : la fonction de sauvegarde de journaux inter-régions est désactivée. 30 to 7300 : la sauvegarde de journaux inter-régions est conservée pendant 30 à 7 300 jours. -1 : les sauvegardes de journaux inter-régions sont conservées de manière permanente. Remarque Lorsque vous créez un cluster, la valeur par défaut est 0. Cette valeur indique que la fonction de sauvegarde de journaux inter-régions est désactivée. Si la fonction de sauvegarde avancée est activée, ce paramètre n'est pas recommandé. Utilisez plutôt le paramètre AdvancedLogPolicies.	0
LogBackupAnotherRegionRegion	string	La région dans laquelle la sauvegarde de journaux inter-régions est stockée. Pour plus d'informations sur les régions prenant en charge la sauvegarde inter-régions, consultez la section Vue d'ensemble. Remarque Si la fonction de sauvegarde avancée est activée, ce paramètre n'est pas recommandé. Utilisez plutôt le paramètre AdvancedLogPolicies.	cn-beijing
EnableBackupLog	integer	Indique si la fonction de sauvegarde de journaux est activée. Valeurs valides : 0 : la fonction est désactivée. 1 : la fonction est activée. Par défaut, la fonction de sauvegarde de journaux est activée et ne peut pas être désactivée. Remarque Si la fonction de sauvegarde avancée est activée, ce paramètre n'est pas recommandé. Utilisez plutôt le paramètre AdvancedLogPolicies.	1
AdvancedLogPolicies	object
AdvancedLogPolicy	array<object>	Les détails de la stratégie de sauvegarde de journaux avancée. Remarque Ce paramètre n'est pas pris en charge par PolarDB for PostgreSQL (compatible avec Oracle) ni par PolarDB for PostgreSQL.
	object
PolicyId	string	The ID of the log backup policy. Remarque This parameter is returned only for clusters for which the cross-region log backup feature is enabled.	1c75zkmqczcd1vbf6f6d05***
LogRetentionType	string	The retention type for the log backup. Valid values: never: The log backups never expire. delay: The log backups are retained for a specified number of days.	delay
LogRetentionValue	string	The number of days to retain log backups. Valid values: 3 to 7300: The retention period in days. -1: The log backups are retained permanently.	7
SrcType	string	The source type for the log backup policy. Valid values: db: database cluster level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level1
DestType	string	The destination type for the log backup policy. Valid values: level1: level-1 backup level2: level-2 backup level2Cross: level-2 cross-region backup	level2
EnableLogBackup	integer	Indicates whether the log backup feature is enabled. The return value can be: 1: enabled 0: disabled	1
SrcRegion	string	The source region of the log backup policy.	cn-hangzhou
DestRegion	string	The destination region of the log backup policy.	cn-shanghai

Exemples

JSON format

{
  "LogBackupRetentionPeriod": 7,
  "RequestId": "62EE0051-102B-488D-9C79-D607B8******",
  "LogBackupAnotherRegionRetentionPeriod": "0",
  "LogBackupAnotherRegionRegion": "cn-beijing",
  "EnableBackupLog": 1,
  "AdvancedLogPolicies": {
    "AdvancedLogPolicy": [
      {
        "PolicyId": "1c75zkmqczcd1vbf6f6d05***",
        "LogRetentionType": "delay",
        "LogRetentionValue": "7",
        "SrcType": "level1",
        "DestType": "level2",
        "EnableLogBackup": 1,
        "SrcRegion": "cn-hangzhou",
        "DestRegion": "cn-shanghai"
      }
    ]
  }
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

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

Notes de version

Consultez Notes de version pour la liste complète.