Use UpdateVpcEndpointAttribute to modify VPC endpoint properties - PrivateLink - Alibaba Cloud - PrivateLink

Modifies the attributes of an endpoint.

Operation description

The UpdateVpcEndpointAttribute operation does not support concurrent modification of endpoint attributes within 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:UpdateVpcEndpointAttribute

update

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint that you want to modify. You can call the DescribeRegions operation to query the most recent region list.	eu-west-1
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 token can contain only ASCII characters.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: sends a check request without performing the update gateway endpoint attribute operation. The system checks the request for potential issues, including missing parameter values, incorrect request format, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): sends a normal request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is performed.	true
EndpointId	string	Yes	The ID of the endpoint that you want to modify.	ep-hp33b2e43fays7s8****
EndpointName	string	No	The name of the endpoint. The name must be 2 to 128 characters in length, and can contain letters, digits, hyphens (-), and underscores (_). The name must start with a letter or a Chinese character.	test
EndpointDescription	string	No	The description of the endpoint. The description must be 2 to 256 characters in length and cannot start with `http://` or `https://`.	This is my Endpoint.
RegionId	string	Yes	The region ID of the endpoint that you want to modify. You can call the DescribeRegions operation to query the most recent region list.	eu-west-1
PolicyDocument	string	No	The RAM access policy. For more information about the policy definition, see Policy elements.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oss:List", "oss:PutObject", "oss:GetObject" ], "Resource": [ "acs:oss:oss-::pvl-policy-test/policy-test.txt" ], "Principal": { "RAM": [ "acs:ram::14199xxxxxx:" ] } } ] }
AddressIpVersion	string	No	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack. Note To enable dual-stack for the endpoint, the endpoint service connected to the endpoint and the VPC in which the endpoint resides must both support dual-stack.	IPv4
ZoneAffinityEnabled	boolean	No	Specifies whether to enable nearest access for the endpoint domain name of the connected service. Valid values: true: enabled. false: disabled.	false
ResetPolicy	boolean	No	Resets the policy to the default policy.	true
CrossRegionBandwidth	integer	No	The cross-region bandwidth. This parameter is required only when the endpoint and the endpoint service are in different regions. Unit: Mbit/s. Valid values: Minimum value: 100. Maximum value: limited by the quota of the current account. For more information, see Quotas and limits. Note Before you specify this parameter, make sure that the endpoint is a cross-region endpoint.	1000

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	OperationDenied.EndpointProtected	The operation is not allowed because of EndpointProtected.	Managed protection is enabled for the endpoint. Operation is not allowed.
400	EndpointNotFound	The specified Endpoint does not exist.	The specified Endpoint does not exist.
400	EndpointOperationDenied	The specified operation of endpoint is not allowed.	The specified operation of endpoint is not allowed.
400	EndpointLocked	The specified Endpoint is locked.	The specified Endpoint is locked.
400	EndpointConnectionOperationDenied	The endpoint is being connected.	The endpoint is being connected.
400	EndpointServiceDeleted	The specified Service is already deleted.	The specified Service is already deleted.
400	EndpointProtected	The specified Endpoint is protected.
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	OperationDenied.NotSupportDualStackSwitchToIpv4	AddressIpVersion does not support switching from DualStack to IPv4.	AddressIpVersion does not support switching from DualStack to IPv4.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.	The specified VSwitch does not support dualstack.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.	The specified parameter AddressIpVersion does not meet the requirements.