1. 接口描述
接口请求域名: alb.tencentcloudapi.com 。
查询自定义安全策略列表,支持按安全策略 ID、名称或标签进行筛选,并支持分页查询。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeSecurityPolicies。 |
| Version | 是 | String | 公共参数,本接口取值:2025-10-30。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 过滤条件列表,用于筛选符合指定条件的安全策略。多个过滤条件之间为"与"关系。 支持的过滤条件: - SecurityPolicyNames:按安全策略名称筛选,支持模糊匹配。 - tag:tag-key:按标签键值对筛选,tag-key 请替换为实际的标签键。例如 tag:env 表示按标签键 env 筛选。说明: 每个过滤条件最多支持 10 个取值。 |
| MaxResults | 否 | Integer | 单次请求返回的最大结果数。用于分页查询,与 NextToken 配合使用。 取值范围: 1~100。 默认值: 20。 示例值:20 |
| NextToken | 否 | String | 分页查询的起始令牌。用于获取下一页结果数据。 使用说明: - 首次查询时无需设置此参数。 - 如果上一次查询返回了 NextToken,表示还有更多数据,请将该值传入此参数以获取下一页。 - 若上一次查询未返回 NextToken 或返回为空,表示已是最后一页。 示例值:3974ae26e*** |
| SecurityPolicyIds.N | 否 | Array of String | 安全策略 ID 列表,ID 格式为 tls- 后接 8 位字母数字。 示例值:["tls-t2ckydug"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| NextToken | String | 下一页查询的起始令牌。 - 若返回值不为空,表示还有更多数据,可将此值作为下一次请求的 NextToken 参数继续查询。 - 若返回值为空或未返回此字段,表示已是最后一页。 示例值:3974ae26e*** |
| SecurityPolicies | Array of SecurityPolicyInfo | 安全策略信息列表。包含每个安全策略的详细配置,如策略 ID、名称、TLS 版本、加密套件等。 |
| TotalCount | Integer | 符合过滤条件的安全策略总数。 说明: 此值表示满足查询条件的总记录数,而非本次返回的记录数。可用于计算分页信息。 示例值:3 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询自定义安全策略
输入示例
POST / HTTP/1.1
Host: alb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityPolicies
<公共请求参数>
{
"MaxResults": 20,
"SecurityPolicyIds": [
"tls-t2ckydug"
]
}
输出示例
{
"Response": {
"NextToken": "",
"SecurityPolicies": [
{
"SecurityPolicyId": "tls-t2ckydug",
"SecurityPolicyName": "test-policy",
"Status": "Active",
"TLSVersions": [
"TLSv1.2",
"TLSv1.3"
],
"Ciphers": [
"TLS_AES_128_GCM_SHA256"
],
"CreateTime": "2025-01-01T08:30:00+08:00",
"Tags": []
}
],
"TotalCount": 1,
"RequestId": "3b848733-70e5-4558-ae39-4b9938eb7609"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidFieldValue | 字段值错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RegionError | 地域错误 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |