1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(DescribeVpcEndPointService)用于查询终端节点服务列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeVpcEndPointService。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Filters.N | 否 | Array of Filter | 过滤条件。不支持同时传入参数 EndPointServiceIds and Filters。 |
Offset | 否 | Integer | 偏移量,默认为0。 |
Limit | 否 | Integer | 单页返回数量,默认为20,最大值为100。 |
EndPointServiceIds.N | 否 | Array of String | 终端节点服务ID。不支持同时传入参数 EndPointServiceIds and Filters。 |
IsListAuthorizedEndPointService | 否 | Boolean |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
EndPointServiceSet | Array of EndPointService | 终端节点服务对象数组。 |
TotalCount | Integer | 符合查询条件的个数。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询终端节点服务列表
查询终端节点服务列表
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeVpcEndPointService
<公共请求参数>
{
"EndPointServiceIds": [
"vpcsvc-kngiybxl"
],
"Limit": 1,
"Offset": 1
}
输出示例
{
"Response": {
"EndPointServiceSet": [
{
"EndPointServiceId": "vpcsvc-pnpcflil",
"VpcId": "vpc-hj3he929",
"ServiceOwner": "1254277469",
"ServiceName": "test_002",
"ServiceVip": "10.101.1.11",
"ServiceInstanceId": "lb-nswq8wkq",
"AutoAcceptFlag": true,
"EndPointCount": 1,
"EndPointSet": [
{
"ServiceVpcId": "vpc-hj3he929",
"GroupSet": [
"sg-tyhgrwet"
],
"ServiceName": "测试",
"State": "PENDING",
"ServiceVip": "10.101.1.11",
"EndPointName": "节点",
"VpcId": "vpc-hj3he929",
"EndPointOwner": "1302384414",
"EndPointId": "vpce-h0fk8lfc",
"SubnetId": "subnet-4t7fr3fi",
"CreateTime": "0000-00-00 00:00:00",
"EndPointServiceId": "vpcsvc-kngiybxl",
"EndPointVip": "10.101.1.11"
}
],
"CreateTime": "0000-00-00 00:00:00",
"ServiceType": "CLB"
}
],
"TotalCount": 1,
"RequestId": "452e8b38-10a1-4d8a-8a31-a64b89c8f565"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.Coexist | 参数不支持同时指定。 |
InvalidParameter.FilterInvalidKey | 指定过滤条件不存在。 |
InvalidParameter.FilterNotDict | 指定过滤条件不是键值对。 |
InvalidParameter.FilterValuesNotList | 指定过滤选项值不是列表。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.NotUtf8EncodingError | 不是UTF8编码。 |
InvalidParameterValue.Range | 参数值不在指定范围。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation.InstanceMismatch | 指定实例资源不匹配。 |
UnsupportedOperation.RoleNotFound | 未找到相关角色,请确认角色是否授权。 |