UpdateVpcEndpointServiceResourceAttribute - PrivateLink - Alibaba Cloud Documentation Center

Operation description

Before you modify the properties of a service resource, ensure that the endpoint service is in the Active state. You can call the GetVpcEndpointServiceAttribute operation to query the status of the endpoint service.
The UpdateVpcEndpointServiceResourceAttribute operation does not support concurrent modifications to the properties of service resources that belong to the same endpoint service.

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

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 ID of the region where you want to modify the service resource. Call the DescribeRegions operation to obtain the region ID.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to ensure that the value is unique among different requests. ClientToken can contain only ASCII characters.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a check request without modifying the properties of the service resource. The system checks the required parameters, request format, and service limits. If the request fails the check, an error is returned. If the request passes the check, 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****
ResourceId	string	Yes	The ID of the service resource.	lb-hp32z1wp5peaoox2q****
ZoneId	string	No	The zone where the service resource is located. This parameter is required if the service resource is an Application Load Balancer (ALB), a Network Load Balancer (NLB), or a Gateway Load Balancer (GWLB).	cn-hangzhou-i
AutoAllocatedEnabled	boolean	Yes	Specifies whether to enable automatic resource allocation. Valid values: true: Enables automatic resource allocation. false: Disables automatic resource allocation.	true
RegionId	string	Yes	The ID of the region where you want to modify the service resource. Call the DescribeRegions operation to obtain the region ID.	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	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	EndpointServiceResourceNotFound	The specified service resource is not found.
400	ResourceAutoAllocateViolation	The specified endpoint service must have at least one automatically allocated resource in one zone.	The specified endpoint service must have at least one automatically allocated resource in one zone.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.