ModifyDBClusterAccessWhitelist - - Centre de documentation Alibaba Cloud

Crée ou modifie la liste blanche d'un cluster, y compris la liste blanche d'adresses IP et les groupes de sécurité.

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:ModifyDBClusterAccessWhitelist

update

*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.	pc-*************
SecurityIps	string	Non	Les adresses IP ou blocs CIDR dans le groupe de liste blanche d'adresses IP. Vous pouvez ajouter jusqu'à 1 000 adresses IP ou blocs CIDR dans l'ensemble des groupes de liste blanche d'adresses IP. Séparez les adresses IP multiples par des virgules (,). Les deux formats suivants sont pris en charge : Format d'adresse IP, tel que 10.23.12.24. Format CIDR, tel que 10.23.12.24/24, où 24 indique la longueur du préfixe dans l'adresse IP. La longueur du préfixe varie de 1 à 32. Remarque Ce paramètre prend effet uniquement lorsque WhiteListType est défini sur IP.	10.23.12.24
DBClusterIPArrayName	string	Non	Le nom du groupe de liste blanche d'adresses IP. Le nom doit comporter entre 2 et 120 caractères et peut contenir des lettres minuscules et des chiffres. Le nom doit commencer par une lettre et se terminer par une lettre ou un chiffre. Si le nom de groupe de liste blanche spécifié n'existe pas, un nouveau groupe de liste blanche est créé. Si le nom de groupe de liste blanche spécifié existe déjà, le groupe de liste blanche est modifié. Si ce paramètre n'est pas spécifié, le groupe par défaut est modifié. Remarque Un cluster prend en charge jusqu'à 50 groupes de liste blanche d'adresses IP. Ce paramètre prend effet uniquement lorsque WhiteListType est défini sur IP.	default
DBClusterIPArrayAttribute	string	Non	L'attribut du groupe de liste blanche d'adresses IP. Si vous définissez ce paramètre sur hidden, le groupe n'est pas affiché dans la console. Remarque Les groupes de liste blanche d'adresses IP qui sont déjà affichés dans la console ne peuvent pas être masqués. Ce paramètre prend effet uniquement lorsque WhiteListType est défini sur IP.	hidden
WhiteListType	string	Non	Le type de liste blanche. Valeurs valides : IP : groupe de liste blanche d'adresses IP. SecurityGroup : groupe de sécurité. Valeur par défaut : IP.	IP
SecurityGroupIds	string	Non	Les identifiants des groupes de sécurité. Séparez les identifiants de groupes de sécurité multiples par des virgules (,). Remarque Un cluster prend en charge jusqu'à 3 groupes de sécurité. Ce paramètre prend effet uniquement lorsque WhiteListType est défini sur SecurityGroup.	sg-*********
ModifyMode	string	Non	La méthode utilisée pour modifier la liste blanche d'adresses IP. Valeurs valides : Cover : remplace la liste blanche d'adresses IP d'origine. Il s'agit de la valeur par défaut. Append : ajoute des adresses IP à la liste blanche d'adresses IP. Delete : supprime des adresses IP de la liste blanche d'adresses IP. Remarque Ce paramètre prend effet uniquement lorsque WhiteListType est défini sur IP.	Cover
PfsInstanceId	string	Non	L'identifiant de l'instance de système de fichiers.	pfs-xxx

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	D0CEC6AC-7760-409A-A0D5-E6CD86******

Exemples

JSON format

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	NumberExceed.securityGroupIds	The number of SecurityGroupIds exceeds 10.	L'opération a échoué car le nombre de groupes de sécurité a dépassé la limite supérieure de 10. Modifiez la configuration et réessayez.
400	InvalidSecurityIPList.Duplicate	Specified security IP list is not valid: Duplicate IP address in the list	La liste d'adresses IP de sécurité spécifiée est invalide : la liste contient des adresses IP en double.
400	InvalidSecurityIPList.Format	Specified security IP list format is not valid.	Le format d'adresse IP de liste blanche spécifié est invalide.
400	LockTimeout	The request processing has failed due to lock timeout.	Le traitement de la requête a échoué en raison d'un dépassement du délai d'attente de verrouillage.
403	SecurityIPList.Duplicate	Specified same security IP already exists.	L'adresse IP de sécurité spécifiée existe déjà.
403	OperationDenied.LockMode	The operation is not permitted when the instance is locked.	L'opération a échoué car l'instance est dans un état verrouillé et ne prend pas en charge cette opération.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	L'opération a échoué car l'identifiant de l'instance de cluster spécifié n'existe pas.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	Le DBClusterId fourni n'existe pas dans les enregistrements actuels.

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

Notes de version

Consultez Notes de version pour la liste complète.