查询告警模板
功能介绍
查询告警模板
调用方法
请参见如何调用API。
URI
GET /v1/projects/{service_id}/alert-templates
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
service_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。 约束限制 不涉及 取值范围 32个字符组成的字符串 默认取值 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
模板名称 |
page_num |
否 |
Integer |
当前页数 |
page_size |
否 |
Integer |
每页数量 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制 不涉及 取值范围 字符串长度不少于1,不超过100000 默认取值 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
end_row |
Long |
结束行 |
has_next_page |
Boolean |
是否有下一页 |
has_previous_page |
Boolean |
是否有上一页 |
is_first_page |
Boolean |
是否是第一页 |
is_last_page |
Boolean |
是否是最后一页 |
list |
Array of AlertTemplateVo objects |
当前页面的模板 |
navigate_first_page |
Integer |
导航第一页数字 |
navigate_last_page |
Integer |
导航最后一页数字 |
navigate_pages |
Integer |
导航页数 |
navigate_page_nums |
Array of integers |
导航页数 |
next_page |
Integer |
下一页 |
page_num |
Integer |
多少页 |
page_size |
Integer |
每页多少个 |
pages |
Integer |
总页数 |
pre_page |
Integer |
前面有多少页 |
size |
Integer |
当前页告警模板数 |
start_row |
Long |
开始行 |
total |
Long |
总告警模板数 |
参数 |
参数类型 |
描述 |
---|---|---|
alert_levels |
Array of AlertLevel objects |
告警级别列表 |
create_time |
DateTime |
创建时间 |
create_user |
String |
创建人 |
id |
String |
唯一ID,主键 |
name |
String |
告警模板名称 |
remarks |
String |
备注 |
test_service_id |
String |
服务ID |
update_time |
DateTime |
修改时间 |
update_user |
String |
更新人 |
参数 |
参数类型 |
描述 |
---|---|---|
alert_channel |
Array of strings |
告警渠道列表 |
alert_groups |
Array of AlertGroup objects |
告警组列表 |
alert_template_id |
String |
告警模板ID |
alert_times |
Integer |
告警次数 |
参数 |
参数类型 |
描述 |
---|---|---|
ding_talk_hook_url |
String |
企业钉钉微信群聊机器人地址 |
group_name |
String |
告警组名称 |
id |
String |
告警组ID |
we_chat_work_hook_url |
String |
企业微信群聊机器人地址 |
we_link_group_no |
String |
weLink群号 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误编码 |
error_msg |
String |
错误原因 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误编码 |
error_msg |
String |
错误原因 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误编码 |
error_msg |
String |
错误原因 |
请求示例
无
响应示例
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
SDK代码示例
SDK代码示例如下。
Java
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 |
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.cloudtest.v1.region.CloudtestRegion;
import com.huaweicloud.sdk.cloudtest.v1.*;
import com.huaweicloud.sdk.cloudtest.v1.model.*;
public class ListAlertTemplatesSolution {
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");
ICredential auth = new BasicCredentials()
.withAk(ak)
.withSk(sk);
CloudtestClient client = CloudtestClient.newBuilder()
.withCredential(auth)
.withRegion(CloudtestRegion.valueOf("<YOUR REGION>"))
.build();
ListAlertTemplatesRequest request = new ListAlertTemplatesRequest();
request.withServiceId("{service_id}");
try {
ListAlertTemplatesResponse response = client.listAlertTemplates(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());
}
}
}
|
Python
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcloudtest.v1 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"]
credentials = BasicCredentials(ak, sk)
client = CloudtestClient.new_builder() \
.with_credentials(credentials) \
.with_region(CloudtestRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = ListAlertTemplatesRequest()
request.service_id = "{service_id}"
response = client.list_alert_templates(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
Go
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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")
auth := basic.NewCredentialsBuilder().
WithAk(ak).
WithSk(sk).
Build()
client := cloudtest.NewCloudtestClient(
cloudtest.CloudtestClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.ListAlertTemplatesRequest{}
request.ServiceId = "{service_id}"
response, err := client.ListAlertTemplates(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。