Update PrivateLink Endpoint Service Attributes - PrivateLink - Alibaba Cloud - PrivateLink

Calls the UpdateVpcEndpointServiceAttribute operation to modify the attributes of an endpoint service.

Operation description

Before you modify the attributes of an endpoint service, make sure that the endpoint service is in the Active state. You can call the GetVpcEndpointServiceAttribute operation to query the endpoint service status.
The UpdateVpcEndpointServiceAttribute operation does not support concurrent modification of endpoint service 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:UpdateVpcEndpointServiceAttribute

update

*VpcEndpointService

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint service. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
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 ClientToken parameter supports only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, 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): performs a dry run and performs the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the resource attributes are modified.	false
ServiceId	string	Yes	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
ServiceDescription	string	No	The description of the endpoint service.	This is my EndpointService.
AutoAcceptEnabled	boolean	No	Specifies whether to automatically accept endpoint connections. Valid values: true: automatically accepts endpoint connections. false: does not automatically accept endpoint connections.	false
ConnectBandwidth	integer	No	The default bandwidth limit. Default value: 3072. Unit: Mbit/s. Valid values: 100 to 10240. Note Settings for the default bandwidth limit are supported when the service resource is a Classic Load Balancer (CLB) instance or an Application Load Balancer (ALB) instance. When the service resource is a Network Load Balancer (NLB) instance, the connection bandwidth cannot be configured.	3072
ZoneAffinityEnabled	boolean	No	Specifies whether to resolve the domain name of the endpoint that is connected to the endpoint service to the nearest access point. Valid values: true (default): yes. false: no.	true
RegionId	string	Yes	The region ID of the endpoint service. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ServiceSupportIPv6 `deprecated`	boolean	No	Specifies whether the endpoint service supports IPv6. Valid values: true: yes. false (default): no.	false
AddressIpVersion	string	No	The protocol version. Valid values: IPv4: IPv4. DualStack: dual-stack. Note Currently, only endpoint services whose backend resource type is NLB or GWLB support setting the IP address protocol to DualStack.	IPv4
AddSupportedRegionSet	array	No	The list of remote regions to add for the endpoint service.
	string	No	The ID of the remote region to add for the endpoint service.	cn-huhehaote
DeleteSupportedRegionSet	array	No	The list of remote regions to remove from the endpoint service.
	string	No	The ID of the remote region to remove from the endpoint service.	cn-beijing

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	8D8992C1-6712-423C-BAC5-E5E817484C6B

Examples

Success response

JSON format

{
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B"
}

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	EndpointServiceLocked	The specified Service is locked.	The specified Service is locked.
400	EndpointServiceOperationDenied	The specified operation of endpoint service is not allowed.	The specified operation of endpoint service is not allowed.
400	IllegalParamFormat.%s	The param format of %s is illegal.	The parameter format of %s is illegal.
400	OperationDenied.PrivateServiceDomainBusinessStatus	The operation is not allowed because of PrivateServiceDomainBusinessStatus.
400	MissingParam.%s	The param of %s is missing.	The parameter %s is missing.
400	ServiceResourceNotSupportIpv6	The resource is not support ipv6.	The endpoint service does not support IPv6.
400	EndpointServiceDowngradeNotAllowed	The EndpointService is not allowed for downgrade.	The endpoint service is not allowed to be downgraded.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
400	Conflict.ServiceName	The ServiceName %s is conflict.
400	InvalidParam.PrivateDnsName	The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.	The specified resource type does not support dualstack.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.	The endpoint service and service resource AddressIpVersion do not match.
400	EndpointServiceConnectionDependence	There are connections between the endpoint service and the dualstack endpoint, the endpoint service address ip version not support switching from dualstack to ipv4.	There are connections between the endpoint service and the dualstack endpoint, the endpoint service address ip version not support switching from dualstack to ipv4.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.