DescribeSecurityTemplateBindings
1. API Description
Domain name for API request: teo.intl.tencentcloudapi.com.
This API is used to query bindings of a policy template.
A maximum of 20 requests can be initiated per second for this API.
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: DescribeSecurityTemplateBindings. |
| Version | Yes | String | Common Params. The value used for this API: 2022-09-01. |
| Region | No | String | Common Params. This parameter is not required. |
| ZoneId | Yes | String | ID of the site to query |
| TemplateId.N | Yes | Array of String | ID of the policy template to query. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| SecurityTemplate | Array of SecurityTemplateBinding | Bindings of the specified policy template. When a domain name of a site is bound with the specified policy template, TemplateScope includes the ZoneId of the related site and the bindings of the domain name. Note: If the template is not bound with any domain name, and there is not any existing binding, TemplateScope=0 is returned.In the binding list, the same domain name may appear repeatedly in the EntityStatus list with different Status. For example, when a domain name is being bound to another policy template, it's marked both online and pending. |
| 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 Querying bindings of a policy template
This API returns all bindings of a policy template.
Status=online: The binding is taking effect.Status=pending: The binding is establishing.
Note: A domain name may appear multiple times in the bindings list with different status.
In this example, we query the bindings of the policy template temp-fjsoelx under the site example.com (site ID: zone-fdsjkfsda).
Note: The output contains completed and on-going bindings. The policy template is applied to these two domain names. abc.example.com is bound to the policy template specified by the request, and the policy runs normally. The binding status is online. xyz.example.com is being bound to another policy template. The new binding is not yet completed, and the current policy template is still valid. So it appears in both the online and pending list.
Input Example
POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityTemplateBindings
<Common request parameters>
{
"ZoneId": "zone-fdsjjkfsda",
"TemplateId": [
"temp-fjsoelx"
]
}
Output Example
{
"Response": {
"SecurityTemplate": [
{
"TemplateId": "temp-fjsoelx",
"TemplateScope": [
{
"ZoneId": "zone-fdsjjkfsda",
"EntityStatus": [
{
"Entity": "abc.example.com",
"Status": "online",
"Message": ""
},
{
"Entity": "xyz.example.com",
"Status": "online",
"Message": ""
},
{
"Entity": "xyz.example.com",
"Status": "pending",
"Message": ""
}
]
}
]
}
],
"RequestId": "17d437bc-13a9-49bb-a6ac"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- 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 Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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 |
|---|---|
| InternalError.ProxyServer | An unknown error occurred in the backend server. |
| UnauthorizedOperation.CamUnauthorized | CAM is not authorized. |
| UnauthorizedOperation.NoPermission | The sub-account is not authorized for the operation. Please get permissions first. |
| UnauthorizedOperation.Unknown | An unknown error occurred in the backend server. |