BindNlb-阿里云帮助中心

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sae:BindNlb

create

*All Resource

*

None

Request syntax

POST /pop/v1/sam/app/nlb HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	No	The ID of the target application.	7171a6ca-d1cd-4928-8642-7d5cfe69****
NlbId	string	No	The ID of the NLB instance.	nlb-7z7jjbzz44d82c9***
Listeners	string	No	The listeners, specified as a JSON-formatted string. Each listener object contains the following fields: Port: Integer. Required. The listener port. Valid values: 0 to 65535. TargetPort: Integer. Required. The port on the application instance that receives traffic. Valid values: 0 to 65535. Protocol: String. Required. The listener protocol. Valid values: `TCP`, `UDP`, and `TCPSSL`. CertIds: String. Optional. The server certificate IDs. This parameter is required only for `TCPSSL` listeners.
ZoneMappings	string	No	The mappings between zones and vSwitches, specified as a JSON-formatted string. You can add up to 10 zones. If the current region supports two or more zones, you must specify at least two zones. Each `ZoneMapping` object contains the following fields: VSwitchId: String. The ID of the vSwitch in the specified zone. Each zone can have only one vSwitch and one subnet. ZoneId, String, the zone ID of the Network Load Balancer instance.	vsw-sersdf**** cn-hangzhou-a
AddressType	string	No	The address type of the NLB instance. `Internet`: a public IP address. `Intranet`: a private IP address.	Internet

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	91F93257-7A4A-4BD3-9A7E-2F6EAE6D****
Message	string	The response message. A value of success is returned if the request is successful. If the request fails, an error message is returned.	success
TraceId	string	The request's trace ID, used for troubleshooting.	0a06dfe717389800573793090e0589
Data	object	The response data.
ChangeOrderId	string	The ID of the change order. You can use this ID to query the task status.	ba386059-69b1-4e65-b1e5-0682d9fa****
ErrorCode	string	The error code. This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes section.
Code	string	The HTTP status code. 2xx: Successful. 3xx: Redirection. 4xx: Client error. 5xx: Server error.	200
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "91F93257-7A4A-4BD3-9A7E-2F6EAE6D****",
  "Message": "success",
  "TraceId": "0a06dfe717389800573793090e0589",
  "Data": {
    "ChangeOrderId": "ba386059-69b1-4e65-b1e5-0682d9fa****"
  },
  "ErrorCode": "",
  "Code": "200",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.