全部产品
Search
文档中心

私网连接 PrivateLink:UpdateVpcEndpointServiceAttribute - 修改终端节点服务的属性

更新时间:Dec 19, 2024

调用UpdateVpcEndpointServiceAttribute接口,修改终端节点服务的属性。

接口说明

  • 修改终端节点服务的属性之前,请确保终端节点服务处于 Active 状态,您可以通过调用 GetVpcEndpointServiceAttribute 接口,查询终端节点服务状态。
  • UpdateVpcEndpointServiceAttribute 接口不支持在同一个阿里云账号(主账号)下并发修改终端节点服务的属性。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
privatelink:UpdateVpcEndpointServiceAttributeupdate
*VpcEndpointService
acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

请求参数

名称类型必填描述示例值
RegionIdstring

终端节点服务所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会修改资源属性。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接修改资源属性。

false
ServiceIdstring

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
ServiceDescriptionstring

终端节点服务的描述信息。

This is my EndpointService.
AutoAcceptEnabledboolean

是否自动接受终端节点连接,取值:

  • true:自动接受终端节点连接。

  • false:不自动接受终端节点连接。

false
ConnectBandwidthinteger

默认连接带宽峰值。默认值:3072。单位:Mbps。

取值范围:100~10240

说明 当服务资源为传统型负载均衡 CLB 或应用型负载均衡 ALB 时,支持设置默认连接带宽峰值;当服务资源为网络型负载均衡 NLB 时,不支持设置连接带宽。
3072
ZoneAffinityEnabledboolean

是否支持连接服务的终端节点域名就近解析。取值:

  • true(默认值):是。
  • false:否。
true
ServiceSupportIPv6deprecatedboolean

终端节点服务是否支持 IPv6 功能。取值:

  • true:是。

  • false(默认值):否。

false
AddressIpVersionstring

协议版本。取值:

  • IPv4:IPv4 类型。
  • DualStack:双栈类型。
说明 目前仅后端资源类型为 nlb 的终端节点服务支持指定 IP 地址协议为 DualStack。
IPv4

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

8D8992C1-6712-423C-BAC5-E5E817484C6B

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400EndpointServiceNotFoundThe specified Service does not exist.当前终端节点服务不存在
400EndpointServiceLockedThe specified Service is locked.当前终端节点服务已经被锁定。
400EndpointServiceOperationDeniedThe specified operation of endpoint service is not allowed.终端节点服务处理中,不允许操作。
400IllegalParamFormat.%sThe param format of %s is illegal.指定的%s格式无效。请检查参数约束,并在修改后重试。
400OperationDenied.PrivateServiceDomainBusinessStatusThe operation is not allowed because of PrivateServiceDomainBusinessStatus.操作被拒绝,原因是自定义服务域名被禁用。
400MissingParam.%sThe param of %s is missing.参数%s缺失。
400ServiceResourceNotSupportIpv6The resource is not support ipv6.终端节点服务不支持IPv6
400EndpointServiceDowngradeNotAllowedThe EndpointService is not allowed for downgrade.终端节点服务不允许降级
400DependencyViolation.PrivateDnsNameThe specified resource of %s depends on %s, so the operation cannot be completed.资源%s依赖于%s,导致操作无法完成
400OperationDenied.PrivateDomainNotSupportThe operation is not allowed because of PrivateDomainNotSupport.由于%s,操作不支持
400OperationDenied.PrivateDomainStatusNotSupportThe operation is not allowed because of %s.由于%s,操作不支持
400Conflict.ServiceNameThe ServiceName %s is conflict.服务名称%s冲突
400InvalidParam.PrivateDnsNameThe parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.PrivateDnsName参数值非法,需要以aliyun.com, aliyun-inc.com,或者aliyuncs.com结尾。
400OperationDenied.ResourceTypeNotSupportDualStackThe specified resource type does not support dualstack.服务后端资源类型不支持双栈。
400OperationDenied.ServiceResourceIpVersionMismatchThe endpoint service and service resource AddressIpVersion do not match.终端节点服务与后端资源AddressIpVersion不匹配
400EndpointServiceConnectionDependenceThere are connections between the endpoint service and the dualstack endpoint, the endpoint service address ip version not support switching from dualstack to ipv4.终端节点服务与双栈终端节点之间存在连接,不支持双栈切到单栈。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-18OpenAPI 错误码发生变更查看变更详情
2024-09-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-03-11OpenAPI 错误码发生变更查看变更详情
2023-09-19OpenAPI 错误码发生变更查看变更详情