创建终端节点服务

最近更新时间:2025-05-20 01:35:14

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(CreateVpcEndPointService)用于创建终端节点服务。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateVpcEndPointService。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
VpcId String VPC实例ID。可通过DescribeVpcs接口获取。
示例值:vpc-ihwh81fr
EndPointServiceName String 终端节点服务名称。
示例值:EndPointServiceName1
AutoAcceptFlag Boolean 是否自动接受。
示例值:true
ServiceInstanceId String 后端服务ID,比如lb-p1hiksdg。CLB可通过DescribeLoadBalancers接口获取;CDB可通过DescribeDBInstances接口获取;CRS可通过DescribeInstances接口获取;GWLB可通过DescribeGatewayLoadBalancers接口获取。

示例值:lb-7xwasqqy
IsPassService Boolean 是否是PassService类型。该字段已废弃,请不要使用该字段。
示例值:true
ServiceType String 挂载的PAAS服务类型,CLB(负载均衡),CDB(云数据库 MySQL),CRS(云数据库 Redis),GWLB(网关负载均衡)。不填默认挂载为CLB。
示例值:CLB
Tags.N Array of Tag 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。
示例值:[{"Key": "env", "Value": "prod"}]
IpAddressType String 协议类型,支持 Ipv4,Ipv6,默认 Ipv4。
示例值:Ipv4

3. 输出参数

参数名称 类型 描述
EndPointService EndPointService 终端节点服务对象详细信息。
示例值:{"EndPointServiceId": "vpcsvc-kngiybxl"}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建终端节点服务

创建终端节点服务

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpcEndPointService
<公共请求参数>

{
    "AutoAcceptFlag": true,
    "EndPointServiceName": "demo",
    "VpcId": "vpc-hj3he929",
    "IsPassService": true,
    "ServiceInstanceId": "lb-nswq8wkq",
    "ServiceType": "CLB"
}

输出示例

{
    "Response": {
        "RequestId": "b237f475-49b3-4b10-af8e-071e0a5c7d7a",
        "EndPointService": {
            "VpcId": "vpc-hj3he929",
            "AutoAcceptFlag": "false",
            "ServiceInstanceId": "lb-nswq8wkq",
            "ServiceName": "demo",
            "EndPointServiceId": "vpcsvc-kngiybxl",
            "ServiceVip": "10.101.1.11",
            "CreateTime": "0000-00-00 00:00:00",
            "ServiceOwner": "1254277469",
            "EndPointCount": 1,
            "EndPointSet": [],
            "ServiceType": "CLB",
            "CdcId": ""
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError.ModuleError 内部模块错误。
InvalidParameterValue.Empty 缺少参数。
InvalidParameterValue.Malformed 入参格式不合法。
InvalidParameterValue.TooLong 无效参数值。参数值太长。
LimitExceeded 超过配额限制。
ResourceInUse 资源被占用。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
UnsupportedOperation 操作不支持。
UnsupportedOperation.EndPointServiceLoadBalancerInvalidType 终端节点服务负载均衡类型不为内网负载均衡。
UnsupportedOperation.InstanceMismatch 指定实例资源不匹配。
UnsupportedOperation.NotMatchTargetService 目的端的服务在IP申请中使用的实例ID和这里传入的不匹配。
UnsupportedOperation.ResourceIsInvalidState 资源处于不可用状态,禁止操作。
UnsupportedOperation.RoleNotFound 未找到相关角色,请确认角色是否授权。
UnsupportedOperation.VpcMismatch 资源不属于同一个VPC。