You need to enable JavaScript to run this app.
文档中心
私网连接

私网连接

复制全文
下载 pdf
终端节点服务
ModifyVpcEndpointServiceAttributes - 更新终端节点服务属性
复制全文
下载 pdf
ModifyVpcEndpointServiceAttributes - 更新终端节点服务属性
调用ModifyVpcEndpointServiceAttributes接口,修改指定终端节点服务的信息。​
使用说明​
终端节点服务已启用私有DNS名称且已关联启用了私有DNS名称的终端节点时,不支持修改参数PrivateDNSEnabled、PrivateDNSType和PrivateDNSName。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:ModifyVpcEndpointServiceAttributes​
要执行的操作,取值:ModifyVpcEndpointServiceAttributes。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
ServiceId String 必选 示例值:epsvc-2fe630gurkl37k5gfuy33****​
终端节点服务的ID。​
您可以调用DescribeVpcEndpointServices接口获取终端节点服务的ID。​
​
IpAddressVersions.N String 可选 示例值:ipv4​
终端节点服务的IP协议类型。​
  • ipv4​
  • ipv6:该取值正在邀测中,如需使用,请联系客户经理。​
说明​
  • 仅传入ipv4时,表示该终端节点服务转换为IPv4类型,仅支持提供IPv4服务。​
  • 同时传入ipv4和ipv6时,表示该终端节点服务转换为双栈类型,支持提供IPv4和IPv6服务,系统自动为其分配IPv6地址。​
  • 如需传入ipv6,请确保满足以下条件:​
  • 已开通私网连接服务的IPv6功能。​
  • 指定的服务资源支持双栈。​
  • 目前不支持仅传入ipv6。​
  • 不更改该参数取值时,保持原有配置不变。​
​
AutoAcceptEnabled Boolean 可选 示例值:false​
是否自动接受终端节点连接。​
  • true:终端节点服务自动接受终端节点连接。​
​
PrivateDNSEnabled Boolean 可选 示例值:false​
是否为终端节点服务启用私有DNS名称。​
  • false:不启用。​
  • true:启用。​
​
PrivateDNSType String 可选 示例值:public​
私有DNS名称的域名类型。​
  • public:公网。​
说明​
参数PrivateDNSEnabled取值为true时,该参数生效。​
​
PrivateDNSName String 可选 示例值:www.example.com​
私有DNS名称,即通过私网连接访问服务时希望使用的自定义域名,仅支持公网域名。​
公网域名不支持传入已配置全局解析的内网域名,以及私网连接使用的域名(包括终端节点服务域名和终端节点域名)。​
说明​
  • 参数PrivateDNSEnabled取值为true时,必须传入该参数。​
  • 若传入的域名为泛域名 *.www.example.com,则该泛域名及其根域名 www.example.com 均支持解析。​
​
Description String 可选 示例值:endpoint service​
终端节点服务的描述信息。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
  • 不更改该参数取值时,保持原有配置不变。​
​
AddSupportedRegions.N String 可选 示例值:cn-beijing​
增加终端节点服务发布的地域。​
​
RemoveSupportedRegions.N String 可选 示例值:cn-shanghai​
移除终端节点服务发布的地域。​
​
​
​
返回参数​
RequestId String 示例值:0ED8D006-F706-4D23-88ED-E11ED28D****​
请求ID。​
​
​
​
请求示例​
​
GET /?Action=ModifyVpcEndpointServiceAttributes&Version=2020-04-01&ServiceId=epsvc-2fe630gurkl37k5gfuy33**** HTTP/1.1​
Host: privatelink.cn-guangzhou.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-guangzhou/privatelink/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",​
"Action": "ModifyVpcEndpointServiceAttributes",​
"Version": "2020-04-01",​
"Service": "privatelink",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****"​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如XXX。​
说明​
其中,XXX表示缺少的参数名称。​
400​
InvalidDescription.Malformed​
The specified Description is malformed.​
指定的Description参数格式不合法。​
400​
InvalidEndpointService.InvalidStatus​
The specified EndpointService is not in the correct status for the request.​
指定的终端节点服务所处的状态无法响应该请求。​
400​
ErrInterfaceNotSupportedResourceType​
The Interface does not support the resource type.​
终端节点服务接口不支持操作该服务资源类型。​
400​
InvalidPrivateDNSEnable.InUse​
The specified PrivateDNS is being occupied by Endpoint of the EndpointService.​
指定的私有 DNS 正在被终端节点服务下的终端节点占用。​
400​
InvalidPrivateDNSEnabled.PrivateDNSNameMismatch​
The specified PrivateDNSEnabled and PrivateDNSName are mismatched.​
指定的参数私有DNS是否开启与私有DNS名称无法匹配。​
400​
InvalidPrivateDNSName.Malformed​
The specified PrivateDNSName is malformed.​
指定的 PrivateDNSName 参数格式不合法。​
400​
InvalidEndpointService.InvalidLock​
The operation is refused by the endpoint service.​
终端节点服务无法支持该操作。​
400​
InvalidPrivateDNSEnabled.PrivateDNSTypeMismatch​
The specified PrivateDNSEnabled and PrivateDNSType are mismatched.​
指定的参数 私有DNS是否启用 与 私有DNS类型 无法匹配。​
400​
InvalidPrivateDNSType.Malformed​
The specified PrivateDNSType is malformed.​
指定的 PrivateDNSType 参数格式不合法。​
400​
ErrPrivateLinkServiceNotSupportedZone​
The PrivateLink service does not support the zone.​
终端节点服务不支持添加该可用区的服务资源。​
400​
InvalidIpAddressVersions.Conflict​
The specified IpAddressVersions parameter is duplicated.​
指定的IpAddressVersions重复。​
400​
InvalidIpAddressVersions.Malformed​
The specified IpAddressVersions is malformed.​
指定的 IpAddressVersions 参数格式不合法。​
400​
InvalidModifyConnectedDualStackEpsvcIPVersion.Conflict​
There are still existing dualstack endpoints on the specified EndpointService instance.​
当前终端节点服务上仍有存量连接,暂不支持更改。​
400​
InvalidServiceResource.Malformed​
The specified ServiceResource is malformed.​
指定的 ServiceResource 参数格式不合法。​
400​
InvalidServiceResourceStatus.IPVersionMismatch​
The specified service resource can not support the EndpointService ipAddressVersion that you want.​
当前服务资源不支持所指定的终端节点服务IP地址类型。​
400​
InvalidModifyConnectedEpsvcIPVersion.Conflict​
There are still existing connected endpoints on the specified EndpointService instance.​
当前终端节点服务上仍有存量连接,暂不支持更改。​
400​
InvalidPrivateDNSType.ServiceOwnerMismatch​
The specified service owner can not support the EndpointService PrivateDNS type that you want.​
当前服务主体不支持所指定的私有DNS类型。​
403​
Forbidden​
You are not authorized to perform operations on the specified service.​
无权限对指定服务进行操作。​
404​
InvalidEndpointService.NotFound​
The specified EndpointService does not exist.​
指定的终端节点服务不存在。​
404​
InvalidServiceResource.NotFound​
The specified ServiceResource does not exist.​
指定的服务资源不存在。​
​
​
最近更新时间:2026.10.26 15:10:41
这个页面对您有帮助吗?
有用
有用
无用
无用