1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateServiceTemplate)用于创建协议端口模板。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateServiceTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ServiceTemplateName | 是 | String | 协议端口模板名称。 示例值:TestName |
Services.N | 否 | Array of String | 支持单个端口、多个端口、连续端口及所有端口,协议支持:TCP、UDP、ICMP、GRE 协议。Services与ServicesExtra必填其一。 示例值:["TCP:8080","UDP:99"] |
ServicesExtra.N | 否 | Array of ServicesInfo | 支持添加备注,单个端口、多个端口、连续端口及所有端口,协议支持:TCP、UDP、ICMP、GRE 协议。Services与ServicesExtra必填其一。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ServiceTemplate | ServiceTemplate | 协议端口模板对象。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建协议端口模板
创建协议端口模板
输入示例
https://vpc.tencentcloudapi.com/?Action=CreateServiceTemplate
&ServiceTemplateName=TestName
&Services.0=TCP:8080
&<公共请求参数>
输出示例
{
"Response": {
"ServiceTemplate": {
"ServiceTemplateName": "TestName",
"ServiceTemplateId": "ppm-xxxxxxxx",
"ServiceSet": [
"tcp: 8080"
],
"CreatedTime": "2018-04-03 21:19:31",
"ServiceExtraSet": [
{
"Description": "test",
"Service": "tcp:8080"
}
]
},
"RequestId": "20569756-56ba-4a13-b545-e1528d5cb239"
}
}
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 | 参数不支持同时指定。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.Duplicate | 入参重复。 |
InvalidParameterValue.Empty | 缺少参数。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |