跳转至

脚本开发 / 观测云

观测连接器操作对象主要提供用于数据写入的 DataWay 对象以及 OpenAPI 的封装。

DFF.CONN(...) 参数如下：

参数 类型 必须 / 默认值 说明
connector_id str 必须 连接器 ID

观测云 OpenAPI 文档请参考：

.dataway

dataway 属性为当前观测云对应的 DataWay 操作对象，使用方式与直接创建的观测云 DataWay 连接器操作对象相同。

示例
1
status_code, result = guance.dataway.write_by_category(category='metric', measurement='主机监控', tags={'host': 'web-01'}, fields={'cpu': 10})

完整内容请参考：

.is_api_key_valid / .is_api_key_match

is_api_key_valid / is_api_key_match 属性返回当前连接器的 API Key 是否有效：

示例
1
print(guance.is_api_key_valid)
输出示例
1
True

.workspace

workspace 属性返回当前工作空间信息：

示例
1
2
import json
print(json.dumps(guance.workspace, indent=2))
输出示例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp1",
  "language"    : "zh",
  "timezone"    : "",
  "bossStation" : "CN",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<其他字段略>": "..."
}

.workspace_uuid

workspace_uuid 属性返回当前工作空间 UUID：

示例
1
print(guance.workspace_uuid)
输出示例
1
wksp_xxxxx

.workspace_token

workspace_token 属性返回当前工作空间 Token：

示例
1
print(guance.workspace_token)
输出示例
1
tkn_xxxxx

.workspace_language

workspace_language 属性返回当前工作空间语言：

示例
1
print(guance.workspace_language)
输出示例
1
zh

.do_get(...)

用于向观测云 OpenAPI 发起 GET 请求，参数如下：

参数 类型 必须 / 默认值 说明
path str 必须 路径
query dict 参数
示例
1
2
3
4
import json

result = guance.do_get('/api/v1/workspace/get')
print(json.dumps(result, indent=2))
输出示例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "uuid"        : "wksp_xxxxx",
  "name"        : "xxxxx",
  "rpName"      : "rp1",
  "language"    : "zh",
  "timezone"    : "",
  "bossStation" : "CN",
  "billingState": "normal",
  "versionType" : "pay",
  "token"       : "tkn_xxxxx",
  "cliToken"    : "wkcli_xxxxx",
  "<其他字段略>": "..."
}

.do_post(...)

用于向观测云 OpenAPI 发起 POST 请求，参数如下：

参数 类型 必须 / 默认值 说明
path str 必须 路径
query dict 参数
body dict JSON 请求体
示例
1
2
3
4
body = {
    'desc': '新描述'
}
result = guance.do_post('/api/v1/workspace/modify', body=body)