All Products
Search

This Product

    PrivateLink:UpdateVpcEndpointZoneConnectionResourceAttribute

    Document Center

    PrivateLink:UpdateVpcEndpointZoneConnectionResourceAttribute

    Last Updated:Feb 27, 2024

    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.

    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:UpdateVpcEndpointZoneConnectionResourceAttributeWrite
    • VpcEndpointService
      acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#vpcendpointserviceId}
    • LoadBalancer
      acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    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
    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****
    EndpointIdstringYes

    The endpoint ID.

    		ep-hp33b2e43fays7s8****
    ZoneIdstringYes

    The zone ID.

    		cn-hangzhou-b
    ResourceAllocateModestringNo

    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
    ResourceReplaceModestringNo

    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
    ResourceTypestringNo

    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
    ResourceIdstringNo

    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****

    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
    400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.
    400EndpointConnectionNotFoundThe specified endpoint connection does not exist.The specified endpoint connection does not exist.
    400EndpointConnectionOperationDeniedThe endpoint is being connected.The endpoint is being connected.
    400EndpointNotFoundThe specified Endpoint does not exist.The specified Endpoint does not exist.
    400EndpointServiceLockedThe specified Service is locked.The specified Service is locked.
    400EndpointLockedThe specified Endpoint is locked.The specified Endpoint is locked.
    400EndpointZoneNotFoundThe specified zone of Endpoint does not exist.The specified zone of Endpoint does not exist.
    400EndpointServiceResourceTypeNotSupportThe specified resource type is not supported.The specified resource type is not supported.
    400EndpointServiceResourceNotFoundThe specified service resource is not found.-
    400ZoneOperationDeniedYou cannot operate the specified zone.You cannot operate the specified zone.
    400IllegalParam.ResourceAllocateModeThe param of %s is illegal.-
    400IllegalParam.ResourceReplaceModeThe param of %s is illegal.-
    400MissingParam.ResourceIdThe param of %s is missing.-
    400MissingParam.ResourceAllocateModeThe param of %s is missing.-
    400OperationDenied.CurrentResourceAutoAllocatedThe operation is not allowed because of CurrentResourceAutoAllocated.-
    400Mismatch.ZoneIdThe %s is mismatched for %s and %s.-

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

    Change history

    Change timeSummary of changesOperation
    2023-12-21The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400