# 查询告警组下联系人列表 - ListAlertGroupsByCondition #### 功能介绍 查询服务下所有联系人列表或指定告警组下联系人列表 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v1/projects/{service_id}/alert/group/users 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | service_id | 是 | String | **参数解释：** 项目的32位uuid，项目唯一标识，通过[获取CodeArts项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4005.html)接口查询项目列表获取。 **约束限制** 不涉及 **取值范围** 32个字符组成的字符串 **默认取值** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中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 | | result | Object | **参数解释** 告警组查询结果 **取值范围** 不涉及 | 表5AlertUserDto | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | **参数解释** 用户类型 **取值范围** 1-2 - 1,内部用户 - 2,外部用户 | | welink_no | String | welink/espace账号 | **状态码：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/4858a39d9861476ca2cbc71db0d5db2e/alert/group/users { "group_id" : "7b90e408636344328e44bf70bbrf5649", "group_ids" : [ "da670b05f6f34f20a481005b05686a83", "632492d0e03b4313ad95a080eb8f37b7" ], "page_num" : 1, "page_size" : 4, "test_service_id" : "123b7214f4cd43b782b6f4b7cb091a4a", "user_ids" : [ "b78965ba1ec44d4f9bcd93c33d5c795a", "0bcafc593080d5521f3dc00464699gf4" ], "user_name" : "test" } ``` #### 响应示例 **状态码：200** OK ``` { "status" : "ok", "result" : { } } ``` **状态码：401** Unauthorized ``` { "error_code" : "string", "error_msg" : "string" } ``` **状态码：403** Forbidden ``` { "error_code" : "string", "error_msg" : "string" } ``` **状态码：404** Not Found ``` { "error_code" : "string", "error_msg" : "string" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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("")) .build(); ListAlertGroupsByConditionRequest request = new ListAlertGroupsByConditionRequest(); request.withServiceId("{service_id}"); ListAlertGroupsByConditionRequestBody body = new ListAlertGroupsByConditionRequestBody(); List listbodyGroupIds = new ArrayList<>(); listbodyGroupIds.add("da670b05f6f34f20a481005b05686a83"); listbodyGroupIds.add("632492d0e03b4313ad95a080eb8f37b7"); body.withTestServiceId("123b7214f4cd43b782b6f4b7cb091a4a"); body.withPageSize(4); body.withPageNum(1); body.withGroupIds(listbodyGroupIds); body.withGroupId("7b90e408636344328e44bf70bbrf5649"); 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 ``` # 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("")) \ .build() try: request = ListAlertGroupsByConditionRequest() request.service_id = "{service_id}" listGroupIdsbody = [ "da670b05f6f34f20a481005b05686a83", "632492d0e03b4313ad95a080eb8f37b7" ] request.body = ListAlertGroupsByConditionRequestBody( test_service_id="123b7214f4cd43b782b6f4b7cb091a4a", page_size=4, page_num=1, group_ids=listGroupIdsbody, group_id="7b90e408636344328e44bf70bbrf5649" ) 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 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cloudtest.NewCloudtestClient(hcClient) request := &model.ListAlertGroupsByConditionRequest{} request.ServiceId = "{service_id}" var listGroupIdsbody = []string{ "da670b05f6f34f20a481005b05686a83", "632492d0e03b4313ad95a080eb8f37b7", } testServiceIdListAlertGroupsByConditionRequestBody:= "123b7214f4cd43b782b6f4b7cb091a4a" pageSizeListAlertGroupsByConditionRequestBody:= int32(4) pageNumListAlertGroupsByConditionRequestBody:= int32(1) groupIdListAlertGroupsByConditionRequestBody:= "7b90e408636344328e44bf70bbrf5649" request.Body = &model.ListAlertGroupsByConditionRequestBody{ TestServiceId: &testServiceIdListAlertGroupsByConditionRequestBody, PageSize: &pageSizeListAlertGroupsByConditionRequestBody, PageNum: &pageNumListAlertGroupsByConditionRequestBody, GroupIds: &listGroupIdsbody, GroupId: &groupIdListAlertGroupsByConditionRequestBody, } response, err := client.ListAlertGroupsByCondition(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudTest/sdk?api=ListAlertGroupsByCondition)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。