开发者社区 问答 正文

API是什么意思?


日志服务(Log Service,简称 LOG)是针对日志平台化服务。服务提供各种类型日志的实时收集、存储和分发。除此之外,LOG 有 ODPS Table 间同步服务,通过 LOG 可以将日志投递至 ODPS 做大数据分析。
除了通过 管理控制台 进行操作外,LOG 还提供了 API(Application Programming Interface)方式写入、查询日志数据,管理自己的项目及日志库等。目前开放如下 API:

对象方法
Log(日志)日志、日志组表示等基本概念
Config (配置)ListCreateDeleteGetUpdate
GetAppliedMachineGroups(查询应用到的机器组)
MachineGroup (机器组)ListCreateDeleteGetUpdate
Apply/Remove(应用/删除配置)
GetAppliedConfigs(查询已应用配置列表)
LogStore (日志库)ListCreateDeleteGetUpdate
GetLogs(查询日志)、GetHistograms(查询日志分布)
Shard (分区)ListSplitMergeDelete
PostLogStoreLogs(写入日志)
GetCursor(定位日志位置)
PullLogs(消费日志)
Shipper(日志投递规则)GetShipperStatus(查询日志投递任务状态)
RetryShipperTask(重试失败投递任务)

通过 API 可以操作下列服务:

[backcolor=transparent]说明:
  • API 目前提供 Rest 风格。
  • 为使用 API,需要知道 API访问地址
  • API 所有请求都需要做安全验证,请参考 请求签名 解释了具体的 API 请求签名机制及流程。
  • Log Service 支持 RAM、STS,RAM 子用户使用 API,和一般云账号没有区别,使用子用户的 AK 签名即可。STS 临时身份除了临时 AK 外,还需要填写一个特殊的 HTTP header,详见 文档,这个 HTTP header 需要参与签名,详见 文档

展开
收起
轩墨 2017-10-23 13:35:21 2221 分享 版权
阿里云 AI 助理回答

阿里云日志服务(Log Service,简称 LOG)是一个全面的日志平台化解决方案,它支持实时收集、存储和分发多种类型日志数据,并且能够将日志投递至ODPS进行大数据分析。除了通过管理控制台操作外,LOG还提供了丰富的API接口来实现更灵活的编程访问与自动化管理,具体包括但不限于以下功能:

  1. 日志管理

    • 日志操作:通过API可以创建、查询、更新及删除日志组(LogGroup)和日志(Log),以及获取日志分布情况。
    • 写入与读取日志:利用PostLogStoreLogs API向指定日志库(LogStore)写入日志,使用GetLogs查询日志内容,GetHistograms查看日志分布统计。
  2. 资源管理

    • 配置与机器组:管理配置(Config)如采集规则,操作机器组(MachineGroup)以应用或移除配置,查询已应用的配置列表。
    • 日志库管理:包括创建、列出、删除、更新日志库,以及对日志库内的分区(Shard)进行分裂、合并等操作。
  3. 数据消费与投递

    • 日志消费:使用GetCursor定位读取位置,通过PullLogs实现日志的消费。
    • 日志投递:管理日志投递规则(Shipper),查询投递任务状态,重试失败的投递任务。
  4. 安全与访问控制

    • 访问控制:支持通过RAM(Resource Access Management)子用户和STS(Security Token Service)临时凭证进行API调用,确保不同用户权限的隔离与安全。
    • 签名验证:所有API请求需通过安全验证,采用Rest风格,需要根据请求签名机制生成签名,对于STS用户还需在HTTP header中包含特定信息参与签名过程。

为了使用这些API,开发者需了解API访问地址,并遵循请求签名流程确保每次调用的安全性。RAM子用户可直接使用其AccessKey进行签名,而STS用户则需额外处理特定HTTP头的签名要求。这为自动化运维、二次开发及集成第三方系统提供了强大的灵活性和便利性。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答