PDF《日志服务》

日志服务 API 参考 API 参考 概览 日志服务(Log Service,简称 LOG)是针对日志平台化服务.

服务提供各种类型日志的实时收集、存储和分 发.除此之外,LOG 有ODPS Table 间同步服务,通过 LOG 可以将日志投递至 ODPS 做大数据分析. 除了通过 管理控制台 进行操作外,LOG 还提供了 API(Application Programming Interface)方式写入、查 询日志数据,管理自己的项目及日志库等.目前开放如下 API: 对象 方法 Log(日志) 日志、日志组表示等基本概念 Config (配置) List、Create、 Delete、Get、 Update GetAppliedMachineGroups( 查询应用到的机器组) MachineGroup (机器组) List、Create、Delete、Get、 Update Apply/Remove(应用/删除配 置) GetAppliedConfigs(查询已应 用配置列表) LogStore (日志库) List、Create、 Delete、Get、 Update GetLogs(查询日志)、 GetHistograms(查询日志分 布) Shard (分区) List、Split、Merge、Delete PostLogStoreLogs(写入日志 ) GetCursor(定位日志位置) PullLogs(消费日志) Shipper(日志投递规则) GetShipperStatus(查询日志 投递任务状态) RetryShipperTask(重试失败 投递任务) 日志服务 API 参考

1 - - - - - - - 通过 API 可以操作下列服务: 根据 配置,机器组 信息收集日志 创建 日志库、向日志库写入、读取日志 对不同用户进行 访问控制 说明: API 目前提供 Rest 风格. 为使用 API,需要知道 API访问地址. API 所有请求都需要做安全验证,请参考 请求签名 解释了具体的 API 请求签名机制及流程. Log Service 支持 RAM、STS,RAM 子用户使用 API,和一般云账号没有区别,使用子用户的 AK 签名即可.STS 临时身份除了临时 AK 外,还需要填写一个特殊的 HTTP header,详见 文档,这个 HTTP header 需要参与签名,详见 文档. 服务入口 公网服务入口 日志服务入口是访问一个项目(Project)及其内部日志数据的 URL.它和 Project 所在的阿里云区域 (Region)及Project 名称相关.目前,日志服务已经在多个阿里云 Region 下开通,在各 Region 内的公网 服务入口如下: 当访问某个具体的 Project 时,需要根据 Project 名称及其所在 Region 组合出最终访问地址.具体格式如下 : 例如,Project 名为 big-game,所在区域为 华东

1 (杭州) ,则对应访问地址如下: 地域 服务入口 华东

1 (杭州) cn-hangzhou.log.aliyuncs.com 华东

2 (上海) cn-shanghai.log.aliyuncs.com 华东

1 (杭州-金融云, 不支持公网访问) cn-hangzhou-finance- intranet.log.aliyuncs.com 华北

1 (青岛) cn-qingdao.log.aliyuncs.com 华北

2 (北京) cn-beijing.log.aliyuncs.com 华南

1 (深圳) cn-shenzhen.log.aliyuncs.com . 日志服务 API 参考

2 在创建日志服务项目时需要指定某个 Region.一旦在创建时指定了 Region,该设置就不可以更改,且无 法跨区域迁移项目.创建 Project 之后,必须选择与其所在区域相匹配的根服务入口地址来组成该 Project 访问地址,用做 API 请求的服务入口. 经典网络服务入口 如果在阿里云的 ECS 机器内使用日志服务 API,还可以使用内网服务入口(使用内网服务入口访问日志服务不 消耗 ECS 公网流量,可以节约宝贵的 ECS 公网带宽),各个 Region 的日志服务内网根服务入口如下: 如上例,其内网访问地址如下: VPC 网络服务入口 如果使用的 ECS 机器为 VPC 网络,可以使用日志服务 VPC 区域服务入口,各个 Region 的日志服务 VPC 根 服务入口如下: big-game.cn-hangzhou.log.aliyuncs.com 地域 根服务入口 华东

1 (杭州) cn-hangzhou-intranet.log.aliyuncs.com 华东

2 (上海) cn-shanghai-intranet.log.aliyuncs.com 华东

1 (杭州-金融云) cn-hangzhou-finance- intranet.log.aliyuncs.com 华北

1 (青岛) cn-qingdao-intranet.log.aliyuncs.com 华北

2 (北京) cn-beijing-intranet.log.aliyuncs.com 华南

1 (深圳) cn-shenzhen-intranet.log.aliyuncs.com 华南

1 (深圳-金融云) 无经典网络虚拟机,统一使用 VPC 网络服务入口 香港 cn-hongkong-intranet.log.aliyuncs.com 美国西部

1 (硅谷) us-west-1-intranet.log.aliyuncs.com big-game.cn-hangzhou-intranet.log.aliyuncs.com 地域 根服务入口 华东

1 (杭州) cn-hangzhou-vpc.log.aliyuncs.com 华东

2 (上海) cn-shanghai-vpc.log.aliyuncs.com 华北

1 (青岛) cn-qingdao-vpc.log.aliyuncs.com 华北

2 (北京) cn-beijing-vpc.log.aliyuncs.com 日志服务 API 参考

3 如上例,其VPC 网络访问地址如下: 目前,日志服务 API 服务在如上服务入口上仅支持 HTTP 协议. 访问密钥 阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的 安全口令 .您可以用它来签 名API 请求内容以通过服务端的安全验证. 该访问秘钥成对(AccessKeyId 与AccessKeySecret)生成和使用.每个阿里云用户可以创建多对访问秘钥 ,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对. 您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对.由于访问秘钥是阿里云对 API 请求 进行安全验证的关键因子,请妥善保管你的访问秘钥.如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对 并生成新的替代秘钥对. 公共请求头 Log Service API 是基于 HTTP 协议的 Rest 风格接口.它支持一组可以在所有 API 请求中使用的公共请求头 (除特别说明,每个 Log Service API 请求都必须提供这些公共请求头),其详细定义如下: 华北

3 (张家口) cn-zhangjiakou-vpc.log.aliyuncs.com 华南

1 (深圳) cn-shenzhen-vpc.log.aliyuncs.com 华南

1 (深圳-金融云) cn-shenzhen-finance-vpc.log.aliyuncs.com 香港 cn-hongkong-vpc.log.aliyuncs.com 亚太东北

1 (东京) ap-northeast-1-vpc.log.aliyuncs.com 亚太东南

1 (新加坡) ap-southeast-1-vpc.log.aliyuncs.com 亚太东南

2 (悉尼) ap-southeast-2-vpc.log.aliyuncs.com 中东东部

1 (迪拜) me-east-1-vpc.log.aliyuncs.com 美国西部

1 (硅谷) us-west-1-vpc.log.aliyuncs.com 欧洲中部

1 (法兰克福) eu-central-1-vpc.log.aliyuncs.com big-game.cn-hangzhou-vpc.log.aliyuncs.com Header 名称 类型 说明 Accept 字符串 客户端希望服务端返回的类型 ,目前支持 application/json、 日志服务 API 参考

4 application/x-protobuf 两种 ,该字段为非必选参数,仅对 GET 请求有效.具体取值以各 个接口定义为准. Accept-Encoding 字符串 客户端希望服务端返回的压缩算 法,目前支持 lz

4、 deflate 或空(不压缩).该字段为非必选 参数,仅对 GET 类请求有效. 具体取值以各个接口定义为准. Authorization 字符串 签名内容,更多细节请参考 请 求签名. Content-Length 数值 RFC

2616 中定义的 HTTP 请求 Body 长度.如果请求无 Body 部分,则不需要提供该请求头. Content-MD5 字符串 请求 Body 经过 MD5 计算后的 字符串,计算结果为大写.如果 没........