# Alibaba Cloud Network Load Balancer API

> Alibaba Cloud Network Load Balancer API on Apizie: 51 endpoints (Adds backend servers to a Network Load Balancer (NLB) server group, Associates additional certificates with a TCPSSL listener, Associates an Internet Shared Bandwidth with a Network Load Balancer (NLB) instance, Adds the EIP or VIP of a zone back to DNS resolution, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-nlb/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-nlb`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/nlb
- Page: https://apizie.tech/api/cloud/aliyun-nlb
- OpenAPI: https://apizie.tech/api/cloud/aliyun-nlb/openapi.json

Alibaba Cloud OpenAPI for Network Load Balancer (nlb, version 2022-04-30). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds backend servers to a Network Load Balancer (NLB) server group
`POST https://apizie.tech/v1/cloud:aliyun-nlb/add-servers-to-server-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupId | string | yes | The ID of the server group |
| Servers | string | yes | The list of backend servers. You can specify up to 200 servers in a single call (JSON-encoded) |
| RegionId | string | no | The ID of the region where the Network Load Balancer (NLB) instance is deployed. You can call the… |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: prechecks the request without adding the servers. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |

### Associates additional certificates with a TCPSSL listener
`POST https://apizie.tech/v1/cloud:aliyun-nlb/associate-additional-certificates-with-listener` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| AdditionalCertificateIds | string | yes | The list of additional certificates. You can associate up to 15 additional certificates with a listener in a single call (JSON-encoded) |
| ListenerId | string | yes | The ID of the listener. This operation only supports TCPSSL listener IDs |
| DryRun | string | no | Specifies whether to only precheck this request. Valid values: true: sends a check request and does not add the additional certificates to… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate a value for this parameter on your client to… |
| RegionId | string | no | The ID of the region where the Network Load Balancer (NLB) instance is deployed. You can invoke the… |

### Associates an Internet Shared Bandwidth with a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/attach-common-bandwidth-package-to-load-balancer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The ID of the Network Load Balancer (NLB) instance |
| BandwidthPackageId | string | yes | The ID of the Internet Shared Bandwidth to be associated |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run and does not associate the Internet Shared Bandwidth. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client to ensure that it is… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |

### Adds the EIP or VIP of a zone back to DNS resolution
`POST https://apizie.tech/v1/cloud:aliyun-nlb/cancel-shift-load-balancer-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ZoneMappings | string | yes | The list of zone and vSwitch mappings. You can add back at most one zone in a single call (JSON-encoded) |
| LoadBalancerId | string | yes | The NLB instance ID |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: sends a precheck request without adding the zone back. The system… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client. Make sure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query region IDs |

### Creates a TCP, UDP, or TCPSSL listener on a Network Load Balancer (NLB) instance for load balancing
`POST https://apizie.tech/v1/cloud:aliyun-nlb/create-listener` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerProtocol | string | yes | The listener protocol. Valid values: TCP, UDP, and TCPSSL |
| ListenerPort | integer | yes | The listener port. Valid values: 0 to 65535. 0: indicates that the all-port feature is used. If you set this parameter to 0, you must… |
| ListenerDescription | string | no | The custom name of the listener. The name must be 2 to 256 characters in length, and can contain Chinese characters, English letters,… |
| LoadBalancerId | string | yes | The instance ID of the Network Load Balancer (NLB) for load balancing |
| ServerGroupId | string | no | The ID of the server group. If ListenerProtocol is set to TCP, the listener supports server groups whose backend protocol is TCP or… |
| IdleTimeout | integer | no | The idle timeout period for connections. Unit: seconds. If ListenerProtocol is set to TCP or TCPSSL, the idle timeout period ranges from… |
| SecurityPolicyId | string | no | The ID of the security policy. System security policies and custom security policies are supported. Valid values for system policies:… |
| CertificateIds | string | no | The information about the server certificates. This parameter takes effect only for TCPSSL listeners. You can add only one server… |
| CaCertificateIds | string | no | The list of CA certificates. This parameter takes effect only for TCPSSL listeners. You can add only one CA certificate (JSON-encoded) |
| CaEnabled | string | no | Specifies whether to enable mutual authentication. Valid values: true: enables mutual authentication. false (default): disables mutual… |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the listener. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can invoke the https://help.aliyun.com/document_detail/443657.html… |
| ProxyProtocolEnabled | string | no | Specifies whether to use the PROXY protocol to pass the client source IP address to the backend server. Valid values: true: yes. false… |
| SecSensorEnabled | string | no | Specifies whether to enable second-level monitoring. Valid values: true: enables second-level monitoring. false (default): disables… |
| AlpnEnabled | string | no | Specifies whether to enable Application-Layer Protocol Negotiation (ALPN). Valid values: true: enables ALPN. false (default): disables ALPN |
| AlpnPolicy | string | no | The ALPN policy. Valid values: HTTP1Only: negotiates only the HTTP/1.x protocol. The priority is HTTP/1.1 > HTTP/1.0. HTTP2Only:… |
| StartPort | integer | no | The start port for all-port listening. Valid values: 1 to 65535. You must configure this parameter when ListenerPort is set to 0 |
| EndPort | integer | no | The end port for all-port listening. Valid values: 1 to 65535. The end port must be greater than the start port. You must configure this… |
| Cps | integer | no | The limit on the number of new connections processed per second by the listener in each zone (VIP). Valid values: 0 to 1000000. 0… |
| Mss | integer | no | The maximum segment size (MSS) of TCP packets. Unit: bytes. Valid values: 0 to 1500. 0: indicates that the MSS value of user TCP packets… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ProxyProtocolV2Config | string | no | The configuration for passing the VpcId, PrivateLinkEpId, and PrivateLinkEpsId information to the backend server by using the PROXY… |

### Creates a Network Load Balancing (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/create-load-balancer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerType | string | no | The type of load balancing. Valid value: network, which indicates Network Load Balancing (NLB) |
| LoadBalancerName | string | no | The name of the Network Load Balancing (NLB) instance. The name must be 2 to 128 characters in length, and can contain letters, digits,… |
| AddressType | string | yes | The IPv4 address type of the Network Load Balancing (NLB) instance. Valid values: Internet: The load balancing instance has a public IP… |
| AddressIpVersion | string | no | The IP version. Valid values: ipv4 (default): IPv4. DualStack: dual-stack |
| VpcId | string | yes | The ID of the virtual private cloud (VPC) where the Network Load Balancing (NLB) instance is deployed |
| ZoneMappings | string | yes | The zone and vSwitch mappings. You can add up to 10 zones. If the current region supports two or more zones, you must add at least two… |
| BandwidthPackageId | string | no | The ID of the Internet Shared Bandwidth instance that is associated with the Internet-facing instance |
| LoadBalancerBillingConfig | string | no | The billing configuration of the Network Load Balancing (NLB) instance (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the instance. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | no | The region ID of the Network Load Balancing (NLB) instance. You can invoke the https://help.aliyun.com/document_detail/443657.html… |
| DeletionProtectionConfig | string | no | The deletion protection configuration (JSON-encoded) |
| ModificationProtectionConfig | string | no | The modification protection configuration (JSON-encoded) |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates a custom security policy for a TCPSSL listener in a specified region
`POST https://apizie.tech/v1/cloud:aliyun-nlb/create-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| TlsVersions | string | yes | The supported TLS versions. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, and TLSv1.3 (JSON-encoded) |
| SecurityPolicyName | string | no | Policy Name of the security policy. Policy Name must be 1 to 200 characters in length, and can contain Chinese characters, uppercase and… |
| ResourceGroupId | string | no | The ID of the resource group |
| Ciphers | string | yes | The supported cipher suites, which depend on the TLSVersion value. You can add up to 32 cipher suites. Supported by TLSv1.0 and TLSv1.1:… |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the custom security policy. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can invoke the https://help.aliyun.com/document_detail/443657.html… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Creates a server group in a specified region
`POST https://apizie.tech/v1/cloud:aliyun-nlb/create-server-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupType | string | no | The server group type. Valid values: Instance (default): server type. This type of server group supports adding Ecs, Eni, and Eci… |
| ServerGroupName | string | yes | The name of the server group. The name must be 2 to 128 characters in length, and must start with a letter or Chinese character. It can… |
| AddressIPVersion | string | no | The protocol version. Valid values: ipv4 (default): IPv4. DualStack: dual-stack |
| IpVersionAffinityMode | string | no | The traffic scheduling policy in dual-stack mode. Valid values: NonAffinity (default): non-affinity mode. Traffic is forwarded to healthy… |
| Protocol | string | no | The communication protocol used to forward traffic to backend servers. Valid values: TCP (default) UDP TCP_UDP If this parameter is set to… |
| VpcId | string | yes | The ID of the VPC where the server group is deployed. If ServerGroupType is set to Instance, only servers in this VPC can be added to the… |
| AnyPortEnabled | string | no | Specifies whether to enable all-port forwarding. Valid values: true: enables all-port forwarding. false (default): disables all-port… |
| ConnectionDrainEnabled | string | no | Specifies whether to enable connection draining. Valid values: true: enables connection draining. false (default): disables connection… |
| ConnectionDrainTimeout | integer | no | The timeout period for connection draining. Unit: seconds. Valid values: 0 to 900 |
| Scheduler | string | no | The scheduling algorithm. Valid values: Wrr (default): weighted round-robin. Backend servers with higher weights are more likely to be… |
| PreserveClientIpEnabled | string | no | Specifies whether to enable client IP address preservation. Valid values: true (default): enables client IP address preservation. false:… |
| HealthCheckConfig | string | no | The health check configuration (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the server group belongs |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: prechecks the request without creating the server group. The system… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |
| Tag | string | no | The list of tags (JSON-encoded) |

### Deletes a Network Load Balancer (NLB) listener
`POST https://apizie.tech/v1/cloud:aliyun-nlb/delete-listener` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The listener ID |
| DryRun | string | no | Specifies whether to only perform a dry run for the request. Valid values: true: sends a dry run request and does not delete the listener.… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate a value for this parameter on the client to… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |

### Deletes a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/delete-load-balancer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The ID of the Network Load Balancer (NLB) instance |
| DryRun | string | no | Specifies whether to perform only a dry run on the request. Valid values: true: Performs a dry run without deleting the instance. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value of this parameter on your client to… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |

### Deletes a custom TLS security policy for Network Load Balancer (NLB)
`POST https://apizie.tech/v1/cloud:aliyun-nlb/delete-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| SecurityPolicyId | string | yes | The ID of the TLS security policy |
| DryRun | string | no | Specifies whether to perform a dry run only. Valid values: true: sends a check request and does not delete the custom security policy. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate a value for this parameter on your client to… |
| RegionId | string | no | The ID of the region where the Network Load Balancer (NLB) instance is deployed. You can invoke the… |

### Deletes a server group of a Network Load Balancer (NLB)
`POST https://apizie.tech/v1/cloud:aliyun-nlb/delete-server-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupId | string | yes | The ID of the server group |
| DryRun | string | no | Specifies whether to only perform a dry run on the request. Valid values: true: Performs a dry run without deleting the server group. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value of this parameter on your client to… |
| RegionId | string | no | The ID of the region where the Network Load Balancer (NLB) instance is deployed. You can invoke the… |

### Queries the storage configuration for second-level monitoring
`POST https://apizie.tech/v1/cloud:aliyun-nlb/describe-hd-monitor-region-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The ID of the region where the resource resides |

### Queries the available regions for NLB
`POST https://apizie.tech/v1/cloud:aliyun-nlb/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServiceCode | string | no | The service code of the cloud service. Valid value: nlb |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN: Chinese. en-US (default): English. ja: Japanese |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client to ensure that the… |

### Queries the zones in a region for Network Load Balancer (NLB)
`POST https://apizie.tech/v1/cloud:aliyun-nlb/describe-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServiceCode | string | no | The service code of the cloud service. Valid value: nlb |
| RegionId | string | no | The region ID of the zone. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent region… |
| AcceptLanguage | string | no | The supported language. Valid values: zh-CN: Chinese. en-US: English. This is the default value. ja: Japanese |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |

### Disassociates an Internet Shared Bandwidth plan from a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/detach-common-bandwidth-package-from-load-balancer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The ID of the Network Load Balancer (NLB) instance |
| BandwidthPackageId | string | yes | The ID of the Internet Shared Bandwidth plan to remove |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: sends a check request and does not disassociate the bandwidth plan.… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate a value for this parameter on your client to… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |

### Changes the IPv6 address of a dual-stack Network Load Balancer (NLB) instance from public to private
`POST https://apizie.tech/v1/cloud:aliyun-nlb/disable-load-balancer-ipv6-internet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The Network Load Balancer (NLB) instance ID |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run without changing the network type of the IPv6 instance. The… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |

### Disassociates additional certificates from a listener that uses SSL over TCP
`POST https://apizie.tech/v1/cloud:aliyun-nlb/disassociate-additional-certificates-with-listener` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| AdditionalCertificateIds | string | yes | The additional certificates. You can disassociate up to 15 additional certificates in each call (JSON-encoded) |
| ListenerId | string | yes | The listener ID. Only TCP/SSL listener IDs are supported |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: Validates the request without performing the operation. The system checks the… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate this value. Ensure that the value is… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Changes the network type of the IPv6 address of a dual-stack Network Load Balancer (NLB) instance from…
`POST https://apizie.tech/v1/cloud:aliyun-nlb/enable-load-balancer-ipv6-internet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The NLB instance ID |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: prechecks the request without performing… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Queries the execution result of an asynchronous task for Network Load Balancer (NLB)
`POST https://apizie.tech/v1/cloud:aliyun-nlb/get-job-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| JobId | string | yes | The ID of the asynchronous task |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. Generate a value from your client to ensure that the value is… |

### Queries the details of a listener for a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/get-listener-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The listener ID |
| DryRun | string | no | Specifies whether to only precheck the request. Valid values: true: sends a check request and does not query the listener details. Check… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can generate the value from your client. Make sure that the… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can invoke the https://help.aliyun.com/document_detail/443657.html… |

### Queries the health check status of a Network Load Balancer (NLB) listener
`POST https://apizie.tech/v1/cloud:aliyun-nlb/get-listener-health-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The ID of the listener on the NLB instance |
| RegionId | string | no | The ID of the region where the NLB instance is deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |

### Queries the details of a specified Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/get-load-balancer-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The Network Load Balancer (NLB) instance ID |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax,… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure… |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |

### Queries the results of multiple asynchronous operations performed on a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-asyn-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| JobIds | string | no | The task IDs (JSON-encoded) |

### Queries the server certificates of a TCPSSL listener
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-listener-certificates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The listener ID. This parameter is valid only for TCPSSL listeners |
| CertType | string | no | The certificate type. Valid values: Ca: CA certificate. Server: Server certificate |
| NextToken | string | no | The pagination token for the next query. Leave this parameter empty for the first query or when no subsequent query is required. For… |
| MaxResults | integer | no | The number of entries to return per page. Valid values: 1 to 50. Default value: 20 |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |
| CertificateIds | string | no | The server certificates. You can add only one server certificate. This parameter takes effect only for TCPSSL listeners (JSON-encoded) |

### Queries listeners added to a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-listeners` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerIds | string | no | The listener IDs. You can specify up to 20 listeners (JSON-encoded) |
| LoadBalancerIds | string | no | The IDs of the NLB instances. You can specify up to 20 instances (JSON-encoded) |
| ListenerProtocol | string | no | The listener protocol. Valid values: TCP, UDP, and TCPSSL |
| Tag | string | no | The tags (JSON-encoded) |
| NextToken | string | no | The pagination token used to specify a particular page of results. Valid values: Leave this parameter empty for the first query or the… |
| MaxResults | integer | no | The number of entries to return in each call. Valid values: 1 to 100. Default value: 20 |
| RegionId | string | no | The ID of the region where the NLB instance is deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |
| SecSensorEnabled | string | no | Specifies whether to enable fine-grained monitoring. Valid values: true false |

### Queries the basic information about created Network Load Balancer (NLB) instances
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-load-balancers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerType | string | no | The type of load balancing. Only network is returned, which indicates Network Load Balancer (NLB) |
| ZoneId | string | no | The zone name. You can call the https://help.aliyun.com/document_detail/443890.html operation to query zones |
| VpcIds | string | no | The VPC ID of the NLB instance. You can query up to 10 VPC IDs at a time (JSON-encoded) |
| AddressType | string | no | The IPv4 address type of the NLB instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain… |
| AddressIpVersion | string | no | The protocol version. Valid values: ipv4: IPv4. DualStack: dual-stack |
| Ipv6AddressType | string | no | The IPv6 address type of the NLB instance. Valid values: Internet: The load balancing instance has a public IP address. The DNS domain… |
| DNSName | string | no | The DNS domain name |
| LoadBalancerStatus | string | no | The status of the NLB instance. Valid values: Inactive: The instance is stopped. Listeners of the instance no longer forward traffic.… |
| LoadBalancerBusinessStatus | string | no | The business status of the NLB instance. Valid values: Abnormal: The instance is in an abnormal state. Normal: The instance is in a normal… |
| LoadBalancerNames | string | no | The names of the NLB instances. You can query up to 20 instance names at a time (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| LoadBalancerIds | string | no | The IDs of the NLB instances. You can query up to 20 instances at a time (JSON-encoded) |
| Tag | string | no | The labels of the NLB instance (JSON-encoded) |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. Valid values: If this is the first request or no… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Queries the TLS security policies set for a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| SecurityPolicyIds | string | no | The IDs of the TLS security policies. You can specify at most 20 policy IDs in each call (JSON-encoded) |
| SecurityPolicyNames | string | no | The names of the TLS security policies. You can specify at most 20 policy names (JSON-encoded) |
| Tag | string | no | The tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this… |
| MaxResults | integer | no | The number of entries to return per page. Valid values: 1 to 100. Default value: 20 |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Queries servers in a server group of a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-server-group-servers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupId | string | no | The ID of the server group |
| ServerIds | string | no | The IDs of the backend servers. You can specify up to 40 backend servers in each call (JSON-encoded) |
| ServerIps | string | no | The IP addresses of the backend servers. You can specify up to 40 backend servers in each call (JSON-encoded) |
| NextToken | string | no | The pagination token used to specify a particular page of results. Valid values: Left this parameter empty if this is the first query or… |
| MaxResults | integer | no | The number of entries to return in each call. Valid values: 1 to 100. Default value: 20 |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Queries the server group list of a Network Load Balancer (NLB) load balancing instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-server-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupIds | string | no | The server group IDs. You can query up to 20 server group IDs at a time (JSON-encoded) |
| ServerGroupNames | string | no | The server group names. You can query up to 20 server group names at a time (JSON-encoded) |
| ResourceGroupId | string | no | The ID of the resource group to which the server group belongs |
| ServerGroupType | string | no | The type of the server group. Valid values: Instance: server type. This type of server group supports adding Ecs, Ens, and Eci instances.… |
| VpcId | string | no | The ID of the VPC to which the server group belongs |
| Tag | string | no | The tags (JSON-encoded) |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this… |
| MaxResults | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 20 |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) load balancing instance. You can invoke the… |

### Queries the default TLS policy
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-system-security-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Queries the tags of a resource
`POST https://apizie.tech/v1/cloud:aliyun-nlb/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ResourceType | string | yes | The type of the resource. Valid values: loadbalancer: the Network Load Balancer (NLB) instance securitypolicy: the security policy… |
| ResourceId | string | no | The IDs of the resources (JSON-encoded) |
| Tag | string | no | The tags (JSON-encoded) |
| NextToken | string | no | The pagination token used to specify a particular page of results. Valid values: Leave this parameter empty for the first query or the… |
| MaxResults | integer | no | The number of entries to return in each call. Valid values: 1 to 50. Default value: 50 |
| RegionId | string | no | You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent region list |

### Associates a security group with a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/load-balancer-join-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| SecurityGroupIds | string | yes | The security group ID of the instance (JSON-encoded) |
| LoadBalancerId | string | yes | The ID of the NLB instance which you want to add to a security group |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: prechecks the request without performing… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Disassociates a Network Load Balancer (NLB) instance from a security group
`POST https://apizie.tech/v1/cloud:aliyun-nlb/load-balancer-leave-security-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| SecurityGroupIds | string | yes | The ID of the security group to be disassociated (JSON-encoded) |
| LoadBalancerId | string | yes | The NLB instance ID |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: checks the request without performing the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Modify the group of resource
`POST https://apizie.tech/v1/cloud:aliyun-nlb/move-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| NewResourceGroupId | string | yes | The ID of the new resource group |
| ResourceType | string | yes | The type of resource. Valid values: loadbalancer: a Network Load Balancer (NLB) instance securitypolicy: a security policy servergroup: a… |
| ResourceId | string | yes | The ID of the resource |
| RegionId | string | yes | The region ID of the resource |

### Deletes server groups from a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/remove-servers-from-server-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupId | string | yes | The server group ID |
| Servers | string | yes | The backend servers. You can specify up to 200 backend servers in each call (JSON-encoded) |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks the… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the token is… |
| RegionId | string | no | The ID of the region where the NLB instance is deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |

### Configures storage for fine-grained monitoring
`POST https://apizie.tech/v1/cloud:aliyun-nlb/set-hd-monitor-region-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/2399192.html operation to query the most… |
| LogProject | string | yes | The name of the Log Service project |
| MetricStore | string | yes | The name of the MetricStore in Simple Log Service |

### Enables a Network Load Balancer (NLB) listener
`POST https://apizie.tech/v1/cloud:aliyun-nlb/start-listener` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The listener ID |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs only a dry run. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Removes the elastic IP address (EIP) or virtual IP address (VIP) used in a zone from the DNS record
`POST https://apizie.tech/v1/cloud:aliyun-nlb/start-shift-load-balancer-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ZoneMappings | string | yes | The mappings between zones and vSwitches. You can remove only one IP address (or zone) in each call (JSON-encoded) |
| LoadBalancerId | string | yes | The NLB instance ID |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs only a dry run. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Stops a listener of a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/stop-listener` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The listener ID |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs a dry run without performing the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Adds tags to specified resources
`POST https://apizie.tech/v1/cloud:aliyun-nlb/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The IDs of the resources. You can specify up to 50 resource IDs in each call (JSON-encoded) |
| Tag | string | yes | The tags (JSON-encoded) |
| ResourceType | string | yes | The type of the resources. Valid values: loadbalancer: the Network Load Balancer (NLB) instance securitypolicy: the security policy… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks the… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the token is… |
| RegionId | string | no | The ID of the region where the resources are deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |

### Removes tags from resources
`POST https://apizie.tech/v1/cloud:aliyun-nlb/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ResourceId | string | yes | The ID of the resource. You can specify at most 50 resource IDs in each call (JSON-encoded) |
| TagKey | string | no | The keys of the tags that you want to remove. You can remove at most 20 tags in each call (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags from the specified resource. Valid values: true: removes all tags from the specified resource. false… |
| ResourceType | string | yes | The type of the resource. Valid values: loadbalancer: a Network Load Balancer (NLB) instance securitypolicy: a security policy… |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs a dry run. The system checks the… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the resource. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Updates the attributes of a listener, such as the name and the idle connection timeout period
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-listener-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ListenerId | string | yes | The listener ID |
| ListenerDescription | string | no | The name of the listener. The name must be 2 to 256 characters in length, and can contain letters, digits, commas (,), periods (.),… |
| ServerGroupId | string | no | The server group ID. If the listener uses TCP, you can specify server groups whose protocol is TCP or TCP_UDP. UDP server groups are not… |
| SecurityPolicyId | string | no | The ID of the security policy. This parameter takes effect only for listeners that use SSL over TCP |
| CertificateIds | string | no | The server certificate. Only one server certificate is supported. This parameter takes effect only for listeners that use SSL over TCP… |
| CaCertificateIds | string | no | The CA certificate. You can specify only one CA certificate. This parameter takes effect only for listeners that use SSL over TCP… |
| CaEnabled | string | no | Specifies whether to enable mutual authentication. Valid values: true false |
| IdleTimeout | integer | no | The timeout period for idle connections. Unit: seconds If the listener uses TCP or TCPSSL, you can set this parameter to a value ranging… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks the… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the token is… |
| RegionId | string | no | The ID of the region where the NLB instance is deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |
| ProxyProtocolEnabled | string | no | Specifies whether to use the Proxy protocol to pass the client IP address to the backend server. Valid values: true false |
| SecSensorEnabled | string | no | Specifies whether to enable fine-grained monitoring. Valid values: true false |
| AlpnEnabled | string | no | Specifies whether to enable Application-Layer Protocol Negotiation (ALPN). Valid values: true false |
| AlpnPolicy | string | no | The name of the ALPN policy. The following are the possible values: HTTP1Only: Negotiate only HTTP/1.*. The ALPN preference list is… |
| Cps | integer | no | The maximum number of new connections per second supported by the listener in each zone (virtual IP address). Valid values: 0 to 1000000.… |
| Mss | integer | no | The size of the largest TCP packet segment. Unit: bytes. Valid values: 0 to 1500. 0 indicates that the maximum segment size (MSS) remains… |
| ProxyProtocolV2Config | string | no | Specifies that the Proxy protocol passes the VpcId, PrivateLinkEpId, and PrivateLinkEpsId parameters to backend servers (JSON-encoded) |

### Changes the network type of the IPv4 address for a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-load-balancer-address-type-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The ID of the NLB instance |
| AddressType | string | yes | The new network type. Valid values: Internet: The nodes of an Internet-facing NLB instance have public IP addresses. The DNS name of an… |
| ZoneMappings | string | no | The mappings between zones and vSwitches. You can specify up to 10 zones (JSON-encoded) |
| DryRun | string | no | Perform a dry run without actually making the request. Valid values are: true: Perform only a dry run. The system checks the request for… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate this value. Ensure that the value is… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |

### Updates the attributes, including the name, of a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-load-balancer-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The NLB instance ID |
| LoadBalancerName | string | no | The NLB instance name. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and… |
| CrossZoneEnabled | string | no | Specifies whether to enable cross-zone load balancing for the NLB instance. Valid values: true false |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs only a dry run. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the… |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |
| Cps | integer | no | The maximum number of new connections per second in each zone supported by the NLB instance (virtual IP address). Valid values: 1 to 1000000 |

### create operation
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-load-balancer-protection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| DeletionProtectionEnabled | string | no | The DeletionProtectionEnabled |
| DeletionProtectionReason | string | no | The DeletionProtectionReason |
| ModificationProtectionStatus | string | no | The ModificationProtectionStatus |
| ModificationProtectionReason | string | no | The ModificationProtectionReason |
| LoadBalancerId | string | yes | The LoadBalancerId |
| DryRun | string | no | The DryRun |
| ClientToken | string | no | The ClientToken |
| RegionId | string | no | The RegionId |

### Modifies the zones and zone attributes of a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-load-balancer-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| LoadBalancerId | string | yes | The ID of the NLB instance |
| ZoneMappings | string | yes | The mappings between the zones and the vSwitches. You can specify up to 10 zones (JSON-encoded) |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks the… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the token is… |
| RegionId | string | no | The ID of region where the NLB instance is deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |

### Modifies the configurations of a security policy for a Network Load Balancer (NLB) instance
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-security-policy-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| TlsVersions | string | no | The supported TLS versions. Valid values: TLSv1.0, TLSv1.1, TLSv1.2, and TLSv1.3. You can specify up to four TLS versions (JSON-encoded) |
| SecurityPolicyId | string | yes | The ID of the TLS security policy |
| SecurityPolicyName | string | no | The name of the security policy. The name must be 1 to 200 characters in length, and can contain letters, digits, periods (.), underscores… |
| Ciphers | string | no | The cipher suites supported by the security policy. Valid values of this parameter vary based on the value of TlsVersions. You can specify… |
| RegionId | string | no | The ID of the region where the NLB instance is deployed. You can call the https://help.aliyun.com/document_detail/443657.html operation to… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: validates the request without performing the operation. The system checks the… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate the token. Ensure that the token is… |

### Updates the configuration of a Network Load Balancer (NLB) server group
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-server-group-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupId | string | yes | The ID of the server group |
| ServerGroupName | string | no | The new name of the server group. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It… |
| ConnectionDrainEnabled | string | no | Specifies whether to enable connection draining. Valid values: true: enables connection draining. false: disables connection draining |
| ConnectionDrainTimeout | integer | no | The timeout period for connection draining. Unit: seconds. Valid values: 0 to 900 |
| Scheduler | string | no | The scheduling algorithm. Valid values: Wrr: weighted round-robin. Backend servers with higher weights receive more requests. Wlc:… |
| IpVersionAffinityMode | string | no | The traffic scheduling policy in dual-stack mode. Valid values: NonAffinity (default): non-affinity mode. Requests are forwarded to… |
| PreserveClientIpEnabled | string | no | Specifies whether to enable client IP preservation. Valid values: true: enables client IP preservation. false: disables client IP… |
| HealthCheckConfig | string | no | The health check configuration (JSON-encoded) |
| RegionId | string | no | The region ID of the Network Load Balancer (NLB) instance. You can call the https://help.aliyun.com/document_detail/443657.html operation… |
| DryRun | string | no | Specifies whether to perform a dry run. Valid values: true: performs a dry run and does not update the server group. The system checks… |
| ClientToken | string | no | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make… |

### Modifies the weights and descriptions of backend servers in a server group of a Network Load Balancer (NLB)…
`POST https://apizie.tech/v1/cloud:aliyun-nlb/update-server-group-servers-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |
| ServerGroupId | string | yes | The server group ID |
| Servers | string | yes | The backend servers. You can specify at most 200 backend servers in each call (JSON-encoded) |
| RegionId | string | no | The region ID of the NLB instance. You can call the https://help.aliyun.com/document_detail/443657.html operation to query the most recent… |
| DryRun | string | no | Specifies whether to perform a dry run, without sending the actual request. Valid values: true: performs only a dry run. The system checks… |
| ClientToken | string | no | The client token used to ensure the idempotence of the request. You can use the client to generate this value. Ensure that the value is… |

### version
`POST https://apizie.tech/v1/cloud:aliyun-nlb/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://nlb.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-nlb/add-servers-to-server-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Network Load Balancer API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-nlb/add-servers-to-server-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Network Load Balancer API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Network Load Balancer itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Network Load Balancer API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-nlb.

### What is the status of the Alibaba Cloud Network Load Balancer API?
Needs your own provider key (bring your own key)