All Products
Search

This Product

    PrivateLink:UpdateVpcEndpointServiceAttribute

    Document Center

    PrivateLink:UpdateVpcEndpointServiceAttribute

    Last Updated:Feb 27, 2024

    Modifies the attributes of an endpoint service.

    Operation description

    You cannot repeatedly call the UpdateVpcEndpointServiceAttribute operation to modify the attributes of an endpoint service that belongs to an Alibaba Cloud account within a specified period of time.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    privatelink:UpdateVpcEndpointServiceAttributeWrite
    • VpcEndpointService
      acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the endpoint service.

    You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou
    ClientTokenstringNo

    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
    DryRunbooleanNo

    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
    ServiceIdstringYes

    The endpoint service ID.

    		epsrv-hp3vpx8yqxblby3i****
    ServiceDescriptionstringNo

    The description of the endpoint service.

    		This is my EndpointService.
    AutoAcceptEnabledbooleanNo

    Specifies whether to automatically accept endpoint connection requests. Valid values:

    • true
    • false
    		false
    ConnectBandwidthintegerNo

    The default maximum bandwidth of the endpoint connection. Unit: Mbit/s. Default value: 3072.

    Valid values: 100 to 10240.

    Note You can specify this parameter only if you specify Classic Load Balancer (CLB) instances or Application Load Balancer (ALB) instances as service resources.
    		200
    ZoneAffinityEnabledbooleanNo

    Specifies whether to first resolve the domain name of the nearest endpoint that is associated with the endpoint service. Valid values:

    • true (default)
    • false
    		true
    ServiceSupportIPv6booleanNo

    Specifies whether to enable IPv6. Valid values:

    • true
    • false (default)
    		false

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned result.

    RequestIdstring

    The request ID.

    		8D8992C1-6712-423C-BAC5-E5E817484C6B

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.
    400EndpointServiceLockedThe specified Service is locked.The specified Service is locked.
    400EndpointServiceOperationDeniedThe specified operation of endpoint service is not allowed.The specified operation of endpoint service is not allowed.
    400IllegalParamFormat.%sThe param format of %s is illegal.The parameter format of %s is illegal.
    400OperationDenied.PrivateServiceDomainBusinessStatusThe operation is not allowed because of PrivateServiceDomainBusinessStatus.-
    400MissingParam.%sThe param of %s is missing.The parameter %s is missing.
    400ServiceResourceNotSupportIpv6The resource is not support ipv6.The endpoint service does not support IPv6.
    400EndpointServiceDowngradeNotAllowedThe EndpointService is not allowed for downgrade.The endpoint service is not allowed to be downgraded.
    400DependencyViolation.PrivateDnsNameThe specified resource of %s depends on %s, so the operation cannot be completed.-
    400OperationDenied.PrivateDomainNotSupportThe operation is not allowed because of PrivateDomainNotSupport.-
    400OperationDenied.PrivateDomainStatusNotSupportThe operation is not allowed because of %s.-
    400Conflict.ServiceNameThe ServiceName %s is conflict.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-19The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change