/api/uid/uidmeta

该端点允许编辑或删除 UID 元数据信息，即与* metrics ， tag 名称和 tag values *相关联的元数据。一些字段由 TSD 设置，而其他字段可以由用户设置。使用POST方法时，将仅存储请求提供的字段。不包括在内的现有字段将被保留。如果未提供给定字段，则使用PUT方法将使用给定值或默认值覆盖所有用户可变字段。

Note

删除元数据条目不会删除 UID 分配，也不会删除任何数据点或关联的时间序列信息。删除仅删除指定的元数据对象，而不删除实际值。如果查询相同的 UID，您将看到带有空字段的默认元数据。

Verbs

Requests

可以随请求提供的字段包括：

Name Data Type Required Description Default QS RW Example
uid String Required UID 的十六进制表示 uid RO 00002A
type String Required UID 的类型必须为metric，tagk或tagv type RO metric
description String Optional UID 代表的简要说明 description RW 系统处理器时间
displayName String Optional 可以在 GUI 中显示的短名称，而不是默认名称 display_name RW 系统 CPU 时间
notes String Optional 有关 UID 代表的详细说明 notes RW Details
custom Map Optional 键/值 Map 表，用于存储自定义字段和值 null RW See Below

Note

自定义字段不能通过查询字符串传递。您必须使用POST或PUT动词。

Warning

如果您的请求使用PUT，那么您未随请求提供的任何字段都将被其默认值覆盖。例如，description字段将设置为空字符串，而custom字段将重置为null。

GET 请求示例

http://localhost:4242/api/uid/uidmeta?uid=00002A&type=metric

POST 或 PUT 请求示例

Query String:

http://localhost:4242/api/uid/uidmeta?uid=00002A&type=metric&method=post&display_name=System%20CPU%20Time

JSON Content:

{
    "uid":"00002A",
    "type":"metric",
    "displayName":"System CPU Time",
    "custom": {
        "owner": "Jane Doe",
        "department": "Operations",
        "assetTag": "12345"
    }
}

删除请求示例

Query String:

http://localhost:4242/api/uid/uidmeta?uid=00002A&type=metric&method=delete

JSON Content:

{
    "uid":"00002A",
    "type":"metric"
}

Response

对GET，POST或PUT请求的成功响应将返回具有任何给定更改的完整 UID 元数据对象。成功的DELETE呼叫将返回204状态代码且没有正文。修改数据时，如果不存在任何更改，即调用未提供要存储的任何数据，则响应将为304而没有任何正文内容。如果系统中不存在所请求的 UID，则会返回404并显示一条错误消息。如果提供了无效数据，将返回错误。

除其他几个以外，所有 Request 字段都将出现在响应中：

Name Data Type Description Example
name String 存储数据点或分配 UID 时给出的 UID 名称 sys.cpu.0
created Integer 首次创建 UID 时的 Unix 时间戳记(以秒为单位)。如果在分配 UID 时未存储元数据，则此值可能为 0. 1350425579

Example Response

{
    "uid": "00002A",
    "type": "TAGV",
    "name": "web01.mysite.com",
    "description": "Website hosting server",
    "notes": "This server needs a new boot disk",
    "created": 1350425579,
    "custom": {
        "owner": "Jane Doe",
        "department": "Operations",
        "assetTag": "12345"
    },
    "displayName": "Webserver 01"
}
首页