创建 Grafana 集成配置

最近更新时间：2024-03-12 01:41:03

我的收藏

本页目录：

1. 接口描述

接口请求域名： monitor.tencentcloudapi.com 。

创建 Grafana 集成配置，其中 Prometheus 集成不通过该接口创建，可参考 BindPrometheusManagedGrafana 接口

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateGrafanaIntegration。
Version	是	String	公共参数，本接口取值：2018-07-24。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	Grafana 实例 ID，例如：grafana-abcdefgh 示例值：my-instance
Kind	是	String	集成类型(接口DescribeGrafanaIntegrationOverviews返回的集成信息中的Code字段) 示例值：grafana
Content	是	String	集成配置示例值：[]

3. 输出参数

参数名称	类型	描述
IntegrationId	String	集成 ID 注意：此字段可能返回 null，表示取不到有效值。示例值：integration-xxxxxxxx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建 Kong 集成配置

创建 Kong 集成配置（name 和 url 必填，user、password、labels、organizationIds 都是选填，选填的字段如果不填可直接删除）

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGrafanaIntegration
<公共请求参数>

{
    "InstanceId": "grafana-test",
    "Content": "{\"kind\":\"tencent-cloud-kong\",\"spec\":{\"dataSourceSpec\":{\"name\":\"prometheus-kong\",\"url\":\"http://10.0.0.0:9090/\",\"user\":\"user\",\"password\":\"password\",\"labels\":{\"label\":\"test\"}},\"grafanaSpec\":{\"organizationIds\":[\"2\"]}}}",
    "Kind": "tencent-cloud-prometheus"
}

输出示例

{
    "Response": {
        "IntegrationId": "integration-test",
        "RequestId": "requestid"
    }
}

示例2 创建 Prometheus 集成-使用密钥

创建 Prometheus 集成-使用密钥（name、secretId 和 secretKey 必填，organizationIds 是选填，选填的字段如果不填可直接删除）

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGrafanaIntegration
<公共请求参数>

{
    "InstanceId": "grafana-test",
    "Kind": "tencentcloud-monitor-app",
    "Content": "{\"kind\":\"tencentcloud-monitor-app\",\"spec\":{\"dataSourceSpec\":{\"name\":\"prometheus-monitor\",\"authProvider\":{\"__anyOf\":\"使用密钥\",\"secretId\":\"AKIDtest\",\"secretKey\":\"test\"}},\"grafanaSpec\":{\"organizationIds\":[\"2\"]}}}"
}

输出示例

{
    "Response": {
        "IntegrationId": "integration-test",
        "RequestId": "requestid"
    }
}

示例3 创建日志服务集成-使用密钥

创建日志服务集成-使用密钥（name、secretId 和 secretKey 必填，organizationIds 是选填，选填的字段如果不填可直接删除）

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateGrafanaIntegration
<公共请求参数>

{
    "InstanceId": "grafana-test",
    "Kind": "tencent-cls-grafana-datasource-v2",
    "Content": "{\"kind\":\"tencent-cls-grafana-datasource-v2\",\"spec\":{\"dataSourceSpec\":{\"name\":\"prometheus-cls\",\"authProvider\":{\"__anyOf\":\"使用密钥\",\"secretId\":\"AKIDtest\",\"secretKey\":\"test\"}},\"grafanaSpec\":{\"organizationIds\":[\"2\"]}}}"
}

输出示例

{
    "Response": {
        "IntegrationId": "integration-test",
        "RequestId": "requestid"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。

下一篇: 更新历史