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

私网连接

复制全文
下载 pdf
接口终端节点
ModifyVpcEndpointAttributes-修改终端节点属性
复制全文
下载 pdf
ModifyVpcEndpointAttributes-修改终端节点属性
调用ModifyVpcEndpointAttributes接口,修改指定终端节点的信息,操作说明和注意事项请参见修改终端节点。​
调用该接口修改终端节点时,终端节点实例的状态变化为:Available > Pending > Available。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:ModifyVpcEndpointAttributes​
要执行的操作,取值:ModifyVpcEndpointAttributes。​
​
Version String 必选 示例值:2020-04-01​
API的版本信息,当前版本为 2020-04-01。​
​
EndpointId String 必选 示例值:ep-273yuq6q7bgn47fap8squ****​
终端节点的ID。​
您可以调用DescribeVpcEndpoints接口,获取终端节点的ID。​
​
EndpointName String 可选 示例值:endpoint-02​
终端节点的名称。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:点号(.)、下划线(_)和中划线(-)。​
  • 长度限制为1 ~ 128个字符。​
​
IpAddressVersions.N String 可选 示例值:ipv4​
接口终端节点的IP协议类型。​
  • ipv4​
  • ipv6:该取值正在邀测中,如需使用,请联系客户经理。​
说明​
  • 仅传入ipv4时,表示该接口终端节点转换为IPv4类型,仅支持处理IPv4请求。​
  • 同时传入ipv4和ipv6时,表示该接口终端节点转换为双栈类型,支持处理IPv4和IPv6请求,系统自动为其分配IPv6地址。​
  • 如需传入ipv6,请确保满足以下条件:​
  • 已开通私网连接双栈功能的白名单权限。​
  • 接口终端节点所属子网已开启IPv6网段。​
  • 接口终端节点关联的终端节点服务为双栈类型。​
  • 目前不支持仅传入ipv6。​
​
PrivateDNSEnabled Boolean 可选 示例值:false​
是否启用私有DNS名称。​
  • false:不启用。​
  • true:启用。​
说明​
  • 终端节点服务的私有DNS名称验证状态为verified时才可以启用。您可以调用DescribeVpcEndpointServiceAttributes接口查看终端节点服务的私有DNS名称验证状态。​
  • 启用后,终端节点的私有DNS名称默认为其关联的终端节点服务的私有DNS名称。​
​
Description String 可选 示例值:This endpoint is for test.​
终端节点的描述信息。​
  • 必须以字母、数字或中文开头,可包含字母、数字、中文和以下特殊字符:英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、中划线(-)、中文逗号(,)、中文句号(。)。​
  • 长度限制为0 ~ 255个字符。​
​
​
返回参数​
RequestId String 可选 示例值:0ED8D006-F706-4D23-88ED-E11ED28D****​
请求ID。​
​
​
请求示例​
​
GET /?Action=ModifyVpcEndpointAttributes&Version=2020-04-01&EndpointId=ep-273yuq6q7bgn47fap8squ****&EndpointName=endpoint-02 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": "20230604110420****100232280022D31",​
"Action": "ModifyVpcEndpointAttributes",​
"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​
InvalidEndpoint.InvalidStatus​
The specified endpoint is not in the correct status for the request.​
指定的终端节点所处的状态无法响应该请求。​
400​
InvalidName.Malformed​
The specified Name is malformed.​
指定的参数Name格式不合法。​
400​
InvalidDescription.Malformed​
The specified Description is malformed.​
指定的参数Description格式不合法。​
400​
InvalidEndpointService.InvalidLock​
The operation is refused by the endpoint service.​
终端节点服务无法支持该操作。​
400​
InvalidPrivateDNS.UnsupportedOperation​
The request on the specified PrivateDNS is denied due to the PrivateDNS is disabled.​
因为未开启私有DNS功能,该请求被拒绝。​
400​
ErrPrivateZoneExisted​
The vpc and the private dns have created the private zone.​
该私有网络和DNS域名已创建私网解析。​
400​
InsufficientIpInSubnet​
The specified subnet does not contain enough free private IP addresses to fulfill your request.​
指定子网下可用IP不足。​
400​
InvalidEndpointZoneIPVersion.AddressMismatch​
The specified EndpointZone AddressIPVersion and address are not matched.​
指定的终端节点可用区地址与终端节点IP地址类型不匹配。​
400​
InvalidIpAddressVersions.Conflict​
The specified IpAddressVersions parameter is duplicated.​
指定的IpAddressVersions重复。​
400​
InvalidIpAddressVersions.Malformed​
The specified IpAddressVersions is malformed.​
指定的 IpAddressVersions 参数格式不合法。​
400​
InvalidEndpointIpAddressVersions.EndpointServiceMisMatch​
The IpAddressVersions of associated EndpointService and Endpoint mismatch.​
终端节点的IP地址类型与所关联的终端节点服务不匹配。​
400​
InvalidSubnet.VpcMisMatch​
The specified subnet and vpc don't match.​
指定的私有网络和子网不匹配。​
400​
InvalidSubnet.ZoneMisMatch​
The specified subnet and available zone don't match.​
指定的可用区和子网不匹配。​
400​
UnsupportedOperation.AccountArrears​
The request on the specified instance is denied due to the account in arrears status.​
因账户处于欠费状态,对于该实例的操作请求被拒绝。​
400​
InvalidEndpoint.ServiceDeleted​
The specified endpoint's service has been deleted for the request.​
指定的终端节点的所属终端节点服务被删除,无法响应该请求。​
400​
PrivateDNSNameConflictwithPrivateZone​
The specified private DNS name already exists private zone in the VPC.​
指定的私网 DNS 名称在本VPC内已存在私网解析。​
400​
InvalidEndpointZoneIPVersion.SubnetMismatch​
The specified EndpointZone Subnet and Endpoint IPAddressVersion are not matched.​
指定的终端节点可用区子网与终端节点IP地址类型不匹配。​
403​
Forbidden.IPv6EndpointToOthers​
The IPv6 Endpoint can not be modified to other IP version.​
IPv6 类型的终端节点不允许转换IP地址类型。​
403​
Forbidden.ToIPv6Endpoint​
The Endpoint can not be modified to IPv6 from other IP version.​
其他IP地址类型终端节点不允许转换为 IPv6 类型 。​
403​
Forbidden​
You are not authorized to perform operations on the specified service.​
无权限对指定服务进行操作。​
404​
InvalidSubnet.NotFound​
The specified subnet does not exist.​
指定的子网不存在。​
404​
InvalidEndpointService.NotFound​
The specified EndpointService does not exist.​
指定的终端节点服务不存在。​
404​
InvalidEndpoint.NotFound​
The specified endpoint does not exist.​
指定的终端节点不存在。​
409​
InvalidVpcPrivateDNSName.Conflict​
The specified PrivateDNSName in single vpc and single endpoint service already exists.​
指定的私网 DNS 名称在同一个 VPC 和同一个终端节点服务下已存在。​
500​
PrivateZoneCreateFailed​
The private zone create failed.​
PrivateZone 创建失败。​
500​
PrivateZoneQueryFailed​
Failed to query private zone.​
查询私网解析失败。​
500​
AssignIPv6AddressFailed​
Failed to assign ipv6 address.​
分配IPv6地址失败。​
​
最近更新时间:2025.12.09 10:33:57
这个页面对您有帮助吗?
有用
有用
无用
无用