API 中心
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > API 中心

列出用户所有的 Grafana 服务

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

我的收藏

本页目录：

1. 接口描述

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

列出用户所有的 Grafana 服务

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeGrafanaInstances。
Version 是 String 公共参数，本接口取值：2018-07-24。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 是 Integer 查询偏移量
示例值：0
Limit 是 Integer 查询数量
示例值：10
InstanceIds.N 否 Array of String Grafana 实例 ID 数组
示例值：["instance-id"]
InstanceName 否 String Grafana 实例名，支持前缀模糊搜索
示例值：instance-id
InstanceStatus.N 否 Array of Integer 查询状态
示例值：[2]
TagFilters.N 否 Array of PrometheusTag 标签过滤数组

3. 输出参数

参数名称 类型 描述
InstanceSet Array of GrafanaInstanceInfo 已废弃，请使用 Instances
TotalCount Integer 符合查询条件的实例总数
示例值：10
Instances Array of GrafanaInstanceInfo 实例列表
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 列出 Grafana 服务

输入示例

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

{
    "Limit": 20,
    "Offset": 0,
    "TagFilters": [
        {
            "Key": "tagKeyTest",
            "Value": "tagValueTest"
        }
    ],
    "InstanceStatus": [
        2
    ],
    "InstanceName": "test",
    "InstanceIds": [
        "grafana-abcdefgh"
    ]
}

输出示例

{
    "Response": {
        "InstanceSet": [
            {
                "InstanceStatus": 0,
                "VpcId": "xx",
                "RootUrl": "xx",
                "Version": "xx",
                "Zone": "xx",
                "TagSpecification": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "InstanceId": "xx",
                "SubnetIds": [
                    "xx"
                ],
                "RegionId": 0,
                "InstanceChargeType": 0,
                "InternalUrl": "xx",
                "VpcName": "xx",
                "EnableSSOCamCheck": true,
                "SubnetName": "xx",
                "InternetUrl": "xx",
                "EnableSSO": true,
                "InstanceName": "xx",
                "Region": "xx",
                "CreatedAt": "2020-09-22 00:00:00"
            }
        ],
        "TotalCount": 1,
        "RequestId": "xx",
        "Instances": [
            {
                "InstanceStatus": 0,
                "VpcId": "xx",
                "RootUrl": "xx",
                "Version": "xx",
                "Zone": "xx",
                "TagSpecification": [
                    {
                        "Value": "xx",
                        "Key": "xx"
                    }
                ],
                "InstanceId": "xx",
                "SubnetIds": [
                    "xx"
                ],
                "RegionId": 0,
                "InstanceChargeType": 0,
                "InternalUrl": "xx",
                "VpcName": "xx",
                "EnableSSOCamCheck": true,
                "SubnetName": "xx",
                "InternetUrl": "xx",
                "EnableSSO": true,
                "InstanceName": "xx",
                "Region": "xx",
                "CreatedAt": "2020-09-22 00:00:00"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure.AccessCAMFail 访问鉴权失败。
FailedOperation 操作失败。
FailedOperation.AccessTagFail 访问标签服务失败。
FailedOperation.DbQueryFailed 数据库查询失败。
FailedOperation.InternalError 内部服务错误。
FailedOperation.SendRequest 发送授权请求失败。
中国站