更新时间:2025-07-24 GMT+08:00
分享

查询告警组列表

功能介绍

查询告警组列表

调用方法

请参见如何调用API

URI

POST /v1/projects/{service_id}/alert/group/users

表1 路径参数

参数

是否必选

参数类型

描述

service_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制

不涉及

取值范围

字符串长度不少于1,不超过100000

默认取值

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

group_id

String

告警组ID

group_ids

Array of strings

告警组ID列表

page_num

Integer

当前页数

page_size

Integer

每页大小

test_service_id

String

服务ID

user_ids

Array of strings

用户ID列表

user_name

String

用户名

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释

接口返回状态,ok-成功,failed-失败

约束限制

不涉及

取值范围

ok,failed

默认取值

ok

result

Object

参数解释

告警组查询结果

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

表5 AlertUserDto

参数

参数类型

描述

alert_channel

String

告警通道,{"email":"1","SMS":"1"}, 0=关闭,1=开通

create_time

String

创建时间

create_user

String

创建者

domain_id

String

所属租户Id

domain_name

String

所属租户名称

email_address

String

邮箱

group_id

String

告警组ID

id

String

UUID

nick_name

String

用户昵称

phone_number

String

电话号码

project_user

Boolean

是否是项目成员

remarks

String

备注

role_id

String

角色id

role_name

String

角色名称

test_service_id

String

服务ID

update_time

String

修改时间

update_user

String

修改者

user_id

String

用户Id

user_name

String

告警用户名

user_num

String

用户编号

user_type

String

用户类型

welink_no

String

welink/espace账号

状态码:201

Created

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误编码

error_msg

String

错误原因

请求示例

post https://{endpoint}/v1/projects/1234567abc/alert/group/users

{
  "group_ids" : [ "0000", "1111", "2222" ]
}

响应示例

状态码:200

OK

{
  "status" : "ok",
  "result" : {
    "000000" : [ {
      "id" : "41815b0aca2f4a059caea559aa687825",
      "createUser" : "efdb403066474ab00000",
      "createTime" : 1734319161000,
      "updateUser" : "efdb403066474ab00000",
      "updateTime" : 1737091129000,
      "userName" : "XXXX",
      "testServiceId" : "1234567abc",
      "userType" : "1",
      "nickName" : "XXXX",
      "domainId" : "123456789",
      "domainName" : "XXX",
      "userId" : "123456",
      "roleId" : "12,34",
      "roleName" : "项目经理,项目管理员",
      "projectUser" : true,
      "realUsesName" : "XXX"
    } ]
  }
}

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
47
48
49
50
51
52
53
54
55
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.*;

import java.util.List;
import java.util.ArrayList;

public class ListAlertGroupsByConditionSolution {

    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();
        ListAlertGroupsByConditionRequest request = new ListAlertGroupsByConditionRequest();
        request.withServiceId("{service_id}");
        ListAlertGroupsByConditionRequestBody body = new ListAlertGroupsByConditionRequestBody();
        List<String> listbodyGroupIds = new ArrayList<>();
        listbodyGroupIds.add("0000");
        listbodyGroupIds.add("1111");
        listbodyGroupIds.add("2222");
        body.withGroupIds(listbodyGroupIds);
        request.withBody(body);
        try {
            ListAlertGroupsByConditionResponse response = client.listAlertGroupsByCondition(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
32
33
34
35
36
37
38
39
# 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 = ListAlertGroupsByConditionRequest()
        request.service_id = "{service_id}"
        listGroupIdsbody = [
            "0000",
            "1111",
            "2222"
        ]
        request.body = ListAlertGroupsByConditionRequestBody(
            group_ids=listGroupIdsbody
        )
        response = client.list_alert_groups_by_condition(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
37
38
39
40
41
42
43
44
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.ListAlertGroupsByConditionRequest{}
	request.ServiceId = "{service_id}"
	var listGroupIdsbody = []string{
        "0000",
	    "1111",
	    "2222",
    }
	request.Body = &model.ListAlertGroupsByConditionRequestBody{
		GroupIds: &listGroupIdsbody,
	}
	response, err := client.ListAlertGroupsByCondition(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档

    提示

    您即将访问非华为云网站,请注意账号财产安全