tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateServiceTemplate

Last updated: 2024-11-25 20:04:31

    1. API Description

    Domain name for API request: vpc.intl.tencentcloudapi.com.

    This API (CreateServiceTemplate) is used to create a protocol port template.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: CreateServiceTemplate.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ServiceTemplateName Yes String Template name of the protocol port
    Services.N No Array of String Supported ports inlcude single port, multiple ports, consecutive ports and all ports. Supported protocols include TCP, UDP, ICMP and GRE. Either Services or ServicesExtra is required.
    ServicesExtra.N No Array of ServicesInfo You can add remarks. Supported ports include single port, multiple ports, consecutive ports and all ports. Supported protocols include TCP, UDP, ICMP and GRE. Either Services or ServicesExtra is required.

    3. Output Parameters

    Parameter Name Type Description
    ServiceTemplate ServiceTemplate Protocol port template object.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Creating a protocol port template

    This example shows you how to create a protocol port template.

    Input Example

    https://vpc.intl.tencentcloudapi.com/?Action=CreateServiceTemplate
&ServiceTemplateName=TestName
&Services.0=TCP:8080
&<Common request parameters>

    Output Example

    {
    "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. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InvalidParameter.Coexist The parameters cannot be specified at the same time.
    InvalidParameterValue The parameter value is invalid.
    InvalidParameterValue.Duplicate The input parameter already exists.
    InvalidParameterValue.Empty Missing parameters.
    InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
    LimitExceeded Quota limit is reached.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy