You need to enable JavaScript to run this app.
导航
私网连接
  • 文档首页
    • /私网连接/API参考/终端节点服务/CreateUniqueResourceTypeVpcEndpointService
CreateUniqueResourceTypeVpcEndpointService
最近更新时间：2024.10.29 15:18:11首次发布时间：2023.05.09 10:15:35
我的收藏

调用CreateUniqueResourceTypeVpcEndpointService接口，创建一个关联RDS类型服务资源的终端节点服务。

说明

支持RDS类型服务资源的功能正在邀测中，如需使用该接口，请联系客户经理。

调试

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

请求参数

下表中，Tags.N.a类型参数中的“N”表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签之间使用&分隔。每个标签键对应一个标签值。

名称类型是否必选示例值描述
ActionString是CreateUniqueResourceTypeVpcEndpointService要执行的操作，取值为CreateUniqueResourceTypeVpcEndpointService。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。

IpAddressVersions.N

String

否

IpAddressVersions.1=ipv4&IpAddressVersions.2=ipv6

终端节点服务的IP协议类型。

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

说明

  • 仅传入“ipv4”时，表示该终端节点服务为IPv4类型，仅支持提供IPv4服务。
  • 同时传入“ipv4”和“ipv6”时，表示该终端节点服务为双栈类型，支持提供IPv4和IPv6服务，系统自动为其分配IPv6地址。
      如需传入“ipv6”，请确保满足以下条件：
    • 已开通私网连接服务的IPv6功能。
    • 指定的服务资源支持双栈。
  • 目前不支持仅传入“ipv6”。

ServiceResourceType

String

否

Resources.1.ResourceType=RDSMySQL

服务资源的类型。取值如下：

  • RDSMySQL：云数据库 MySQL版。
Resource.InstanceIdString否mysql-bp1o94dp5i6ea****待添加到终端节点服务中的RDS类型服务资源所属RDS实例的ID。您可以调用DescribeDBInstances接口查看RDS实例的ID。
Resource.ResourceIdString是mysql-bp1o94dp5i6ea****-cluster-qhwjs67hbmsj****待添加到终端节点服务中的RDS类型服务资源的ID。您可以调用DescribeDBInstanceDetail接口获取RDS实例连接终端的ID。

AutoAcceptEnabled

Boolean

否

false

是否自动接受终端节点连接。取值如下：

  • true：终端节点服务自动接受终端节点连接。
  • false（默认值）：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。

ZoneIds.N

String

是

ZoneIds.1=cn-guangzhou-a&ZoneIds.2=cn-guangzhou-b

终端节点服务支持的可用区ID。

  • N：表示可用区的序号，取值范围为1～20。
  • 多个可用区之间使用&分隔。

ClientToken

String

否

123e4567-e89b-12d3-a456-42665544****

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

  • 该参数值由客户端自动生成，确保不同请求的取值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 取值仅支持ASCII字符，最大不超过64个字符。
  • 未指定该参数值时，不进行幂等校验。

Description

String

否

EndpointService

终端节点服务的描述，默认值为空字符串。

  • 必须以字母、数字或中文开头，可包含字母、数字、中文和以下特殊字符：英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）。
  • 长度限制为0 ～ 255个字符。
ProjectNameString否default终端节点服务所属项目的名称。

Tags.N.Key

String

否

Tags.1.Key=k1&Tags.2.Key=k2

终端节点服务用户标签的标签键。

  • 长度限制为1～128个字符。
  • 大小写敏感，不能以volc:或sys:的任意大小写组合开头。
  • 不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

同一资源的标签键不允许重复。

Tags.N.Value

String

否

Tags.1.Value=v1&Tags.2.Value=v2

终端节点服务用户标签的标签值。

  • 长度限制为0～255个字符。
  • 大小写敏感，不能以空格开头或结尾。
  • 允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。

说明

如果传入该参数，则必须先传入Tags.N.Key。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
ServiceIdStringepsvc-2fe630gurkl37k5gfuy33****终端节点服务的ID。

请求示例

GET /?Action=CreateUniqueResourceTypeVpcEndpointService&Version=2020-04-01&ServiceResourceType=RDSMySQL&Resource.InstanceId=mysql-bp1o94dp5i6ea****&Resource.ResourceId=mysql-bp1o94dp5i6ea****-cluster-qhwjs67hbmsj**** HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

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

错误码

此处仅展示当前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表示缺少的参数名称。

400InvalidDescription.MalformedThe specified Description is malformed.指定的参数Description格式不合法。
400InvalidServiceResource.MalformedThe specified ServiceResource is malformed.指定的 ServiceResource 参数格式不合法。
400InvalidServiceResourceType.MalformedThe specified ServiceResourceType is malformed.指定的参数ServiceResourceType格式不合法。
400InvalidServiceType.MalformedThe specified ServiceType is malformed.指定的 ServiceType 参数格式不合法。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的 ClientToken 参数格式不合法。
400IdempotentParameterMismatchThe request uses the same ClientToken as a previous, but non-identical request. Do not reuse a ClientToken with different requests, unless the requests are identical.该请求使用了与另外请求相同的 ClientToken，请不要在不同请求中复用相同的 ClientToken。
400InvalidZone.ConflictThe specified zone is duplicated.指定的可用区重复。
400InvalidZone.MalformedThe specified Zone is malformed.指定的 Zone 参数格式不合法。
400QuotaExceed.EndpointServiceNumberYou've reached the limit on the number of endpoint service instances that you can create.已达到可创建终端节点服务实例数量的配额上限。
400QuotaExceed.ServiceZoneEachInstanceYou've reached the limit on the number of service zones that you can create.已达到每个终端节点服务实例可创建服务资源所属可用区的数量的配额上限。
400ErrPrivateLinkServiceNotSupportedZoneThe PrivateLink service does not support the zone.终端节点服务不支持添加该可用区的服务资源。
400InvalidServiceResource.InvalidStatusThe specified ServiceResource is not in the correct status for the request.指定的服务资源所处的状态无法响应该请求。
400InvalidProjectName.MalformedThe specified ProjectName is malformed.指定的 ProjectName 参数格式不合法。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified TagKey is malformed.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的 TagValue 参数格式不合法。
400LimitExceeded.TagOperationYou've reached the limit on the number of tags that you can operate at a time.已达到单次可操作的标签条目数量上限。
400InvalidIpAddressVersions.ConflictThe specified IpAddressVersions parameter is duplicated.指定的IpAddressVersions重复。
400InvalidIpAddressVersions.MalformedThe specified IpAddressVersions is malformed.指定的 IpAddressVersions 参数格式不合法。
400InvalidServiceResourceStatus.IPVersionMismatchThe specified service resource can not support the EndpointService ipAddressVersion that you want.当前服务资源不支持所指定的终端节点服务IP类型。
403ForbiddenYou are not authorized to perform operations on the specified service.无权限对指定服务进行操作。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
404InvalidServiceResource.NotFoundThe specified ServiceResource does not exist.指定的服务资源不存在。
412IdempotentProcessingThe request uses the same ClientToken as a previous one that is still in process.幂等请求处理中。