UpdateVpcEndpointZoneConnectionResourceAttribute - PrivateLink

Modifies a service resource of a zone to which an endpoint connection belongs.

Operation description

Prerequisites

By default, the feature of modifying a service resource of a zone to which an endpoint connection belongs is unavailable. To use this feature, log on to the Quota Center console. Click Whitelist Quotas in the left-side navigation pane and click PrivateLink in the Networking section. On the page that appears, search for privatelink_whitelist/svc_res_mgt_uat and click Apply in the Actions column.

Usage notes

If the endpoint connection is in the Disconnected state, you can manually allocate the service resource in the zone.
If the endpoint connection is in the Connected state, you can manually migrate the service resource in the zone. In this case, the connection might be interrupted.
UpdateVpcEndpointZoneConnectionResourceAttribute 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 GetVpcEndpointServiceAttribute operation to check whether the service resource is modified.
- If the endpoint service is in the Pending state, the service resource is being modified.
- If the endpoint service is in the Active state, the service resource is modified.
You cannot repeatedly call the UpdateVpcEndpointZoneConnectionResourceAttribute operation to modify a service resource in the zone to which an endpoint connection belongs within a specified period of time.

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:UpdateVpcEndpointZoneConnectionResourceAttribute

update

*VpcEndpointService

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

*LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint connection whose bandwidth you want to modify. 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 token can contain 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 message 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, a 2xx HTTP status code is returned and the operation is performed.	false
ServiceId	string	Yes	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
EndpointId	string	Yes	The endpoint ID.	ep-hp33b2e43fays7s8****
ZoneId	string	Yes	The zone ID.	cn-hangzhou-b
ResourceAllocateMode	string	No	The resource allocation mode. You can change the resource allocation mode only if the endpoint connection is in the Disconnected state. Valid values: Auto: automatically and randomly allocates service resources. In this mode, the specified service resource is deleted. Manual: manually allocates service resources. If you set the value to Manual, you must also specify the ResourceId and ResourceType parameters.	Auto
ResourceReplaceMode	string	No	The migration mode of the service resource. Valid values: Graceful: smooth migration. Service resources in the zone are smoothly migrated. Force: forced migration. Service resources in the zone are forcefully migrated. Note You need to specify this parameter only if you want to migrate service resources and the endpoint connection is in the Connected state. If you specify this parameter, you must also specify the ResourceId and ResourceType parameters.	Graceful
ResourceType	string	No	The type of the service resource. Valid values: slb: a CLB instance that supports PrivateLink. In addition, the CLB instance is deployed in a VPC. alb: an Application Load Balancer (ALB) instance that supports PrivateLink. In addition, the ALB instance is deployed in a VPC. Note If ResourceAllocateMode is set to Mannual, or ResourceReplaceMode is set, this parameter is required.	slb
ResourceId	string	No	The ID of the service resource that you want to manually allocate or migrate in the zone where the endpoint connection is deployed. Note If ResourceAllocateMode is set to Mannual, or ResourceReplaceMode is set, this parameter is required.	lb-hp32z1wp5peaoox2q****
RegionId	string	Yes	The region ID of the endpoint connection whose bandwidth you want to modify. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

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	EndpointServiceLocked	The specified Service is locked.	The specified Service is locked.
400	EndpointLocked	The specified Endpoint is locked.	The specified Endpoint is locked.
400	EndpointZoneNotFound	The specified zone of Endpoint does not exist.	The specified zone of Endpoint does not exist.
400	EndpointServiceResourceTypeNotSupport	The specified resource type is not supported.	The specified resource type is not supported.
400	EndpointServiceResourceNotFound	The specified service resource is not found.
400	ZoneOperationDenied	You cannot operate the specified zone.	You cannot operate the specified zone.
400	IllegalParam.ResourceAllocateMode	The param of %s is illegal.
400	IllegalParam.ResourceReplaceMode	The param of %s is illegal.
400	MissingParam.ResourceId	The param of %s is missing.	Missing parameter ResourceId.
400	MissingParam.ResourceAllocateMode	The param of %s is missing.	Missing ResourceAllocateMode parameter.
400	OperationDenied.CurrentResourceAutoAllocated	The operation is not allowed because of CurrentResourceAutoAllocated.	The operation is denied because auto allocation is not disabled for the resource in the zone.
400	Mismatch.ZoneId	The %s is mismatched for %s and %s.
400	GatewayLoadBalancerNotSupportZoneConnection	The gateway load balancer not support zone connection.	Gateway-based load balancing type does not support operational zone connection

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.