1. 接口描述
接口请求域名: tcss.tencentcloudapi.com 。
容器网络集群查看策略详情
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeNetworkFirewallPolicyDetail。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-01。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Id | 是 | Integer | 策略Id 示例值:23 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ClusterId | String | 集群Id 示例值:cls-jvrv0kf2 |
PolicyName | String | 策略名 示例值:test |
Namespace | String | 命名空间 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
FromPolicyRule | Integer | 入站类型 示例值:2 |
ToPolicyRule | Integer | 出站类型 示例值:2 |
CustomPolicy | Array of NetworkCustomPolicy | 自定义规则 注意:此字段可能返回 null,表示取不到有效值。 |
PodSelector | String | pod选择器 示例值:a=b |
Description | String | 策略描述 注意:此字段可能返回 null,表示取不到有效值。 示例值:describe content |
PolicyCreateTime | String | 策略创建时间 示例值:2021-10-01 |
PolicySourceType | String | 策略源类型,分为System和Manual,分别代表手动和系统添加 示例值:System |
NetworkPolicyPlugin | String | 网络策略对应的网络插件 注意:此字段可能返回 null,表示取不到有效值。 示例值:KubeRouter |
PublishStatus | String | 网络策略状态 示例值:PublishedNoConfirm |
PublishResult | String | 网络发布结果 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 容器网络集群查看策略详情示例
输入示例
POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeNetworkFirewallPolicyDetail
<公共请求参数>
{
"Id": 1
}
输出示例
{
"Response": {
"PolicyName": "xx",
"CustomPolicy": [
{
"Peer": [
{
"NamespaceSelector": "xx",
"PeerType": "xx",
"PodSelector": "xx",
"IPBlock": "xx"
}
],
"Direction": "xx",
"Ports": [
{
"Protocol": "xx",
"Port": "xx"
}
]
}
],
"Description": "xx",
"ClusterId": "xx",
"FromPolicyRule": 0,
"PublishResult": "xx",
"Namespace": "xx",
"NetworkPolicyPlugin": "xx",
"PodSelector": "xx",
"PublishStatus": "xx",
"ToPolicyRule": 0,
"RequestId": "xx",
"PolicyCreateTime": "xx",
"PolicySourceType": "xx"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
UnauthorizedOperation | 未授权操作。 |