# 查询分组列表 - ListAppGroups #### 功能介绍 查询分组列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-deployman/CloudDeploy_api_1001.html)。 #### URI GET /v1/projects/{project_id}/applications/groups 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目id，获取方式请参见[获取项目id](https://support.huaweicloud.com/api-deployman/CloudDeploy_api_0012.html)。 **约束限制**： 不涉及。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 **默认取值**： 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释**： 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制**： 不涉及。 **取值范围**： 字符串，长度不超过20000个字符。 **默认取值**： 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Array of [AppGroupsEntity] objects | **参数解释**： 分组信息列表。 | | status | String | **参数解释**： 请求成功失败状态。 **取值范围**： - success: 成功。 - error: 失败。请求成功失败状态。 | 表4AppGroupsEntity | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**： 分组id。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 | | name | String | **参数解释**： 分组名称。 **取值范围**： 不涉及。 | | project_id | String | **参数解释**： 项目id，获取方式请参见[获取项目id](https://support.huaweicloud.com/api-deployman/CloudDeploy_api_0012.html)。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符。 | | path | String | **参数解释**： 分组路径，由父分组id+"."+当前分组id组成。 **取值范围**： 不涉及。 | | parent_id | String | **参数解释**： 父分组id，首层为null。 **取值范围**： 只能由英文字母、数字组成，且长度为32个字符或者null。 | | ordinal | Integer | **参数解释**： 分组排序字段。 **取值范围**： 不涉及。 | | create_user_id | String | **参数解释**： 分组创建者用户id。 **取值范围**： 不涉及。 | | last_update_user_id | String | **参数解释**： 最近一次更新该分组用户id。 **取值范围**： 不涉及。 | | count | Integer | **参数解释**： 该分组应用总数。 **取值范围**： 不涉及。 | | children | Array of [AppGroupsEntity] objects | **参数解释**： 子分组列表。 | #### 请求示例 ``` https://{endpoint}/v1/projects/0a38ce9ba3c740c199a0f872b6163661/applications/groups ``` #### 响应示例 **状态码：200** OK 请求响应成功 ``` { "result" : [ { "project_id" : "0a38ce9ba3c740c199a0f872b6163661", "path" : "55ad749142fc405398aad372a1f9eff1", "parent_id" : null, "ordinal" : 1, "name" : "group_1", "last_update_user_id" : "057842a25b000f6b1fcbc014a9cccccc", "id" : "55ad749142fc405398aad372a1f9eff1", "create_user_id" : "057842a25b000f6b1fcbc014a9cccccc", "count" : 0, "children" : [ ] } ], "status" : "success" } ``` #### 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.codeartsdeploy.v2.region.CodeArtsDeployRegion; import com.huaweicloud.sdk.codeartsdeploy.v2.*; import com.huaweicloud.sdk.codeartsdeploy.v2.model.*; public class ListAppGroupsSolution { 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); CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsDeployRegion.valueOf("")) .build(); ListAppGroupsRequest request = new ListAppGroupsRequest(); request.withProjectId("{project_id}"); try { ListAppGroupsResponse response = client.listAppGroups(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 huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsdeploy.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"] credentials = BasicCredentials(ak, sk) client = CodeArtsDeployClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsDeployRegion.value_of("")) \ .build() try: request = ListAppGroupsRequest() request.project_id = "{project_id}" response = client.list_app_groups(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" codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := codeartsdeploy.NewCodeArtsDeployClient( codeartsdeploy.CodeArtsDeployClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). Build()) request := &model.ListAppGroupsRequest{} request.ProjectId = "{project_id}" response, err := client.ListAppGroups(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CodeArtsDeploy/sdk?api=ListAppGroups)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK 请求响应成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-deployman/ErrorCode.html)。