使用前必读
API 密钥
在调用 API 前,需要先在管理控制台申请 API 密钥,获取 API 密钥 ID ( access_key_id ) 和 API 密钥私钥 ( secret_access_key )。
- 密钥 ID 将作为参数包含在每一个请求中发送。
- 密钥私钥负责生成请求串的签名进行鉴权。
请求方法
边界路由器开放的所有资源操作相关的 API,均支持通过 HTTPS GET 方式进行调用。
请求类型
API 请求主要分为 延迟请求 和 实时请求 两种。
-
延迟请求
对于耗时请求,无法实时返回执行结果。这些请求将以任务形式提交给后台执行,并会在 API 请求返回中返回任务 ID ( job_id )。这种情况下,用户可以通过查看资源状态来判断任务是否执行完成。
例如,在提交
RunInstances
操作之后,用户可以通过DescribeInstances
查看 Instance 的状态确认 Instance 是否创建成功。 -
实时请求
对于非耗时请求,会直接返回操作结果。
请求限制
-
配额限制
为了保证用户能合理地使用 API,目前初始用户 API 访问配额限制为 2000次 / 3600秒,未来会开放更高的配额。
-
返回数据集长度限制
当获取资源列表时,系统返回的最大数据长度是 100 ,即便配置了
limit
。若需要获取很多的数据时,请根据返回的total_sum
(根据请求时的过滤参数,得到的数据集总数)分批获取。