创建仪表盘
功能介绍
创建仪表盘
调用方法
请参见如何调用API。
URI
POST /v2/{project_id}/dashboard
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方式请参见:获取项目ID,获取账号ID,日志组ID、日志流ID 最小长度:32 最大长度:32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
从IAM服务获取的用户Token,获取方式请参见:获取用户Token 最小长度:1 最大长度:10000 |
Content-Type |
是 |
String |
该字段填为:application/json;charset=UTF-8。 最小长度:30 最大长度:30 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_name |
否 |
String |
仪表盘分组名称 |
title |
是 |
String |
仪表盘名称 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
charts |
Array of strings |
仪表盘图表 |
filters |
Array of strings |
过滤条件 |
group_name |
String |
日志组名称 |
id |
String |
仪表盘id |
last_update_time |
Long |
最近修改时间 |
project_id |
String |
项目id |
title |
String |
仪表盘名称 |
useSystemTemplate |
Boolean |
是否使用模板 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
message |
ErrorMessagebody object |
错误信息body体 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
message |
ErrorMessagebody object |
错误信息body体 |
请求示例
创建仪表盘,group_name为非必填参数。
/v2/2a473356cca5487f8373be891bffc1cf/dashboard { "group_name" : "sgqtest", "title" : "sgqtest1" }
响应示例
状态码: 201
创建仪表盘成功
{ "charts" : [ ], "filters" : [ ], "group_name" : "", "id" : "2bf23310-83c2-4962-898f-79ebd057a256", "last_update_time" : 1669637866189, "project_id" : "2a473356cca5487f8373be891bffc1cf", "title" : "test", "useSystemTemplate" : false }
状态码: 400
BadRequest 非法请求建议根据error_msg直接修改该请求
{ "message" : { "code" : "LTS.0736", "details" : "The number of log dashboards exceeds the maximum" } }
状态码: 500
表明服务端能被请求访问到,但是服务内部出错
{ "message" : { "code" : "LTS.0203", "details" : "Internal Server Error" } }
SDK代码示例
SDK代码示例如下。
创建仪表盘,group_name为非必填参数。
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 49 50 51 |
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.lts.v2.region.LtsRegion; import com.huaweicloud.sdk.lts.v2.*; import com.huaweicloud.sdk.lts.v2.model.*; public class CreateDashBoardSolution { 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); LtsClient client = LtsClient.newBuilder() .withCredential(auth) .withRegion(LtsRegion.valueOf("<YOUR REGION>")) .build(); CreateDashBoardRequest request = new CreateDashBoardRequest(); CreateDashBoardReqBody body = new CreateDashBoardReqBody(); body.withTitle("sgqtest1"); body.withGroupName("sgqtest"); request.withBody(body); try { CreateDashBoardResponse response = client.createDashBoard(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()); } } } |
创建仪表盘,group_name为非必填参数。
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklts.v2.region.lts_region import LtsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklts.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 = LtsClient.new_builder() \ .with_credentials(credentials) \ .with_region(LtsRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateDashBoardRequest() request.body = CreateDashBoardReqBody( title="sgqtest1", group_name="sgqtest" ) response = client.create_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) |
创建仪表盘,group_name为非必填参数。
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" lts "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/lts/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 := lts.NewLtsClient( lts.LtsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateDashBoardRequest{} groupNameCreateDashBoardReqBody:= "sgqtest" request.Body = &model.CreateDashBoardReqBody{ Title: "sgqtest1", GroupName: &groupNameCreateDashBoardReqBody, } response, err := client.CreateDashBoard(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
201 |
创建仪表盘成功 |
400 |
BadRequest 非法请求建议根据error_msg直接修改该请求 |
500 |
表明服务端能被请求访问到,但是服务内部出错 |
错误码
请参见错误码。