ListGrafanaWorkspace - 获取Grafana工作区列表_可观测可视化 Grafana 版(Grafana)-阿里云帮助中心

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

接口说明

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListGrafanaWorkspace	list	GrafanaWorkspace acs:arms:{#regionId}:{#accountId}:grafanaworkspace/*	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。默认为 cn-hangzhou。	cn-hangzhou
ResourceGroupId	string	否	Grafana 实例的资源组 ID。	rg-acfmxyexli2****
Tags	array<object>	否	标签列表。
	object	否	标签。
Key	string	否	标签键。	TestKey
Value	string	否	标签值。	TestValue
AliyunLang	string	否	语言环境，默认为中文：zh，英文： en。	zh

返回参数

名称	类型	描述	示例值
	object	Schema 返回值。
RequestId	string	请求 ID。	0080BE65-167F-5CB6-A691-14E2EFD474BC
Data	array	返回结果。
GrafanaWorkspace	GrafanaWorkspace	Grafana 工作区信息。
Message	string	请求参数错误时返回的信息。	success
Code	integer	状态码。200 表示成功。	200
Success	boolean	操作是否成功：true：操作成功 false：操作失败。	True
TraceId	string	调用链 ID，用于精确查询调用信息。	eac0a8048716731735000007137d000b

示例

正常返回示例

JSON格式

{
  "RequestId": "0080BE65-167F-5CB6-A691-14E2EFD474BC",
  "Data": [
    {
      "status": "Starting、Running、Stop、DeleteSucceed",
      "description": "线上生产环境Grafana",
      "grafanaWorkspaceEdition": "personal_edition、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",
      "grafanaWorkspaceDomainStatus": "on",
      "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	错误码	错误信息	描述
400	ParameterMissing	You must specify the parameter.	必选参数缺失
400	ResourceIdIsIllegal	The specified ResourceId is invalid.	参数ResourceId是非法的。
400	ParameterIllegal	The specified parameter is invalid.	参数非法
403	RAMNotAuthorize	The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.	子账号没有访问权限，需主账号授予AliyunARMSFullAccess。
403	STSNotAuthorize	STS authorization failed.	STS权限校验失败
403	IllegalUserAccess	Illegal user access.	非法的用户访问
500	InternalError	Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.	内部错误，建议重试。如果多次重试报错请联系钉钉服务账号。
500	AccountUidAccessError	Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.	获取用户信息失败，建议重试。如果多次重试报错请联系钉钉服务账号。

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

变更历史

变更时间	变更内容概要	操作
2023-12-27	OpenAPI 错误码发生变更	查看变更详情