ModifyAddressBook - - Centre de documentation Alibaba Cloud

Modifie un carnet d'adresses.

Description de l'opération

Cette opération permet de modifier un carnet d'adresses.

Limites de QPS

La limite de requêtes par seconde (QPS) par utilisateur est de 10. Si cette limite est dépassée, les appels d'API sont limités, ce qui peut affecter vos services. Effectuez les appels d'API à un rythme raisonnable.

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.

yundun-cloudfirewall:ModifyAddressBook

update

*AddressBook.

acs:yundun-cloudfirewall::{#accountId}:addressbook/{#GroupUuid}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
ClientToken	string	Non	Le jeton d'idempotence.	ddadxefexxxx
DryRun	boolean	Non	Le mode de test à blanc.
SourceIp `deprecated`	string	Non	L'adresse IP source de l'auteur de la requête.	192.0.XX.XX
Lang	string	Non	Le type de langue. Valeurs valides : en : Anglais. zh : Chinois (par défaut)	zh
AddressList	string	Non	La liste des adresses dans le carnet d'adresses. Séparez les adresses multiples par des virgules (,). Pour chaque élément d'adresse, séparez l'adresse et la description par un espace. Vous devez spécifier ce paramètre lorsque GroupType est défini sur ip, port ou domain. Si GroupType est défini sur ip, saisissez les adresses IP dans la liste d'adresses. Exemple : 1.2.XX.XX/32 Bloc CIDR de développement,10.0.0.X/24,1.2.XX.XX/24 Bloc CIDR de test. Si GroupType est défini sur port, saisissez les ports ou les plages de ports dans la liste d'adresses. Exemple : 80/80 Port HTTP,100/200,3306 Port de base de données. Si GroupType est défini sur domain, saisissez les noms de domaine dans la liste d'adresses. Exemple : demo1.aliyun.com Nom de domaine de test,demo2.aliyun.com,www.aliyun.com Site officiel d'Alibaba Cloud.	192.0.XX.XX/32 ,192.0.XX.XX/24
Description	string	Oui	La description du carnet d'adresses.	bj-001
GroupName	string	Oui	Le nom du carnet d'adresses.	bj-001
GroupUuid	string	Oui	L'UUID du carnet d'adresses. Remarque Pour obtenir cette valeur, appelez l'opération DescribeAddressBook.	0657ab9d-fe8b-4174-b2a6-6baf358e****
AutoAddTagEcs	string	Non	Indique si l'ajout automatique au carnet d'adresses des adresses IP publiques des instances Elastic Compute Service (ECS) correspondant aux nouvelles balises est activé. Valeurs valides : 0 : Ne pas ajouter automatiquement. 1 : Ajouter automatiquement.	1
TagRelation	string	Non	La relation entre plusieurs balises ECS. Valeurs valides : or : or : La relation logique OR est utilisée. Les adresses IP publiques des instances Elastic Compute Service (ECS) sont ajoutées au carnet d'adresses si elles correspondent à au moins une balise. and : and : La relation logique AND est utilisée. Les adresses IP publiques des instances Elastic Compute Service (ECS) sont ajoutées au carnet d'adresses uniquement si elles correspondent à toutes les balises.	and
TagList	array<object>	Non	La liste des balises ECS.
	object	Non	La balise ECS.
TagKey	string	Non	La clé de la balise ECS.	TXY
TagValue	string	Non	La valeur de la balise ECS.	1
ModifyMode	string	Non	Le mode de modification. Remarque Si GroupType est défini sur ip, ipv6, port ou domain et que ce paramètre n'est pas spécifié, le mode Cover est utilisé par défaut pour modifier le carnet d'adresses. Important Si GroupType est défini sur tag, ce paramètre doit être laissé vide. Valeurs valides : Delete : Delete : Supprime du carnet d'adresses les adresses spécifiées par le paramètre AddressList. Append : Append : Ajoute les adresses spécifiées par le paramètre AddressList au carnet d'adresses d'origine. Cover : Cover : Remplace le carnet d'adresses d'origine par les adresses spécifiées par le paramètre AddressList.	Cover
AckNamespaces	array	Non	La liste des espaces de noms des pods dans le cluster ACK. Remarque Un maximum de 10 espaces de noms sont pris en charge.
	string	Non	L'espace de noms de pod dans le cluster ACK. Source de la valeur : DescribeAckClusterNamespaces : Consulte les espaces de noms des clusters ACK. Remarque Requis lorsque GroupType est défini sur ackNamespace.	default
AckLabels	array<object>	Non	La liste des étiquettes de pod dans le cluster ACK. Remarque Un maximum de 10 étiquettes sont prises en charge.
	object	Non	L'étiquette de pod dans le cluster ACK. Source de la valeur : DescribeAckClusterPodLabels : Consulte les étiquettes de pod des clusters ACK. Remarque Requis lorsque GroupType est défini sur ackLabel.	default
Key	string	Non	La clé de l'étiquette de pod dans le cluster ACK.	app
Value	string	Non	La valeur de l'étiquette de pod dans le cluster ACK.	storage-operator
AssetMemberUids	array	Non	La liste des comptes membres dans le carnet d'adresses des ressources.
	integer	Non	Les comptes membres.	13580xxxxxx6271
AssetRegionResourceTypes	array<object>	Non	Le carnet d'adresses des actifs, la région et la liste des types de ressources.
	array<object>	Non	La liste des régions et des types de ressources.
AssetRegionId	string	Non	L'identifiant de la région de l'actif. Valeurs valides : all : Toutes les régions.	all
ResourceType	object	Non	Le type d'actif.
Ipv4	object	Non	Le type d'actif IPv4.
AiGatewayEIP	boolean	Non	Le type d'actif : AIGatewayEIP. Valeurs valides : false : Désactivé. true : Activé.	false
AlbEIP	boolean	Non	Le type d'actif : AlbEIP. Valeurs valides : false : Désactivé. true : Activé.	false
ApiGatewayEIP	boolean	Non	Le type d'actif : ApigEIP. Valeurs valides : false : Désactivé. true : Activé.	false
BastionHostEgressIP	boolean	Non	Le type d'actif : BastionHostEgressIP. Valeurs valides : false : Désactivé. true : Activé.	false
BastionHostIP	boolean	Non	Le type d'actif : BastionHostIP. Valeurs valides : false : Désactivé. true : Activé.	false
BastionHostIngressIP	boolean	Non	Le type d'actif : BastionHostIngressIP. Valeurs valides : false : Désactivé. true : Activé.	false
EIP	boolean	Non	Le type d'actif : EIP. Valeurs valides : false : Désactivé. true : Activé.	false
EcsEIP	boolean	Non	Le type d'actif : EcsEIP. Valeurs valides : false : Désactivé. true : Activé.	false
EcsPublicIP	boolean	Non	Le type d'actif : EcsPublicIP. Valeurs valides : false : Désactivé. true : Activé.	false
EniEIP	boolean	Non	Le type d'actif : EniEIP. Valeurs valides : false : Désactivé. true : Activé.	false
GaEIP	boolean	Non	Le type d'actif : GaEIP. Valeurs valides : false : Désactivé. true : Activé.	false
HAVIP	boolean	Non	Le type d'actif : HAVIP. Valeurs valides : false : Désactivé. true : Activé.	false
NatEIP	boolean	Non	Le type d'actif : NatEIP. Valeurs valides : false : Désactivé. true : Activé.	false
NatPublicIP	boolean	Non	Le type d'actif : NatPublicIP. Valeurs valides : false : Désactivé. true : Activé.	false
NlbEIP	boolean	Non	Le type d'actif : NlbEIP. Valeurs valides : false : Désactivé. true : Activé.	false
SlbEIP	boolean	Non	Le type d'actif : SlbEIP. Valeurs valides : false : Désactivé. true : Activé.	true
SlbPublicIP	boolean	Non	Le type d'actif : SlbPublicIP. Valeurs valides : false : Désactivé. true : Activé.	false
Ipv6	object	Non	Le type d'actif IPv6.
AiGatewayEIPv6	boolean	Non	Le type d'actif : AIGatewayEIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
AlbIPv6	boolean	Non	Le type d'actif : AlbIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
ApiGatewayEIPv6	boolean	Non	Le type d'actif : ApigEIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
EcsIPv6	boolean	Non	Le type d'actif : EcsIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
EniEIPv6	boolean	Non	Le type d'actif : EniEIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
GaEIPv6	boolean	Non	Le type d'actif : GaEIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
NlbIPv6	boolean	Non	Le type d'actif : NlbIPv6. Valeurs valides : false : Désactivé. true : Activé.	false
SlbIPv6	boolean	Non	Le type d'actif : SlbIPv6. Valeurs valides : false : Désactivé. true : Activé.	false

Lorsque vous appelez cette opération d'API, vous devez ajouter les paramètres de requête communs de l'API Alibaba Cloud en plus des paramètres de requête décrits dans cette rubrique. Pour plus d'informations sur les paramètres de requête communs, consultez Paramètres communs. Pour plus d'informations sur le format de requête de cette opération d'API, consultez les exemples de requête dans la section Exemples de cette rubrique.

Éléments de réponse

Élément	Type	Description	Exemple
	object
DryRun	boolean	Indique si la requête est un test à blanc réussi. La valeur true indique que seul le test à blanc est effectué et qu'aucune modification réelle n'est apportée.
RequestId	string	L'identifiant de la requête.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

Exemples

JSON format

{
  "DryRun": false,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	L'Aliuid est invalide.
400	ErrorDBSelect	An error occurred while querying database.	Une exception de lecture de base de données côté serveur s'est produite. Réessayez plus tard. Si le problème persiste, contactez le support technique.
400	ErrorAddressCountExceed	The maximum number of addresses is exceeded.	Le nombre d'adresses dans le carnet d'adresses dépasse la limite supérieure.
400	ErrorParametersGroupAddress	The IP address of the address group is invalid.	L'adresse IP dans le carnet d'adresses n'est pas valide.
400	ErrorParamDomain	The parameter Domain is invalid.	L'adresse de nom de domaine dans le carnet d'adresses n'est pas valide.
400	ErrorAddressGroupNotExist	The address group does not exist.	Le carnet d'adresses n'existe pas.
400	ErrorDBInsert	An error occurred while performing an insert operation in the database.	Une erreur interne s'est produite lors de l'opération d'insertion dans la base de données.
400	ErrorRecordLog	An error occurred while updating the operation log.	Échec de l'écriture du journal.
400	ErrorParametersGroupPort	The group port is invalid.	Le port dans le carnet d'adresses n'est pas valide.
400	ErrorAclExtendedCountExceed	ACL or extended ACL rules are not matched.	Les règles d'ACL ou d'ACL étendues ne correspondent pas.
400	ErrorDBDelete	An error occurred while deleting the database.	Une erreur interne s'est produite lors de l'opération de suppression de la base de données.
400	ErrorAddressGroupExist	The address group already exists.	Le groupe existe déjà.
400	ErrorAclDomainAnyCountExceed	The number of resolved domain names cannot exceed 200. ACL configuration can be continued for HTTP, HTTPS, SMTP, SMTPS, and SSL applications.	Le nombre de noms de domaine résolus dépasse 200. Les applications HTTP, HTTPS, SMTP, SMTPS et SSL prennent en charge davantage de configurations.
400	ErrorParametersAddressGroupAddressNotFound	The address to be deleted does not exist in the address book.	L'adresse à supprimer n'existe pas dans le carnet d'adresses.
400	InvalidParameter.AddressBook.AddressDuplicate	The address book address %s is already exist.	L'adresse %s existe déjà dans le carnet d'adresses.
400	ErrorAckClusterConnectorBusy	The ACK cluster connector is operating.	Le connecteur de cluster ACK spécifié fait l'objet d'une opération.
400	ErrorParameters	Parameters error.	Une erreur de paramètre s'est produite.
400	ErrorParametersMemberUidMismatch	The memberUid mismatch the aliUid.	Les comptes membres et l'aliUid ne correspondent pas.
400	InvalidClientToken	ClientToken format invalid. Only ASCII letters, digits, hyphens and underscores are allowed, max 64 characters.
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.	Cette requête utilise le même jeton client qu'une requête précédente, mais n'est pas identique à celle-ci. Ne réutilisez pas un jeton client pour des requêtes différentes, sauf si les requêtes sont strictement identiques.
401	ErrorAuthentication	An authentication error occurred.	L'authentification a échoué.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.	Le connecteur de cluster ACK pour la ressource spécifiée n'existe pas.
409	IdempotentToken.Processing	A previous request with the same ClientToken is still being processed.

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

Notes de version

Consultez Notes de version pour la liste complète.