CreateListener - - Centre de documentation Alibaba Cloud

Crée un écouteur.

Description de l'opération

L'opération CreateListener est une opération asynchrone. Une requête réussie renvoie un identifiant de requête, mais l'écouteur est créé en arrière-plan. Appelez GetListenerAttribute pour interroger l'état de création de l'écouteur :

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.

alb:CreateListener

create

*LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

*SecurityPolicy

acs:alb:{#regionId}:{#accountId}:securitypolicy/{#securitypolicyId}

*ServerGroup

acs:alb:{#regionId}:{#accountId}:servergroup/{#servergroupId}

alb:ListenerProtocol

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
LoadBalancerId	string	Oui	L'identifiant de l'instance Application Load Balancer (ALB).	alb-n5qw04uq8vavfe****
ClientToken	string	Non	Un jeton généré par le client qui est utilisé pour garantir l'idempotence de la requête. Le jeton doit être unique pour les différentes requêtes et ne peut contenir que des caractères ASCII.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	Non	Indique si un test à blanc doit être effectué. Valeurs valides :	false
ListenerProtocol	string	Oui	Le protocole de l'écouteur.	HTTP
ListenerPort	integer	Oui	Le port frontal utilisé par l'écouteur.	80
ListenerDescription	string	Non	Un nom personnalisé pour l'écouteur.	HTTP_80
RequestTimeout	integer	Non	Le délai d'expiration de la requête en secondes.	60
IdleTimeout	integer	Non	Le délai d'inactivité en secondes.	3
GzipEnabled	boolean	Non	Indique si la compression Gzip doit être activée pour compresser des types de fichiers spécifiques. Valeurs valides :	true
Http2Enabled	boolean	Non	Indique si HTTP/2 doit être activé. Valeurs valides :	true
SecurityPolicyId	string	Non	L'identifiant de la stratégie de sécurité. Les stratégies de sécurité système et personnalisées sont prises en charge.	tls_cipher_policy_1_0
CaEnabled	boolean	Non	Indique si l'authentification mutuelle doit être activée. Valeurs valides :	false
XForwardedForConfig	object	Non	La configuration des en-têtes X-Forwarded-*.
XForwardedForClientCertClientVerifyAlias	string	Non	Le nom de l'en-tête personnalisé. Ce paramètre prend effet uniquement lorsque XForwardedForClientCertClientVerifyEnabled est défini sur true.	test_client-verify-alias_123456
XForwardedForClientCertClientVerifyEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Client-Cert-Client-Verify doit être utilisé pour récupérer le résultat de vérification du certificat client. Valeurs valides :	true
XForwardedForClientCertFingerprintAlias	string	Non	Le nom de l'en-tête personnalisé. Ce paramètre prend effet uniquement lorsque XForwardedForClientCertFingerprintEnabled est défini sur true.	test_finger-print-alias_123456
XForwardedForClientCertFingerprintEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Client-Cert-Fingerprint doit être utilisé pour récupérer l'empreinte du certificat client. Valeurs valides :	true
XForwardedForClientCertIssuerDNAlias	string	Non	Le nom de l'en-tête personnalisé. Ce paramètre prend effet uniquement lorsque XForwardedForClientCertIssuerDNEnabled est défini sur true.	test_issue-dn-alias_123456
XForwardedForClientCertIssuerDNEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Client-Cert-Issuer-DN doit être utilisé pour récupérer des informations sur l'émetteur du certificat client. Valeurs valides :	true
XForwardedForClientCertSubjectDNAlias	string	Non	Le nom de l'en-tête personnalisé. Ce paramètre prend effet uniquement lorsque XForwardedForClientCertSubjectDNEnabled est défini sur true.	test_subject-dn-alias_123456
XForwardedForClientCertSubjectDNEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Client-Cert-Subject-DN doit être utilisé pour récupérer des informations sur le propriétaire du certificat client. Valeurs valides :	true
XForwardedForClientSrcPortEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Client-Srcport doit être utilisé pour récupérer le port source du client. Valeurs valides :	true
XForwardedForEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-For doit être utilisé pour récupérer l'adresse IP du client. Valeurs valides :	true
XForwardedForProcessingMode	string	Non	Le mode utilisé pour traiter l'en-tête X-Forwarded-For. Ce paramètre prend effet uniquement lorsque XForwardedForEnabled est défini sur true. Valeurs valides :	append
XForwardedForProtoEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Proto doit être utilisé pour récupérer le protocole de l'écouteur de l'instance ALB. Valeurs valides :	false
XForwardedForSLBIdEnabled	boolean	Non	Indique si l'en-tête SLB-ID doit être utilisé pour récupérer l'identifiant de l'instance ALB. Valeurs valides :	false
XForwardedForSLBPortEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Port doit être utilisé pour récupérer le port de l'écouteur de l'instance ALB. Valeurs valides :	false
XForwardedForClientSourceIpsEnabled	boolean	Non	Indique si ALB est autorisé à récupérer l'adresse IP du client à partir de l'en-tête X-Forwarded-For. Valeurs valides :	false
XForwardedForClientSourceIpsTrusted	string	Non	Spécifie les adresses IP de proxy de confiance.	10.1.1.0/24
XForwardedForHostEnabled	boolean	Non	Indique si l'en-tête X-Forwarded-Host doit être utilisé pour récupérer le nom de domaine utilisé pour accéder à l'instance ALB. Valeurs valides :	false
QuicConfig	object	Non	La configuration de l'écouteur QUIC associé.
QuicListenerId	string	Non	L'identifiant de l'écouteur QUIC à associer à l'écouteur. Ce paramètre est requis pour les écouteurs HTTPS lorsque QuicUpgradeEnabled est défini sur true.	lsn-o4u54y73wq7b******
QuicUpgradeEnabled	boolean	Non	Indique si la mise à niveau QUIC doit être activée. Valeurs valides :	false
Certificates	array<object>	Non	Une liste de certificats de serveur.
	object	Non	Le certificat.
CertificateId	string	Non	L'identifiant du certificat de serveur par défaut. Un seul certificat de serveur par défaut est pris en charge.	103705*******
CaCertificates	array<object>	Non	Une liste de certificats d'autorité de certification pour l'écouteur. Un seul certificat d'autorité de certification est pris en charge.
	object	Non	Le certificat d'autorité de certification.
CertificateId	string	Non	L'identifiant du certificat d'autorité de certification.	123157*******
DefaultActions	array<object>	Oui	Les actions par défaut pour l'écouteur.
	array<object>	Oui	La liste des actions par défaut.
ForwardGroupConfig	object	Oui	La configuration de l'action de transfert. Vous pouvez spécifier jusqu'à 20 actions de transfert.
ServerGroupTuples	array<object>	Oui	Les groupes de serveurs de destination.
	object	Oui	Les groupes de serveurs de destination.
ServerGroupId	string	Oui	The ID of the destination server group.	sgp-8ilqs4axp6******
Type	string	Oui	Le type d'action.	ForwardGroup
Tag	array<object>	Non	Liste des balises à ajouter à l'écouteur.
	object	Non	La balise.
Key	string	Non	La clé de la balise. La clé peut comporter jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:, ni contenir http:// ou https://.	env
Value	string	Non	La valeur de la balise. La valeur peut comporter jusqu'à 128 caractères et ne peut pas commencer par aliyun ou acs:, ni contenir http:// ou https://.	product

Éléments de réponse

Élément	Type	Description	Exemple
	object	Détails de l'écouteur créé.
JobId	string	Identifiant de la tâche asynchrone.	72dcd26b-f12d-4c27-b3af-18f6aed5****
ListenerId	string	Identifiant de l'écouteur.	lsn-o4u54y73wq7b******
RequestId	string	Identifiant de la requête.	CEF72CEB-54B6-4AE8-B225-F876*******

Exemples

JSON format

{
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****",
  "ListenerId": "lsn-o4u54y73wq7b******",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876*******"
}

Codes d'erreur

Code de statut HTTP	Code d'erreur	Message d'erreur	Description
400	ResourceAlreadyExist.Listener	The specified resource %s is already exist.
400	IncorrectStatus.LoadBalancer	The status of %s [%s] is incorrect.
400	IncorrectBusinessStatus.LoadBalancer	The business status of %s [%s] is incorrect.	The business status of %s [%s] is incorrect.
400	ResourceQuotaExceeded.LoadBalancerListenersNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota of %s is exceeded for resource %s, usage %s/%s.
400	OperationDenied.CrossLoadBalancerQUICListener	The operation is not allowed because of %s.	The operation is not allowed because of %s.
400	ResourceAlreadyAssociated.Listener	The specified resource %s is already associated.	The specified resource %s is already associated.
400	ResourceQuotaExceeded.SecurityPolicyAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.	The quota of %s is exceeded for resource %s. Usage: %s/%s.
400	ResourceQuotaExceeded.ServerGroupAttachedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.LoadBalancerServersNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	ResourceQuotaExceeded.ServerAddedNum	The quota of %s is exceeded for resource %s, usage %s/%s.
400	Mismatch.VpcId	The %s is mismatched for %s and %s.	The %s is mismatched for %s and %s.
400	OperationDenied.ServerGroupProtocolNotSupport	The operation is not allowed because of ServerGroupProtocolNotSupport.	The operation is not allowed because the server group protocol is not supported.
400	OperationDenied.GRPCServerGroup	The operation is not allowed because of %s.
400	Mismatch.LoadBalancerEditionAndConnectionDrain	The %s and %s are mismatched.	The %s and %s are mismatched.
400	Mismatch.LoadBalancerEditionAndSlowStartEnable	The %s and %s are mismatched.	The %s and %s are mismatched.
400	InvalidParameter	Invalid parameter, please check the parameter input.	Invalid parameter, please check the parameter input.
400	OperationDenied.CACertificateCorrupted	The CA certificate is corrupted.	CA certificate is corrupted
403	Forbidden.SecurityPolicy	Authentication has failed for SecurityPolicy.
403	Forbidden.LoadBalancer	Authentication is failed for %s.	Authentication is failed for %s.
403	Forbidden.Listener	Authentication is failed for %s.	Authentication is failed for %s.
404	ResourceNotFound.LoadBalancer	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.ServerGroup	The specified resource %s is not found.
404	ResourceNotFound.SecurityPolicy	The specified resource %s is not found.	The specified resource %s is not found.
404	ResourceNotFound.Listener	The specified resource %s is not found.
404	ResourceNotFound.Certificate	The specified resource %s is not found.	The specified resource %s is not found.

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

Notes de version

Consultez Notes de version pour la liste complète.