All Products
Search

This Product

    PrivateLink:UpdateVpcEndpointAttribute

    Document Center

    PrivateLink:UpdateVpcEndpointAttribute

    Last Updated:Feb 27, 2024

    Modifies the attributes of an endpoint.

    Operation description

    You cannot repeatedly call the UpdateVpcEndpointAttribute operation to modify the attributes of an endpoint 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:UpdateVpcEndpointAttributeWrite
    • VpcEndpoint
      acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the endpoint whose attributes you want to modify. You can call the DescribeRegions operation to query the most recent region list.

    		eu-west-1
    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.

    		0ED8D006-F706-4D23-88ED-E11ED28DCAC0
    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.
    		true
    EndpointIdstringYes

    The endpoint ID whose attributes you want to modify.

    		ep-hp33b2e43fays7s8****
    EndpointNamestringNo

    The name of the endpoint.

    The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

    		test
    EndpointDescriptionstringNo

    The description of the endpoint.

    The description must be 2 to 256 characters in length. It cannot start with http:// or https://.

    		This is my Endpoint.

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		0ED8D006-F706-4D23-88ED-E11ED28DCAC0

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400OperationDenied.EndpointProtectedThe operation is not allowed because of EndpointProtected.-
    400EndpointNotFoundThe specified Endpoint does not exist.The specified Endpoint does not exist.
    400EndpointOperationDeniedThe specified operation of endpoint is not allowed.The specified operation of endpoint is not allowed.
    400EndpointLockedThe specified Endpoint is locked.The specified Endpoint is locked.
    400EndpointConnectionOperationDeniedThe endpoint is being connected.The endpoint is being connected.
    400EndpointServiceDeletedThe specified Service is already deleted.The specified Service is already deleted.
    400EndpointProtectedThe specified Endpoint is protected.-

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

    Change history

    Change timeSummary of changesOperation
    2023-09-26The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      delete Input Parameters: PolicyDocument
    2023-09-19The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2023-09-05The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: PolicyDocument