文档

ListGrafanaWorkspace - 获取Grafana工作区列表

更新时间:

获取地域内Grafana工作区列表。

接口说明

说明:本接口返回列表包含开发者版、专家版、高级版 ,不包含共享版。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。默认为 cn-hangzhou。

cn-hangzhou
ResourceGroupIdstring

Prometheus 实例的资源组 ID。

rg-acfmxyexli2****
Tagsobject []

标签列表。

Keystring

标签键。

TestKey
Valuestring

标签值。

TestValue
AliyunLangstring

语言环境,默认为中文:zh, 英文: en。

zh

返回参数

名称类型描述示例值
object

Schema 返回值。

RequestIdstring

请求 ID。

0080BE65-167F-5CB6-A691-14E2EFD474BC
Dataarray

返回结果。

GrafanaWorkspace

Grafana 工作区信息。

Messagestring

请求参数错误时返回的信息。

success
Codeinteger

状态码。200 表示成功。

200
Successboolean

操作是否成功:true:操作成功 false:操作失败。

True
TraceIdstring

调用链 ID,用于精确查询调用信息。

eac0a8048716731735000007137d000b

示例

正常返回示例

JSON格式

{
  "RequestId": "0080BE65-167F-5CB6-A691-14E2EFD474BC",
  "Data": [
    {
      "status": "Starting、Running、Stop、DeleteSucceed",
      "description": "线上生产环境Grafana",
      "grafanaWorkspaceEdition": "personal_deition、experts_edition、advanced_edition、standard",
      "endTime": 1652803200000,
      "grafanaWorkspaceId": "grafana-cn-4xl3g******",
      "upgradeVersion": [
        "9.0.x"
      ],
      "grafanaWorkspaceIp": "47.110.71.***:443",
      "snatIp": "47.110.71.***",
      "grafanaWorkspaceDomain": "my-grafana.grafana.aliyuncs.com:443",
      "commercial": true,
      "grafanaWorkspaceName": "线上生产环境Grafana",
      "grafanaVersion": "9.0.x",
      "gmtCreate": 1642079398000,
      "userId": "1412143830******",
      "maxAccount": "10",
      "regionId": "cn-hangzhou",
      "protocol": "http、https",
      "shareSynced": true,
      "ntmId": "grafana-cn-4xl3g******",
      "personalDomain": "my-grafana.grafana.aliyuncs.com:443",
      "personalDomainPrefix": "my-grafana",
      "resourceGroupId": "rg-aek2f4vzrfs6cla",
      "deployType": "asi",
      "tags": [
        {
          "key": "TestKey",
          "value": "TestValue"
        }
      ],
      "privateIp": "192.168.1.1\n",
      "privateDomain": "my-grafana.grafana.aliyuncs.com:80"
    }
  ],
  "Message": "success",
  "Code": 200,
  "Success": true,
  "TraceId": "eac0a8048716731735000007137d000b"
}

错误码

HTTP status code错误码错误信息描述
400ParameterMissingYou must specify the parameter.必选参数缺失
400ResourceIdIsIllegalThe specified ResourceId is invalid.参数ResourceId是非法的。
400ParameterIllegalThe specified parameter is invalid.参数非法
403RAMNotAuthorizeThe sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.子账号没有访问权限,需主账号授予AliyunARMSFullAccess。
403STSNotAuthorizeSTS authorization failed.STS权限校验失败
403IllegalUserAccessIllegal user access.非法的用户访问
500InternalErrorInternal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.内部错误,建议重试。如果多次重试报错请联系钉钉服务账号。
500AccountUidAccessErrorFailed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.获取用户信息失败,建议重试。如果多次重试报错请联系钉钉服务账号。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:500
  • 本页导读 (1)
文档反馈