查询协议端口模板

最近更新时间:2018-10-26 15:01:52

1. 接口描述

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

查询协议端口模板

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeServiceTemplates
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
Filters.N Array of Filter 过滤条件。
  • service-template-name - String - (过滤条件)协议端口模板名称。
  • service-template-id - String - (过滤条件)协议端口模板实例ID,例如:ppm-e6dy460g。
  • Offset String 偏移量,默认为0。
    Limit String 返回数量,默认为20,最大值为100。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    ServiceTemplateSet Array of ServiceTemplate 协议端口模板对象。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查看协议端口模板

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeServiceTemplates
    &Version=2017-03-12
    &Filters.0.Name=service-template-name
    &Filters.0.Values.0=TestName
    &Limit=2
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "RequestId": "20569756-56ba-4a13-b545-e1528d5cb239",
        "ServiceTemplateSet": [
          {
            "CreatedTime": "2018-04-03 21:19:31",
            "ServiceSet": [
              "tcp:8080",
              "udp:99"
            ],
            "ServiceTemplateId": "ppm-bu8cir16",
            "ServiceTemplateName": "TestName"
          },
          {
            "CreatedTime": "2018-04-03 21:03:12",
            "ServiceSet": [
              "tcp:8080",
              "udp:99"
            ],
            "ServiceTemplateId": "ppm-2jju0z3u",
            "ServiceTemplateName": "TestName"
          }
        ],
        "TotalCount": 8
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InvalidParameterValue.Malformed 入参格式不合法。