Sangfor SCP平台API接口文档：调用与流控策略

"Sangfor SCP平台开放API接口的使用指南" Sangfor SCP平台提供了开放API接口，旨在支持系统的集成和二次开发工作。这使得用户能够利用这些接口自定义功能，自动化任务，或者将SCP平台的功能与其他系统无缝对接。本文档主要介绍了SCP平台API的基本信息、调用规则以及请求头的相关参数。 1. **使用前必读** - **概述**：虽然文档中这部分未给出详细信息，通常概述会包含API的主要目的、适用范围以及对开发者的基本要求。 - **接口调用说明**：同样待完善，接口调用说明通常会涵盖如何发起请求、请求格式、响应格式等关键信息。 2. **接口调用说明** - SCP平台的API基于RESTful架构，这意味着它们以HTTP方法（如GET、POST、PUT、DELETE）来操作资源，且支持HTTPS协议。在调用时，需要关闭SSL证书校验，这可能是因为SCP平台允许开发者在测试环境中不严格验证证书。 3. **注意事项** - **HCI资源池**：要求版本为5.8.8R6及以上，确保了API与平台的兼容性。 - **支持角色**：API可供管理员（admin）和租户使用，表明不同的权限级别可以访问不同的API资源。 4. **如何调用API** - **请求方法**：文档中列出了GET、POST、PUT和DELETE四种常见的HTTP方法及其每分钟的调用次数限制，防止过度使用导致服务不稳定。 - **接口流控策略**：每个请求方法在1分钟内的最大调用次数设定为：GET - 600次，POST、PUT、DELETE - 100次。如果超出限制，调用者的IP将被短暂禁用。 5. **请求消息头** - 请求消息头包含了一些必要的参数，如： - **Content-Type**：指明请求的报文类型，默认为`application/json`，表示数据以JSON格式传输。 - **Cookie**：包含了SDK-API的验证信息，特别是`aCMPAuthToken`字段，必须提供，其值通常是一个UUID。 - **Authorization**：用于认证的参数，支持AWS4-HMAC-SHA256和Token两种方式。 - **X-Amz-Date**：请求的当前时间，用于签名校验，格式遵循ISO8601标准。 举例来说，一个完整的Authorization头可能如下所示，展示了一种AWS4-HMAC-SHA256的认证方式： ``` Authorization: Credential=be763c9968a143a99e1998ccce7594c7/20210104/cn-east-1/dsp-api/aws4_request, SignedHeaders=path;x-amz-date, Signature=b8701b453ea3c8faaf566fee ``` Sangfor SCP平台的开放API接口为开发者提供了丰富的工具，允许他们利用这些接口来扩展和定制SCP平台的功能。在实际使用中，开发者需要遵循接口调用的规则，注意流控策略，正确设置请求消息头中的认证信息，以确保安全、有效地使用这些API。