调用ListDashboardsByName创建Loki数据源和相关的多数据源大盘_可观测监控 Prometheus 版(Prometheus)-阿里云帮助中心

来创建与Prometheus关联的Loki数据源和相关的多数据源大盘。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
arms:ListDashboardsByName	none	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ClusterId	string	否	集群 ID。当 ClusterType 不为`cloud-product-prometheus`或`cms-enterprise-prometheus`的时候，需要传递 ClusterId。	cc7a37ee31aea4ed1a059eff8034b****
DataSourceType	string	否	数据源类型。 loki （Loki 数据源） prometheus （Prometheus 数据源）	loki
ClusterType	string	否	集群类型。 vpc-prometheus （Prometehus for ECS 集群） cloud-product-prometheus （云服务集群） cms-enterprise-prometheus （企业云监控服务集群） ExternalKubernetes （容器服务注册集群） Ask （Serverless 集群） Kubernetes（容器服务专业版集群） ManagedKubernetes （容器服务托管版集群） remote-write-prometheus（Prometheus for Remote Write 集群） GlobalViewV2（Prometheus for GlobalView 集群）	cloud-product-prometheus
ProductCode	string	否	云服务名称缩写。	edas
GroupName	string	否	大盘分组名称。	EDAS
DashBoardName	string	否	大盘名称。	edas-ingress-url
DashBoardVersion	string	否	大盘版本。	latest
OnlyQuery	boolean	否	Grafana 大盘是否仅展示在控制台上。	true

返回参数

名称	类型	描述	示例值
	object	响应内容。
Data	string	返回结构体。	[{"name":"Edas Ingress Url Analysis","type":"edas-ingress-url-analysis","url":"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou"}]
RequestId	string	请求的 ID。用于定位日志，排查问题。	2983BEF7-4A0D-47A2-94A2-8E9C5E63****
Code	integer	状态码。说明 200 表示成功。	200
Message	string	返回结果的提示信息。	success

示例

正常返回示例

JSON格式

{
  "Data": "[{\"name\":\"Edas Ingress Url Analysis\",\"type\":\"edas-ingress-url-analysis\",\"url\":\"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou\"}]",
  "RequestId": "2983BEF7-4A0D-47A2-94A2-8E9C5E63****",
  "Code": 200,
  "Message": "success"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2023-03-20	OpenAPI 返回结构发生变更	查看变更详情