Updates the attributes of a Gateway Load Balancer (GWLB) instance.
Operation description
-
UpdateLoadBalancerAttribute is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the GetLoadBalancerAttribute operation to query the status of the GWLB instance.
- If the GWLB instance is in the Configuring state, the GWLB instance is being modified.
- If the GWLB instance is in the Active state, the GWLB instance is modified.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
gwlb:UpdateLoadBalancerAttribute | update |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
LoadBalancerId | string | Yes | The GWLB instance ID. | gwlb-9njtjmqt7zfcqm**** |
LoadBalancerName | string | No | The GWLB instance name. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter. | testGwlbName |
DryRun | boolean | No | Specifies whether to perform a dry run, without performing the actual request. Valid values:
| false |
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 sure that the token is unique among different requests. The client token can contain only ASCII characters. Note
If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
| 123e4567-e89b-12d3-a456-426655440000 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "B956C629-0E8C-5EFF-BAC1-B0E3A8C5CBDD"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IncorrectBusinessStatus.LoadBalancer | The business status of %s [%s] is incorrect. | Resource %s with business state %s does not support current operation |
400 | IncorrectStatus.LoadBalancer | The status of %s [%s] is incorrect. | Resource %s current state %s does not support operation |
400 | ResourceNotFound.LoadBalancer | The specified resource of %s is not found. | The specified resource of .LoadBalancer is not found. |
For a list of error codes, visit the Service error codes.