查询仪表盘详情 - ShowDashBoard
功能介绍
该接口用于查询仪表盘详情。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
aom:view:get
Read
-
-
-
-
URI
GET /v2/{project_id}/aom/dashboards/{dashboard_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
|
dashboard_id |
是 |
String |
仪表盘id。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
version |
是 |
String |
仪表盘版本号。 |
请求参数
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
项目ID,可以从控制台获取,也可以从调用API处获取。获取方式请参见:获取项目ID。 |
|
dashboard_type |
String |
仪表盘类型。 |
|
dashboard_title |
String |
仪表盘名称。 |
|
dashboard_title_en |
String |
仪表盘英文名称。 |
|
dashboard_id |
String |
仪表盘id。 |
|
version |
String |
仪表盘版本。 |
|
enterprise_project_id |
String |
仪表盘企业项目id。获取方式请参见:获取企业项目ID。 |
|
folder_name |
String |
仪表盘分组名称。 |
|
folder_id |
String |
仪表盘分组id。 |
|
sync_data |
String |
待同步的仪表盘数。 |
|
is_create_action |
Boolean |
是否创建
枚举值:
|
|
dashboard_tags |
Array of Map<String,String> objects |
仪表盘标签列表。 |
|
is_favorite |
Boolean |
是否收藏
枚举值:
|
|
created |
Long |
仪表盘创建时间。 |
|
updated |
Long |
仪表盘更新时间。 |
|
created_by |
String |
创建仪表盘的账号名称。 |
|
updated_by |
String |
更新仪表盘的账号名称。 |
|
charts |
Object |
仪表盘图表详情。 |
|
templating |
Object |
仪表盘变量列表。 |
|
display |
Boolean |
是否展示。 |
|
query_count |
Integer |
查询总次数。 |
|
time_range |
String |
默认查询时间范围。 |
请求示例
查询仪表盘id为f804-03-4f-b**9-bf32f**f的详情
https://{Endpoint}/v2/{project_id}/aom/dashboards/f80****4-0**3-4**f-b**9-b****f32f**f
响应示例
状态码:200
OK 请求响应成功。
{
"created" : 1719327521188,
"updated" : 1719327521188,
"templating" : { },
"display" : true,
"project_id" : "2a****56cc****7f83****891b****cf",
"dashboard_type" : "dashboard",
"dashboard_title" : "aom_dashboard",
"dashboard_id" : "f80****4-0**3-4**f-b**9-b****f32f**f",
"version" : "v1",
"enterprise_project_id" : "0",
"folder_name" : "仪表盘分组",
"sync_data" : "{\"dashboard_id\":\"f80****4-0**3-4**f-b**9-b****f32f**f\",\"version\":\"v1\",\"folder_id\":null,\"is_create_action\":true}",
"is_create_action" : false,
"dashboard_tags" : [ { } ],
"is_favorite" : false,
"created_by" : "aom_ops_user2",
"query_count" : 0
}
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aom.v2.region.AomRegion; import com.huaweicloud.sdk.aom.v2.*; import com.huaweicloud.sdk.aom.v2.model.*; public class ShowDashBoardSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); AomClient client = AomClient.newBuilder() .withCredential(auth) .withRegion(AomRegion.valueOf("<YOUR REGION>")) .build(); ShowDashBoardRequest request = new ShowDashBoardRequest(); request.withDashboardId("{dashboard_id}"); try { ShowDashBoardResponse response = client.showDashBoard(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkaom.v2.region.aom_region import AomRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaom.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = AomClient.new_builder() \ .with_credentials(credentials) \ .with_region(AomRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowDashBoardRequest() request.dashboard_id = "{dashboard_id}" response = client.show_dash_board(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := aom.NewAomClient( aom.AomClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowDashBoardRequest{} request.DashboardId = "{dashboard_id}" response, err := client.ShowDashBoard(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK 请求响应成功。 |
错误码
请参见错误码。