You need to enable JavaScript to run this app.
导航
私网连接
  • 文档首页
    • /私网连接/API参考/接口终端节点/ModifyVpcEndpointAttributes
ModifyVpcEndpointAttributes
最近更新时间：2024.09.06 08:12:13首次发布时间：2023.03.17 21:09:37
我的收藏

调用ModifyVpcEndpointAttributes接口，修改指定终端节点的信息。

调用该接口修改终端节点时，终端节点实例的状态变化为：Available > Pending > Available。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

下表中的非必选参数不传入时，表示该参数取值保持原有配置不变。

名称类型是否必选示例值描述
ActionString是ModifyVpcEndpointAttributes要执行的操作，取值为ModifyVpcEndpointAttributes。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
EndpointIdString是ep-273yuq6q7bgn47fap8squ****终端节点的ID。您可以调用DescribeVpcEndpoints接口获取终端节点的ID。

EndpointName

String

否

endpoint-02

终端节点的名称。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：点号（.）、下划线（_）和中划线（-）。
  • 长度限制为1 ~ 128个字符。

IpAddressVersions.N

String

否

IpAddressVersions.1=ipv4&IpAddressVersions.2=ipv6

接口终端节点的IP协议类型。

  • ipv4
  • ipv6：该取值正在邀测中，如需使用，请联系客户经理。

说明

  • 仅传入“ipv4”时，表示该接口终端节点转换为IPv4类型，仅支持处理IPv4请求。
  • 同时传入“ipv4”和“ipv6”时，表示该接口终端节点转换为双栈类型，支持处理IPv4和IPv6请求，系统自动为其分配IPv6地址。
      如需传入“ipv6”，请确保满足以下条件：
    • 已开通私网连接双栈功能的白名单权限。
    • 接口终端节点所属子网已开启IPv6网段。
    • 接口终端节点关联的终端节点服务为双栈类型。
  • 目前不支持仅传入“ipv6”。

PrivateDNSEnabled

String

否

false

是否启用私有DNS名称。

  • false：不启用。
  • true：启用。

说明

  • 终端节点服务的私有DNS名称验证状态为“verified”时才可以启用。您可以调用DescribeVpcEndpointServiceAttributes接口查看终端节点服务的私有DNS名称验证状态。
  • 启用后，终端节点的私有DNS名称默认为其关联的终端节点服务的私有DNS名称。

Description

String

否

This endpoint is for test.

终端节点的描述信息。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ～ 255个字符。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。

请求示例

GET /?Action=ModifyVpcEndpointAttributes&Version=2020-04-01&EndpointId=ep-273yuq6q7bgn47fap8squ****&EndpointName=endpoint-02 HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "ModifyVpcEndpointAttributes",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述

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表示缺少的参数名称。

400InvalidEndpoint.InvalidStatusThe specified endpoint is not in the correct status for the request.指定的终端节点所处的状态无法响应该请求。
400InvalidName.MalformedThe specified Name is malformed.指定的参数Name格式不合法。
400InvalidDescription.MalformedThe specified Description is malformed.指定的参数Description格式不合法。
400InvalidEndpointService.InvalidLockThe operation is refused by the endpoint service.终端节点服务无法支持该操作。
400InvalidPrivateDNS.UnsupportedOperationThe request on the specified PrivateDNS is denied due to the PrivateDNS is disabled.因为未开启私有DNS功能，该请求被拒绝。
400ErrPrivateZoneExistedThe vpc and the private dns have created the private zone.该私有网络和DNS域名已创建私网解析。
400InvalidEndpointZoneIPVersion.AddressMismatchThe specified EndpointZone AddressIPVersion and address are not matched.指定的终端节点可用区地址与终端节点IP类型不匹配。
400InvalidIpAddressVersions.ConflictThe specified IpAddressVersions parameter is duplicated.指定的IpAddressVersions重复。
400InvalidIpAddressVersions.MalformedThe specified IpAddressVersions is malformed.指定的 IpAddressVersions 参数格式不合法。
400InvalidEndpointIpAddressVersions.EndpointServiceMisMatchThe IpAddressVersions of associated EndpointService and Endpoint mismatch.终端节点的IP类型与所关联的终端节点服务不匹配。
400InvalidSubnet.VpcMisMatchThe specified subnet and vpc don't match.指定的私有网络和子网不匹配。
400InvalidSubnet.ZoneMisMatchThe specified subnet and available zone don't match.指定的可用区和子网不匹配。
400UnsupportedOperation.AccountArrearsThe request on the specified instance is denied due to the account in arrears status.因账户处于欠费状态，对于该实例的操作请求被拒绝。
403ForbiddenYou are not authorized to perform operations on the specified service.无权限对指定服务进行操作。
404InvalidSubnet.NotFoundThe specified subnet does not exist.指定的子网不存在。
404InvalidEndpointService.NotFoundThe specified EndpointService does not exist.指定的终端节点服务不存在。
404InvalidEndpoint.NotFoundThe specified endpoint does not exist.指定的终端节点不存在。
409InvalidVpcPrivateDNSName.ConflictThe specified PrivateDNSName in single vpc and single endpoint service already exists.指定的私网 DNS 名称在同一个 VPC 和同一个终端节点服务下已存在。
500PrivateZoneCreateFailedThe private zone create failed.PrivateZone 创建失败。
500PrivateZoneQueryFailedFailed to query private zone.查询私网解析失败。
500AssignIPv6AddressFailedFailed to assign ipv6 address.分配IPv6地址失败。