Contents:
1. API Description
Domain name for API request: vpc.tencentcloudapi.com.
This API (DescribeServiceTemplateGroups) is used to query a protocol port template group.
A maximum of 100 requests can be initiated per second for this API.
Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com.
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 parameter. The value used for this API: DescribeServiceTemplateGroups |
Version | Yes | String | Common parameter. The value used for this API: 2017-03-12 |
Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
Filters.N | No | Array of Filter | Filter conditions. |
Offset | No | String | Offset. Default is 0. |
Limit | No | String | Number of values to be returned. Default is 20. Maximum is 100. |
3. Output Parameters
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of instances matching the filter condition. |
ServiceTemplateGroupSet | Array of ServiceTemplateGroup | Protocol port template group. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Error Codes
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InvalidParameterValue.Malformed | Invalid input parameter format. |
5. Example
Example 1 Query a protocol port template group
Input example
https://vpc.tencentcloudapi.com/?Action=DescribeServiceTemplateGroups
&Version=2017-03-12
&Filters.0.Name=service-template-group-name
&Filters.0.Values.0=TestName
&Limit=2
&<Common request parameters>
Output example
{
"Response": {
"RequestId": "20569756-56ba-4a13-b545-e1528d5cb239",
"ServiceTemplateGroupSet": [
{
"CreatedTime": "2018-04-03 22:05:32",
"ServiceTemplateGroupId": "ppmg-2klmrefu",
"ServiceTemplateGroupName": "TestName",
"ServiceTemplateIdSet": [
"ppm-529nwwj8",
"ppm-4dw6agho"
]
},
{
"CreatedTime": "2018-04-03 22:04:35",
"ServiceTemplateGroupId": "ppmg-q7yx1ol4",
"ServiceTemplateGroupName": "TestName",
"ServiceTemplateIdSet": [
"ppm-529nwwj8",
"ppm-4dw6agho"
]
}
],
"TotalCount": 6
}
}
6. Other Resources
Cloud API 3.0 comes with the following development tools to make it easier to call the API.