1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateVpcEndPoint)用于创建终端节点。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateVpcEndPoint。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcId | 是 | String | VPC实例ID。 示例值:vpc-q26u781x。 |
SubnetId | 是 | String | 子网实例ID。 示例值:subnet-qmqye6ew。 |
EndPointName | 是 | String | 终端节点名称。 示例值:示例名称。 |
EndPointServiceId | 是 | String | 终端节点服务ID。 示例值:vpcsvc-ettmyyrn。 |
EndPointVip | 否 | String | 终端节点VIP,可以指定IP申请。 示例值:10.0.0.0/16。 |
SecurityGroupId | 否 | String | 安全组ID。 示例值:sg-123456。 |
Tags.N | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EndPoint | EndPoint | 终端节点对象详细信息。 示例值:无。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建终端节点
创建终端节点
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpcEndPoint
<公共请求参数>
{
"SubnetId": "subnet-4t7fr3fi",
"EndPointName": "point_002",
"VpcId": "vpc-coekkqtd",
"EndPointServiceId": "vpcsvc-kngiybxl"
}
输出示例
{
"Response": {
"EndPoint": {
"ServiceVpcId": "vpc-hj3he929",
"VpcId": "vpc-coekkqtd",
"State": "PENDING",
"ServiceVip": "10.101.1.11",
"EndPointName": "point_002",
"GroupSet": [],
"EndPointOwner": "1302384414",
"EndPointId": "vpce-h0fk8lfc",
"SubnetId": "subnet-4t7fr3fi",
"CreateTime": "0000-00-00 00:00:00",
"EndPointServiceId": "vpcsvc-kngiybxl",
"EndPointVip": "10.0.0.8",
"ServiceName": "服务"
},
"RequestId": "fefb383a-7394-46c9-ba34-6b21e8fb3ac1"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
InvalidParameterValue.Reserved | 参数值是一个系统保留对象。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.Subnet | 子网IP资源不足, 无法分配IP。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourceUnavailable.ServiceWhiteListNotAdded | 当前用户不在指定终端节点服务的白名单内。 |
UnauthorizedOperation.NoRealNameAuthentication | 账号未实名。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.EndPointMismatchEndPointServiceCdcId | 终端节点和终端节点服务的CdcId不一致。 |
UnsupportedOperation.EndPointService | 终端节点服务本身不能是终端节点。 |
UnsupportedOperation.InsufficientFunds | 账户余额不足。 |
UnsupportedOperation.SnatSubnet | SNAT子网 不支持分配IP。 |
UnsupportedOperation.SpecialEndPointService | 指定的终端节点服务所创建的终端节点不支持绑定安全组。 |
UnsupportedOperation.VpcMismatch | 资源不属于同一个VPC。 |