第 44 章 Network Policy Service
44.1. Network Policy Service 复制链接链接已复制到粘贴板!
44.1.1. ApplyNetworkPolicy 复制链接链接已复制到粘贴板!
POST /v1/networkpolicies/apply/{clusterId}
44.1.1.1. 描述 复制链接链接已复制到粘贴板!
44.1.1.2. 参数 复制链接链接已复制到粘贴板!
44.1.1.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.1.2.2. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 修改 | X |
44.1.1.3. 返回类型 复制链接链接已复制到粘贴板!
对象
44.1.1.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.1.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
44.1.1.6. Samples 复制链接链接已复制到粘贴板!
44.1.2. ApplyNetworkPolicyYamlForDeployment 复制链接链接已复制到粘贴板!
POST /v1/networkpolicies/apply/deployment/{deploymentId}
44.1.2.1. 描述 复制链接链接已复制到粘贴板!
44.1.2.2. 参数 复制链接链接已复制到粘贴板!
44.1.2.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| deploymentId | X | null |
44.1.2.2.2. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文(body) | X |
44.1.2.3. 返回类型 复制链接链接已复制到粘贴板!
对象
44.1.2.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.2.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
44.1.2.6. Samples 复制链接链接已复制到粘贴板!
44.1.3. GenerateNetworkPolicies 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/generate/{clusterId}
44.1.3.1. 描述 复制链接链接已复制到粘贴板!
44.1.3.2. 参数 复制链接链接已复制到粘贴板!
44.1.3.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.3.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| deleteExisting | - NONE: 不删除任何现有网络策略。- GENERATED_ONLY: 删除任何现有 自动生成的 网络策略。- ALL:删除对应命名空间中的所有网络策略。 | - | UNKNOWN | |
| networkDataSince | - | null | ||
| includePorts | - | null |
44.1.3.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.3.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.3.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.3.6. Samples 复制链接链接已复制到粘贴板!
44.1.4. GetAllowedPeersFromCurrentPolicyForDeployment 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/allowedpeers/{id}
44.1.4.1. 描述 复制链接链接已复制到粘贴板!
44.1.4.2. 参数 复制链接链接已复制到粘贴板!
44.1.4.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
44.1.4.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.4.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.4.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.4.6. Samples 复制链接链接已复制到粘贴板!
44.1.5. GetBaselineGeneratedNetworkPolicyForDeployment 复制链接链接已复制到粘贴板!
POST /v1/networkpolicies/generate/baseline/{deploymentId}
44.1.5.1. 描述 复制链接链接已复制到粘贴板!
44.1.5.2. 参数 复制链接链接已复制到粘贴板!
44.1.5.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| deploymentId | X | null |
44.1.5.2.2. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 正文(body) | NetworkPolicyServiceGetBaselineGeneratedNetworkPolicyForDeploymentBody | X |
44.1.5.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.5.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.5.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.5.6. Samples 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/baselinecomparison/{id}
44.1.6.1. 描述 复制链接链接已复制到粘贴板!
44.1.6.2. 参数 复制链接链接已复制到粘贴板!
44.1.6.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
44.1.6.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.6.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.6.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.6.6. Samples 复制链接链接已复制到粘贴板!
44.1.7. GetDiffFlowsFromUndoModificationForDeployment 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/undobaselinecomparison/{id}
44.1.7.1. 描述 复制链接链接已复制到粘贴板!
44.1.7.2. 参数 复制链接链接已复制到粘贴板!
44.1.7.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
44.1.7.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.7.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.7.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.7.6. Samples 复制链接链接已复制到粘贴板!
44.1.8. GetNetworkGraph 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/cluster/{clusterId}
44.1.8.1. 描述 复制链接链接已复制到粘贴板!
44.1.8.2. 参数 复制链接链接已复制到粘贴板!
44.1.8.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.8.2.2. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| includePorts | 如果设置为 true,请在网络策略图中包含端口级别信息。 | - | null | |
| scope.query | - | null |
44.1.8.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.8.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.8.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.8.6. Samples 复制链接链接已复制到粘贴板!
44.1.9. GetNetworkGraphEpoch 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/graph/epoch
44.1.9.1. 描述 复制链接链接已复制到粘贴板!
44.1.9.2. 参数 复制链接链接已复制到粘贴板!
44.1.9.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | - | null |
44.1.9.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.9.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.9.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.9.6. Samples 复制链接链接已复制到粘贴板!
44.1.10. GetNetworkPolicies 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies
44.1.10.1. 描述 复制链接链接已复制到粘贴板!
44.1.10.2. 参数 复制链接链接已复制到粘贴板!
44.1.10.2.1. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | - | null | ||
| deploymentQuery | - | null | ||
| namespace | - | null |
44.1.10.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.10.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.10.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.10.6. Samples 复制链接链接已复制到粘贴板!
44.1.11. GetNetworkPolicy 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/{id}
44.1.11.1. 描述 复制链接链接已复制到粘贴板!
44.1.11.2. 参数 复制链接链接已复制到粘贴板!
44.1.11.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
44.1.11.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.11.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.11.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.11.6. Samples 复制链接链接已复制到粘贴板!
44.1.12. GetUndoModification 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/undo/{clusterId}
44.1.12.1. 描述 复制链接链接已复制到粘贴板!
44.1.12.2. 参数 复制链接链接已复制到粘贴板!
44.1.12.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.12.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.12.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.12.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.12.6. Samples 复制链接链接已复制到粘贴板!
44.1.13. GetUndoModificationForDeployment 复制链接链接已复制到粘贴板!
GET /v1/networkpolicies/undo/deployment/{id}
44.1.13.1. 描述 复制链接链接已复制到粘贴板!
44.1.13.2. 参数 复制链接链接已复制到粘贴板!
44.1.13.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| id | X | null |
44.1.13.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.13.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.13.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |
44.1.13.6. Samples 复制链接链接已复制到粘贴板!
44.1.14. SendNetworkPolicyYAML 复制链接链接已复制到粘贴板!
POST /v1/networkpolicies/simulate/{clusterId}/notify
44.1.14.1. 描述 复制链接链接已复制到粘贴板!
44.1.14.2. 参数 复制链接链接已复制到粘贴板!
44.1.14.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.14.2.2. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 修改 | X |
44.1.14.2.3. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| notifierIds |
| - | null |
44.1.14.3. 返回类型 复制链接链接已复制到粘贴板!
对象
44.1.14.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.14.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 |
|
| 0 | 意外错误响应。 |
44.1.14.6. Samples 复制链接链接已复制到粘贴板!
44.1.15. SimulateNetworkGraph 复制链接链接已复制到粘贴板!
POST /v1/networkpolicies/simulate/{clusterId}
44.1.15.1. 描述 复制链接链接已复制到粘贴板!
44.1.15.2. 参数 复制链接链接已复制到粘贴板!
44.1.15.2.1. 路径参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| clusterId | X | null |
44.1.15.2.2. 正文参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| 修改 | X |
44.1.15.2.3. 查询参数 复制链接链接已复制到粘贴板!
| Name | 描述 | 必填 | default | pattern |
|---|---|---|---|---|
| query | - | null | ||
| includePorts | 如果设置为 true,请在网络策略图中包含端口级别信息。 | - | null | |
| includeNodeDiff | - | null | ||
| scope.query | - | null |
44.1.15.3. 返回类型 复制链接链接已复制到粘贴板!
44.1.15.4. 内容类型 复制链接链接已复制到粘贴板!
- application/json
44.1.15.5. 响应 复制链接链接已复制到粘贴板!
| 代码 | 消息 | datatype |
|---|---|---|
| 200 | 成功响应。 | |
| 0 | 意外错误响应。 |