All Products
Search

This Product

    Managed Service for Prometheus:ListDashboardsByName

    Document Center

    Managed Service for Prometheus:ListDashboardsByName

    Last Updated:Aug 28, 2026

    Creates a Grafana dashboard with Loki and other data sources in Managed Service for Prometheus.

    Note

    This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The ID of the region.

    cn-hangzhou
    ClusterId

    string

    No

    The cluster ID. If ClusterType is not set to cloud-product-prometheus or cms-enterprise-prometheus, this parameter is required.

    cc7a37ee31aea4ed1a059eff8034b****
    DataSourceType

    string

    No

    The type of the data source. Valid values:

    • loki

    • prometheus

    loki
    ClusterType

    string

    No

    The cluster type. Valid values:

    • vpc-prometheus

    • cloud-product-prometheus

    • cms-enterprise-prometheus

    • ExternalKubernetes

    • Ask

    • Kubernetes

    • ManagedKubernetes

    • remote-write-prometheus

    • GlobalViewV2

    cloud-product-prometheus
    ProductCode

    string

    No

    The abbreviation of the Alibaba Cloud service name.

    edas
    GroupName

    string

    No

    The name of the dashboard group.

    EDAS
    DashBoardName

    string

    No

    The name of the dashboard.

    edas-ingress-url
    DashBoardVersion

    string

    No

    The version of the dashboard.

    latest
    OnlyQuery

    boolean

    No

    Specifies whether to display the Grafana dashboard only in the ARMS console.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    Data

    string

    The returned struct.

    [{"name":"Edas Ingress Url Analysis","type":"edas-ingress-url-analysis","url":"https://g.console.alibabacloud.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou"}]
    RequestId

    string

    The request ID. You can use it to locate logs and troubleshoot issues.

    2983BEF7-4A0D-47A2-94A2-8E9C5E63****
    Code

    integer

    The status code. 200 indicates success. Other values indicate errors.

    200
    Message

    string

    The returned message.

    success

    Examples

    Success response

    JSON format

    {
  "Data": "[{\"name\":\"Edas Ingress Url Analysis\",\"type\":\"edas-ingress-url-analysis\",\"url\":\"https://g.console.alibabacloud.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"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.