UpdateVpcEndpointConnectionAttribute - PrivateLink - Alibaba Cloud Documentation Center

Modifies the attributes of an endpoint connection.

Operation description

You cannot concurrently call the UpdateVpcEndpointConnectionAttribute operation to modify the bandwidth of endpoint connections that belong to the same Alibaba Cloud account.

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

privatelink:UpdateVpcEndpointConnectionAttribute

update

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the endpoint connection is deployed. Call the DescribeRegions operation to obtain the region ID.	eu-west-1
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Make sure that the client token is unique for each request. The ClientToken parameter can contain only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends a normal request. After the request passes the check, an HTTP 2xx status code is returned and the operation is performed.	false
ServiceId	string	Yes	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
EndpointId	string	Yes	The ID of the endpoint.	ep-hp33b2e43fays7s8****
Bandwidth	integer	No	The bandwidth of the endpoint connection. Unit: Mbps. Note If the backend resource is an Application Load Balancer (ALB) or a Classic Load Balancer (CLB), the value ranges from 100 Mbps to 10,240 Mbps. If the backend resource is a Network Load Balancer (NLB), the value ranges from 100 Mbps to 25 Gbps.	3072
RegionId	string	Yes	The ID of the region where the endpoint connection is deployed. Call the DescribeRegions operation to obtain the region ID.	eu-west-1
TrafficControlMode	string	No	Scalability: automatic scaling. In this mode, the bandwidth that is set for the endpoint connection is not in effect. BandwidthLimit: a bandwidth cap. In this mode, you can specify a bandwidth cap for the endpoint connection. The bandwidth cap is the value of Bandwidth. Note If the service resource is an NLB, the default value of TrafficControlMode is Scalability. Set TrafficControlMode to BandwidthLimit and specify Bandwidth to set a bandwidth cap. If the service resource is a CLB, TrafficControlMode can be set only to BandwidthLimit. This indicates that the service consumer provides a default rate limit for each endpoint. If the service resource is a Gateway Load Balancer (GWLB), TrafficControlMode can be set only to Scalability.	BandwidthLimit

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Success response

JSON format

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.
400	EndpointConnectionNotFound	The specified endpoint connection does not exist.	The specified endpoint connection does not exist.
400	EndpointConnectionOperationDenied	The endpoint is being connected.	The endpoint is being connected.
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.
400	OperationDenied.VpcNatServiceResourceTypeNotSupportBandwidth	The operation is not allowed because of VpcNatServiceResourceTypeNotSupportBandwidth.
400	UpdateBandWidthUnSupported	Bandwidth updates are not supported for this service.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.