On this page
/api/serializers
该端点列出了正在运行的 TSD 加载的序列化程序插件。给出的信息包括名称,实现的方法,Content Type 和方法。
Verbs
GET
POST
Requests
没有可用的参数,这是一个只读端点,仅返回系统数据。
Response
响应是一系列序列化程序对象。每个对象都有以下字段:
Field Name | Data Type | Description | Example |
---|---|---|---|
serializer | String | 序列化程序的名称,适合在查询字符串serializer=<serializer_name> 参数中使用 |
xml |
formatters | Array<String> | 序列化程序实现以转换响应数据的方法或端点的数组。这些通常 Map 到端点,例如/api/suggest Map 到Suggest 。如果序列化器未实现某种方法,则默认格式化程序将响应。每个名称还以受支持的 API 版本结尾,例如V1 将支持版本 1 API 调用。 |
"Error","Suggest" |
parsers | Array<String> | 序列化程序实现的方法或端点的数组,用于解析 HTTP 请求正文中的用户 Importing。这些通常 Map 到端点,例如/api/suggest 将 Map 到Suggest 。如果串行器未实现解析器,则将使用默认的串行器。每个名称还以受支持的 API 版本结尾,例如V1 将支持版本 1 API 调用。 |
"Suggest","Put" |
该端点应始终使用 JSON 序列化程序作为默认值返回数据。如果您认为 TSD 应该列出其他格式化程序,请查看插件文档以确保您具有正确的插件,并且该插件位于正确的目录中。
Example Response
[
{
"formatters": [
"SuggestV1",
"SerializersV1",
"ErrorV1",
"ErrorV1",
"NotFoundV1"
],
"serializer": "json",
"parsers": [
"SuggestV1"
],
"class": "net.opentsdb.tsd.HttpJsonSerializer",
"response_content_type": "application/json; charset=UTF-8",
"request_content_type": "application/json"
}
]