文档

CreateVpcEndpointService - 创建终端节点服务

更新时间:

调用CreateVpcEndpointService接口,创建终端节点服务。

接口说明

  • 创建终端节点服务之前,请确保您已创建支持私网连接的负载均衡资源。具体操作,请参见创建负载均衡实例

  • CreateVpcEndpointService 接口属于异步接口,即系统会返回一个实例 ID,但该终端节点服务尚未创建完成,系统后台任务仍在进行中。您可以调用 GetVpcEndpointServiceAttribute 查询终端节点服务的创建状态:

    • 当终端节点服务处于 Creating 状态时,表示终端节点服务正在创建。

    • 当终端节点服务处于 Active 状态时,表示终端节点服务创建完成。

调试

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

授权信息

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

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

请求参数

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

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

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

cn-huhehaote
ClientTokenstring

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

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

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

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

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

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。

false
ServiceDescriptionstring

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

This is my EndpointService.
AutoAcceptEnabledboolean

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

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

  • false(默认值):不自动接受终端节点连接。

false
Payerstring

付费方,取值:

  • Endpoint:服务使用方。

  • EndpointService:服务提供方。

Endpoint
ZoneAffinityEnabledboolean

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

  • true:是。

  • false(默认值):否。

false
ServiceResourceTypestring

服务资源类型。取值:

  • slb :表示服务资源类型为传统型负载均衡 CLB(Classic Load Balancer)。

  • alb :表示服务资源类型为应用型负载均衡 ALB(Application Load Balancer)。

  • nlb :表示服务资源类型为网络型负载均衡 NLB(Network Load Balancer )。

说明 不支持访问 NLB 的 TCPSSL 类型监听。
slb
Resourceobject []

终端节点服务资源合集。

ResourceTypestring

添加到终端节点服务中的服务资源的类型,一个终端节点服务最多支持添加 20 个服务资源。取值:

  • slb :表示服务资源类型为传统型负载均衡 CLB(Classic Load Balancer)。

  • alb :表示服务资源类型为应用型负载均衡 ALB(Application Load Balancer)。

  • nlb :表示服务资源类型为网络型负载均衡 NLB(Network Load Balancer )。

说明 在支持私网连接功能的地域内,专有网络类型的传统型负载均衡 CLB 实例均支持作为终端节点服务的服务资源。不支持访问 NLB 的 TCPSSL 类型监听。
slb
ResourceIdstring

添加到终端节点服务中的服务资源 ID。最多支持 20 个资源 ID。

lb-hp32z1wp5peaoox2q****
ZoneIdstring

可用区 ID。

cn-huhehaote-a
ServiceSupportIPv6boolean

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

  • true:是。

  • false(默认值):否。

false
ResourceGroupIdstring

资源组 ID。

rg-acfmy*****
Tagobject []

标签列表。

Keystring

实例的标签键。最多支持 20 个标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

env
Valuestring

实例的标签值。最多支持 20 个标签值。一旦传入该值,可以为空字符串。

最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://

prod

返回参数

名称类型描述示例值
object
ServiceBusinessStatusstring

终端节点服务的业务状态。取值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
RequestIdstring

请求 ID。

8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceNamestring

终端节点服务的名称。

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatusstring

终端节点服务的状态。取值:

  • Creating:创建中。

  • Pending:修改中。

  • Active:可用。

  • Deleting:删除中。

Active
ServiceDescriptionstring

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

This is my EndpointService.
CreateTimestring

终端节点服务的创建时间。

2022-01-02T19:11:12Z
ServiceDomainstring

终端节点服务的服务域名。

epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
ZoneAffinityEnabledboolean

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

  • true:是。
  • false:否。
false
AutoAcceptEnabledboolean

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

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

终端节点服务的 ID。

epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6boolean

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

  • true:是。

  • false:否。

false
ResourceGroupIdstring

资源组 ID。

rg-acfmy*****

示例

正常返回示例

JSON格式

{
  "ServiceBusinessStatus": "Normal",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2022-01-02T19:11:12Z",
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "ZoneAffinityEnabled": false,
  "AutoAcceptEnabled": false,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****"
}

错误码

HTTP status code错误码错误信息描述
400EndpointServiceExistThe specified Endpoint Service already exists.当前终端节点服务已经存在。
400AlbNotFoundThe specified Alb does not exist.ALI负载均衡不存在。
400LoadBalancerNotFoundThe specified load balancer does not exist.负载均衡不存在。
400LoadBalancerNotSupportPrivateLinkThe specified SLB does not support PrivateLink.当前负载均衡不支持Privatelink。
400GenerateResourceIdFailedFailed to generate ResourceId.生成资源ID失败。
400QuotaMisMatchedThe resource you applied for has exceeded the quota.申请的资源超过配额
400VSwitchNotFoundThe specified VSwitch does not exist.当前虚拟交换机未找到。
400EndpointServicePayerForbiddenThe parameter EndpointServicePayer is forbidden. The user is not in the whitelist.终端节点服务的付费类型, 不在白名单中
400NeedOpenProductThe product is not activated.产品未开通
400EndpointServiceNotSupportedZoneThe specified endpoint service does not support the zone.终端节点服务不支持当前可用区。
400IllegalParamFormat.%sThe param format of %s is illegal.指定的%s格式无效。请检查参数约束,并在修改后重试。
400MissingParam.%sThe param of %s is missing.参数%s缺失。
400ResourceNotFound.NatGatewayThe specified resource %s is not found.资源%s不存在。
400Mismatch.ResourceTypeThe %s is mismatched for %s and %s.%s在%s和%s中不匹配。
400EndpointServiceNotSupportIpv6The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.终端节点服务不支持IPv6
400OperationDenied.PrivateDomainNotSupportThe operation is not allowed because of PrivateDomainNotSupport.由于%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结尾。

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

变更历史

变更时间变更内容概要操作
2024-03-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2023-09-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-11-30OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:Tag
  • 本页导读 (1)