文档中心

日志服务

请输入

调用方式

请求结构

本文档介绍日志服务 OpenAPI 请求的基本结构。

日志服务 OpenAPI 请求主要由三部分构成：

每篇 API 文档均给出了请求示例供您参考，请在发起请求前自行编码。接口调用成功会显示返回参数，调用失败则显示相应报错，您可以根据错误码分析排查。

请求 URL

您可以通过发送 HTTPS 请求来调用日志服务的 API 服务。HTTPS 请求 URL 的格式如下：

其中：

参数	说明
tls-endpoint	日志服务的服务地址（Endpoint），即指定承载服务端点的服务器域名或 IP。其中 Region 为日志项目所在地域。详细说明请参考服务地址。
Action	要执行的操作。请填写要调用的 API 接口。日志服务的 API 接口请参考 API 概览。
parameters	API 在 URL 中的的请求参数。查询类 API 接口需要在请求 URL 中传递业务参数，例如 Describe* 等 API。其他 API 接口直接在 Body 中传递业务参数。
公共请求参数	业务需要的其他公共请求参数。

以查看日志项目（DescribeProjects）为例，未编码的 HTTPS 请求 URL 如下。

HTTP 请求的请求头（Header）中需要指定 Content-Type 和请求鉴权信息等公共参数，用于标识用户和接口签名。若非必要，每个单独的接口文档中不再对这些参数进行说明，但每次请求均需要携带这些参数，才能正常发起请求。

其中，Content-type 指定了请求消息体的结构化格式，日志服务的 Content-Type 固定为 application/json。详细的参数列表及说明请参考公共参数。

请求 Body

请求 Body，即请求消息体，主要传递业务相关的请求参数。若请求消息体中参数支持中文，则中文字符必须为 UTF-8 编码。

每个接口的请求消息体内容不同，也并非每个接口都需要有请求消息体（即消息体为空），调用接口时，请参考各个 API 接口文档构建请求消息体。

请求方法

请求方法用于向服务器传递当前请求的操作类型，日志服务支持的 HTTP 请求方法如下。

发起请求

可以使用 curl、Postman 或直接编写代码等方式发送请求调用 API。例如 ModifyProject 接口的请求示例如下：

最近更新时间：2025.11.26 17:23:56

这个页面对您有帮助吗？

有用

无用