当前位置:主页 > 查看内容

私有网络 查询终端节点服务列表 - API文档

发布时间:2021-09-28 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: vpc.tencentcloudapi.com 。 查询终端节点服务列表。 默认接口请求频率限制:20次/秒。 注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要……

1. 接口描述

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

查询终端节点服务列表。

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpcEndPointService。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表。
Filters.N Array of Filter 过滤条件。
  • service-id- String - (过滤条件)终端节点服务唯一ID。
  • service-name - String - (过滤条件)终端节点实例名称。
  • service-instance-id - String - (过滤条件)后端服务的唯一ID,比如lb-xxx。
  • Offset Integer 偏移量,默认为0。
    Limit Integer 单页返回数量,默认为20,最大值为100。
    EndPointServiceIds.N Array of String 终端节点服务ID。

    3. 输出参数

    参数名称 类型 描述
    EndPointServiceSet Array of EndPointService 终端节点服务对象数组。
    TotalCount Integer 符合查询条件的个数。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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": {
        "TotalCount": 1,
        "EndPointServiceSet": [
          {
            "VpcId": "vpc-hj3he929",
            "EndPointSet": {},
            "AutoAcceptFlag": "False",
            "ServiceInstanceId": "lb-nswq8wkq",
            "ServiceName": "test_002",
            "EndPointServiceId": "vpcsvc-pnpcflil",
            "ServiceVip": "10.101.1.11",
            "CreateTime": "2021-04-12 19:22:43",
            "ServiceOwner": "1254277469",
            "EndPointCount": 0
          }
        ],
        "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
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

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

    错误码 描述
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameterValue.LimitExceeded 参数值超出限制。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐