GetDashboard - 获取监控大盘

获取监控日志大盘接口。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:GetDashboardget
*全部资源
*

请求语法

GET /v1/gateways/{gatewayId}/dashboards HTTP/1.1

请求参数

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

网关唯一标识

gw-co370icmjeu****
pluginClassIdstring

插件类型 ID

pls-dn82a9djd8z****
apiIdstring

API 唯一 ID。

api-ctl7no6m1h****
sourcestring

大盘来源:

  • SLS:日志大盘
SLS
namestring

大盘名称:

  • LOG:访问日志
  • PLUGIN:插件日志
PLUGIN
filterobject

过滤配置

routeNamestring

路由名称

test-route
acceptLanguagestring

zh: 中文 en: 英文

zh
upstreamClusterstring

AI 服务标识

outbound|443||ds.ai
pluginIdstring

插件 ID

inner-ai-search-cvd3mcum1hks660icn10

返回参数

名称类型描述示例值
object

响应体

requestIdstring

请求 ID

2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
codeinteger

响应码

200
successboolean

请求是否成功

true
errorCodestring

后端错误码

Ok
messagestring

错误信息

success
dataobject

响应数据

namestring

大盘名称

PLUGIN
titlestring

大盘标题

APIG Plugin
urlstring

大盘 URL 链接

https://sls.console.aliyun.com/lognext/project/xxxxx
gatewayIdstring

网关唯一标识

gw-co370icmjeu****

示例

正常返回示例

JSON格式

{
  "requestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "code": 200,
  "success": true,
  "errorCode": "Ok",
  "message": "success",
  "data": {
    "name": "PLUGIN",
    "title": "APIG Plugin",
    "url": "https://sls.console.aliyun.com/lognext/project/xxxxx",
    "gatewayId": "gw-co370icmjeu****"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-03-31OpenAPI 入参发生变更查看变更详情
2024-12-24OpenAPI 入参发生变更查看变更详情