CreateLoadBalancer - - Centre de documentation Alibaba Cloud

Crée une instance Network Load Balancer (NLB).

Notes d'utilisation

Lors de la création d'une instance NLB, le rôle lié au service AliyunServiceRoleForNlb est automatiquement créé et attribué à votre compte.
CreateLoadBalancer est une opération asynchrone. Après l'envoi de la requête, le système renvoie un ID d'instance et exécute la tâche en arrière-plan. Vous pouvez appeler GetLoadBalancerAttribute pour interroger l'état d'une instance NLB.
- Si une instance NLB est dans l'état Provisioning, cela signifie qu'elle est en cours de création.
- Si une instance NLB est dans l'état Active, cela signifie qu'elle a été créée avec succès.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Pour plus de commodité, nous vous recommandons d'appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement l'exemple de code de l'opération pour différents SDK.

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateLoadBalancer	L'opération que vous souhaitez effectuer. Définissez la valeur sur CreateLoadBalancer.
LoadBalancerType	String	No	network	Le type d'instance. Définissez la valeur sur network, ce qui spécifie une instance NLB.
LoadBalancerName	String	No	NLB1	Le nom de l'instance NLB. La valeur doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des tirets (-). La valeur doit commencer par une lettre.
AddressType	String	Yes	Internet	Le type d'adresse IPv4 utilisé par l'instance NLB. Valeurs valides : Internet : L'instance NLB utilise une adresse IP publique. Le nom de domaine de l'instance NLB est résolu vers l'adresse IP publique. Par conséquent, l'instance NLB est accessible via Internet. Intranet : L'instance NLB utilise une adresse IP privée. Le nom de domaine de l'instance NLB est résolu vers l'adresse IP privée. Par conséquent, l'instance NLB est accessible via le VPC où elle est déployée. Remarque Pour activer l'IPv6 public pour une instance NLB à double pile, appelez l'opération EnableLoadBalancerIpv6Internet.
AddressIpVersion	String	No	ipv4	La version du protocole. Valeurs valides : ipv4 : IPv4. Il s'agit de la valeur par défaut. DualStack : double pile
VpcId	String	Yes	vpc-bp1b49rqrybk45nio****	L'ID du VPC où l'instance NLB est déployée.
ZoneMappings.N.VSwitchId	String	Yes	vsw-sersdf****	Le vSwitch dans la zone. Vous ne pouvez spécifier qu'un seul vSwitch (sous-réseau) par zone pour une instance NLB. Vous devez ajouter au moins deux zones. Vous pouvez ajouter jusqu'à 10 zones au maximum.
ZoneMappings.N.ZoneId	String	Yes	cn-hangzhou-a	L'ID de la zone de l'instance NLB. Vous devez ajouter au moins deux zones. Vous pouvez ajouter jusqu'à 10 zones au maximum. Vous pouvez appeler l'opération DescribeZones pour interroger la liste des zones la plus récente.
ZoneMappings.N.PrivateIPv4Address	String	No	192.168.10.1	L'adresse IP privée. Vous devez ajouter au moins deux zones. Vous pouvez ajouter jusqu'à 10 zones au maximum.
ZoneMappings.N.AllocationId	String	No	eip-bp1aedxso6u80u0qf****	L'ID de l'adresse IP élastique (EIP) associée à l'instance NLB orientée Internet. Vous pouvez spécifier une EIP par zone. Vous devez ajouter au moins deux zones. Vous pouvez ajouter jusqu'à 10 zones au maximum.
BandwidthPackageId	String	No	cbwp-bp1vevu8h3ieh****	L'ID du plan de bande passante EIP associé à l'instance NLB orientée Internet.
LoadBalancerBillingConfig.PayType	String	No	PostPay	La méthode de facturation de l'instance NLB. Définissez la valeur sur PostPay, ce qui spécifie la méthode de facturation à la demande (paiement à l'utilisation).
ResourceGroupId	String	No	rg-atstuj3rtop****	L'ID du groupe de ressources.
DryRun	Boolean	No	false	Indique si une vérification préliminaire (dry run) doit être effectuée. Valeurs valides : true : effectue une vérification préliminaire. Le système vérifie les paramètres requis, la syntaxe de la requête et les limites. Si la requête échoue à la vérification, un message d'erreur est renvoyé. Si la requête réussit la vérification, le code d'erreur `DryRunOperation` est renvoyé. false : effectue une vérification préliminaire et envoie la requête. Si la requête réussit la vérification, un code d'état HTTP 2xx est renvoyé et l'opération est exécutée. Il s'agit de la valeur par défaut.
ClientToken	String	No	123e4567-e89b-12d3-a456-426655440000	Le jeton client que vous souhaitez utiliser pour garantir l'idempotence de la requête. Vous pouvez utiliser le client pour générer la valeur, mais vous devez vous assurer qu'elle est unique parmi toutes les requêtes. La valeur ClientToken ne contient que des caractères ASCII. Remarque Si vous ne définissez pas ce paramètre, le système utilise automatiquement la valeur de RequestId comme valeur de ClientToken. La valeur de RequestId est différente pour chaque requête API.
RegionId	String	No	cn-hangzhou	L'ID de la région où l'instance NLB est déployée. Vous pouvez appeler l'opération DescribeRegions pour interroger la liste des régions la plus récente.
DeletionProtectionConfig.Enabled	Boolean	No	false	Indique si la protection contre la suppression est activée. Valeurs valides : true : oui false (par défaut) : non
DeletionProtectionConfig.Reason	String	No	The instance is in the Running state.	La raison pour laquelle la fonction de protection contre la suppression est activée ou désactivée. La valeur doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des tirets (-). La valeur doit commencer par une lettre.
ModificationProtectionConfig.Status	String	No	ConsoleProtection	Indique si le mode lecture seule de la configuration est activé. Valeurs valides : NonProtection : n'active pas le mode lecture seule de la configuration. Vous ne pouvez pas définir le paramètre Reason. Si le paramètre Reason est défini, la valeur est effacée. ConsoleProtection : active le mode lecture seule de la configuration. Vous pouvez définir le paramètre Reason. Remarque Si vous définissez ce paramètre sur ConsoleProtection, vous ne pouvez pas modifier les configurations de l'instance dans la console NLB. Cependant, vous pouvez modifier les configurations de l'instance en appelant les opérations API.
ModificationProtectionConfig.Reason	String	No	Service guarantee period	La raison pour laquelle le mode lecture seule de la configuration est activé. La valeur doit comporter entre 2 et 128 caractères et peut contenir des lettres, des chiffres, des points (.), des traits de soulignement (_) et des tirets (-). La valeur doit commencer par une lettre. Remarque Ce paramètre prend effet uniquement lorsque Status est défini sur ConsoleProtection.

Paramètres de réponse

Parameter	Type	Example	Description
RequestId	String	CEF72CEB-54B6-4AE8-B225-F876FF7BA984	L'ID de la requête.
LoadbalancerId	String	nlb-83ckzc8d4xlp8o****	L'ID de l'instance NLB.
OrderId	Long	20230000	L'ID de la commande pour l'instance NLB.

Exemples

Exemples de requêtes

http(s)://[Endpoint]/?Action=CreateLoadBalancer
&LoadBalancerType=network
&LoadBalancerName=NLB1
&AddressType=Internet
&AddressIpVersion=ipv4
&VpcId=vpc-bp1b49rqrybk45nio****
&ZoneMappings=[{"VSwitchId":"vsw-sersdf****","ZoneId":"cn-hangzhou-a","PrivateIPv4Address":"192.168.10.1","AllocationId":"eip-bp1aedxso6u80u0qf****"}]
&BandwidthPackageId=cbwp-bp1vevu8h3ieh****
&LoadBalancerBillingConfig={"PayType":"PostPay"}
&ResourceGroupId=rg-atstuj3rtop****
&DryRun=false
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&RegionId=cn-hangzhou
&DeletionProtectionConfig={"Enabled":false,"Reason":"The instance is in the Running state."}
&ModificationProtectionConfig={"Status":"ConsoleProtection","Reason":"Service guarantee period"}
&<Common request parameters>

Exemples de réponses réussies

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateLoadBalancerResponse>
    <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BA984</RequestId>
    <LoadbalancerId>nlb-83ckzc8d4xlp8o****</LoadbalancerId>
    <OrderId>20230000</OrderId>
</CreateLoadBalancerResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "LoadbalancerId" : "nlb-83ckzc8d4xlp8o****",
  "OrderId" : 20230000
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, consultez les Codes d'erreur de service .