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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateVpcEndpointService

要执行的操作,取值:CreateVpcEndpointService

RegionId String eu-west-1

终端节点服务所属的地域ID。您可以通过调用DescribeRegions接口获取地域ID。

ClientToken String 0c593ea1-3bea-11e9-b96b-88e9fe637760

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。

DryRun Boolean false

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

true:发送检查请求,不会创建资源。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

false(默认值):发送正常请求,通过检查后返回2XX HTTP状态码并直接创建资源。

ServiceDescription String This is my EndpointService.

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

AutoAcceptEnabled Boolean false

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

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

付费方,取值:

  • Endpoint:服务使用方。
  • EndpointService:服务提供方。
ZoneAffinityEnabled Boolean true

是否支持可用区就近解析,取值:

  • true:是。
  • false(默认值):否。
Resource.N.ResourceType String slb

添加到终端节点服务中的服务资源的类型,仅取值:slb(专有网络类型且具备PrivateLink功能的负载均衡实例)。

N的取值范围为1~20

说明 目前,仅支持专有网络类型且具备PrivateLink功能的负载均衡实例作为终端节点服务的服务资源。
Resource.N.ResourceId String lb-hp32z1wp5peaoox2q****

添加到终端节点服务中的服务资源ID。N的取值范围为1~20

返回数据

名称 类型 示例值 描述
AutoAcceptEnabled Boolean false

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

  • true:自动接受终端节点连接。
  • false:不自动接受终端节点连接。
CreateTime String 2020-01-02T19:11:12Z

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

RequestId String 8D8992C1-6712-423C-BAC5-E5E817484C6B

请求ID。

ServiceBusinessStatus String Normal

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

  • Normal:正常。
  • FinacialLocked:欠费锁定。
ServiceDescription String This is my EndpointService.

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

ServiceDomain String epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com

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

ServiceId String epsrv-hp3vpx8yqxblby3i****

终端节点服务的ID。

ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

终端节点服务的名称。

ServiceStatus String Active

终端节点服务的状态:

  • Creating:创建中。
  • Pending:修改中。
  • Active:可用。
  • Deleting:删除中。
  • Inactive:不可用。
ZoneAffinityEnabled Boolean true

是否支持可用区就近解析,取值:

  • true:是。
  • false:否。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateVpcEndpointService
&RegionId=eu-west-1
&<公共请求参数>

正常返回示例

XML格式

<CreateVpcEndpointServiceResponse>
  <ServiceBusinessStatus>Normal</ServiceBusinessStatus>
  <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
  <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>
  <ServiceStatus>Active</ServiceStatus>
  <ServiceDescription>This is my EndpointService.</ServiceDescription>
  <CreateTime>2020-01-02T19:11:12Z</CreateTime>
  <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>
  <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
  <AutoAcceptEnabled>false</AutoAcceptEnabled>
  <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
</CreateVpcEndpointServiceResponse>

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": "2020-01-02T19:11:12Z",
    "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
    "ZoneAffinityEnabled": true,
    "AutoAcceptEnabled": false,
    "ServiceId": "epsrv-hp3vpx8yqxblby3i****"
}

错误码

HttpCode 错误码 错误信息 描述
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. 终端节点服务不支持当前可用区。

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