首页 私网连接 PrivateLink API参考 API目录 终端节点服务 CreateVpcEndpointService - 创建终端节点服务

CreateVpcEndpointService - 创建终端节点服务

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

接口说明

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

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

调试

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

调试

授权信息

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

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

请求参数

名称 类型 必填 描述 示例值
RegionId string

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

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

cn-huhehaote
ClientToken string

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

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

0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun boolean

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

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

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

false
ServiceDescription string

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

This is my EndpointService.
AutoAcceptEnabled boolean

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

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

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

false
Payer string

付费方,取值:

  • Endpoint:服务使用方。

  • EndpointService:服务提供方。

Endpoint
ZoneAffinityEnabled boolean

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

  • true:是。

  • false(默认值):否。

false
ServiceResourceType string

服务资源类型。取值:

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

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

slb
Resource array

终端节点服务资源合集。

object

终端节点服务资源合集。

ResourceType string

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

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

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

说明 在支持私网连接功能的地域内,专有网络类型的传统型负载均衡CLB实例均支持作为终端节点服务的服务资源。更多信息,请参见私网CLB全面支持私网连接(PrivateLink)功能
slb
ResourceId string

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

lb-hp32z1wp5peaoox2q****
ZoneId string

可用区ID。

cn-huhehaote-a
ServiceSupportIPv6 boolean

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

  • true:是。

  • false(默认值):否。

false
ResourceGroupId string

资源组ID。

rg-acfmy*****
Tag array

标签列表。

object
Key string

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

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

env
Value string

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

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

prod

返回参数

名称 类型 描述 示例值
object

终端节点服务的业务状态。

ServiceBusinessStatus string

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

  • Normal:正常。

  • FinacialLocked:欠费锁定。

Normal
RequestId string

请求ID。

8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceName string

终端节点服务的名称。

com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus string

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

  • Creating:创建中。

  • Pending:修改中。

  • Active:可用。

  • Deleting:删除中。

  • Inactive:不可用。

Active
ServiceDescription string

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

This is my EndpointService.
CreateTime string

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

2022-01-02T19:11:12Z
ServiceDomain string

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

epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
ZoneAffinityEnabled boolean

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

  • true:是。
  • false:否。
false
AutoAcceptEnabled boolean

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

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

终端节点服务的ID。

epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6 boolean

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

  • true:是。

  • false:否。

false
ResourceGroupId string

资源组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": true,
  "AutoAcceptEnabled": true,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "ServiceSupportIPv6": true,
  "ResourceGroupId": "rg-acfmy*****"
}

错误码

Http code 错误码 错误信息 描述
400 EndpointServiceExist The specified Endpoint Service already exists. 当前终端节点服务已经存在。
400 AlbNotFound The specified Alb does not exist. ALI负载均衡不存在。
400 LoadBalancerNotFound The specified load balancer does not exist. 负载均衡不存在。
400 LoadBalancerNotSupportPrivateLink The specified SLB does not support PrivateLink. 当前负载均衡不支持Privatelink。
400 GenerateResourceIdFailed Failed to generate ResourceId. 生成资源ID失败。
400 QuotaMisMatched The resource you applied for has exceeded the quota. 申请的资源超过配额
400 VSwitchNotFound The specified VSwitch does not exist. 当前虚拟交换机未找到。
400 EndpointServicePayerForbidden The parameter EndpointServicePayer is forbidden. The user is not in the whitelist. 终端节点服务的付费类型, 不在白名单中
400 NeedOpenProduct The product is not activated. 产品未开通
400 EndpointServiceNotSupportedZone The specified endpoint service does not support the zone. 终端节点服务不支持当前可用区。
400 IllegalParamFormat.%s The param format of %s is illegal. 指定的%s格式无效。请检查参数约束,并在修改后重试。
400 MissingParam.%s The param of %s is missing. 参数%s缺失。
400 ResourceNotFound.NatGateway The specified resource %s is not found. 资源%s不存在。
400 Mismatch.ResourceType The %s is mismatched for %s and %s. %s在%s和%s中不匹配。
400 EndpointServiceNotSupportIpv6 The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6. 终端节点服务不支持IPv6

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

变更历史

变更时间 变更内容概要 操作
2022-11-30 OpenAPI 描述信息更新,OpenAPI 错误码发生变更,OpenAPI 入参发生变更
变更项 变更内容
API 描述 OpenAPI 描述信息更新
错误码 OpenAPI 错误码发生变更
    删除错误码:400
入参 OpenAPI 入参发生变更
    新增入参:Tag
阿里云首页 私网连接 相关技术圈