1. Interface Description
Interface request domain name: clb.api3.convergecloud.com.
This API is used to support setting (binding/unbinding) security groups for a public network CLB instance. You can use the DescribeLoadBalancers API to query the currently bound security groups of a CLB instance. This API is a semantic API.
When binding is performed, input parameters should include all security groups (existing and newly bound ones) that should be bound to CLB instances.
When unbinding is performed, input parameters should include all security groups that remain bound after unbinding. If you want to unbind all security groups, this parameter can be left unspecified, or an empty array can be passed in.
Default interface request rate limit: 20 times per second.
Interface update time: 2020-01-10 20:30:50.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: SetLoadBalancerSecurityGroups |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-03-17 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LoadBalancerId | Yes | No | String | CLB instance ID Example: lb-cuxw2r00 |
| SecurityGroups | No | No | Array of String | Array of security group IDs. One CLB instance can bind up to 50 security groups. To unbind all security groups, you can either skip this parameter or specify an empty array. Example: ["sg-0936o7sd","sg-dfsv32sx"] |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidParameterValue | Incorrect parameter value |
| InternalError | Internal Error |
| UnauthorizedOperation | Unauthorized operation |
| FailedOperation | Failed to operate. |
| InvalidParameter.LBIdNotFound | CLB instance ID error. |
| InvalidParameter.FormatError | Incorrect parameter format |
| InvalidParameterValue.Length | Invalid parameter length. |