获取代码组下可添加的成员列表
功能介绍
获取代码组下可添加的成员列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/groups/{group_id}/members/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_id |
是 |
Integer |
参数解释: 代码组id,代码组首页,Group ID后的数字Id 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。 取值范围: 字符串长度32。 |
query |
否 |
String |
参数解释: 成员搜索字符串 |
join_way |
否 |
String |
参数解释: 成员加入方式 domain 租户 normal 普通 inherit 继承 枚举值:
|
access_level |
否 |
Integer |
参数解释: 过滤成员的access level, 10待审核 20浏览者 30开发者 40管理员 50所有者 取值范围: 1-2147483647 |
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of GroupMemberDetailDto objects |
参数解释: 成员列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 唯一标识id。 取值范围: 1-2147483647 |
source_id |
Integer |
参数解释: 资源id。 取值范围: 1-2147483647 |
user_id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
user_from |
String |
参数解释: 用户来源。 取值范围: 字符串长度不少于1,不超过1000。 |
role_id |
String |
参数解释: 角色id。 取值范围: 字符串长度不少于1,不超过1000。 |
role_name |
String |
参数解释: 角色名称。 取值范围: 字符串长度不少于1,不超过1000。 |
cn_role_name |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
req_role_id |
String |
参数解释: 项目角色id。 取值范围: 字符串长度不少于1,不超过1000。 |
req_role_name |
String |
参数解释: 项目角色名称。 取值范围: 字符串长度不少于1,不超过1000。 |
user_group_id |
String |
参数解释: 成员组id。 取值范围: 字符串长度不少于1,不超过1000。 |
group_name |
String |
参数解释: 代码组名称。 取值范围: 字符串长度不少于1,不超过1000。 |
user_name |
String |
参数解释: 用户名称。 取值范围: 字符串长度不少于1,不超过1000。 |
domain_id |
String |
参数解释: 租户id。 取值范围: 字符串长度不少于1,不超过1000。 |
domain_name |
String |
参数解释: 租户名称。 取值范围: 字符串长度不少于1,不超过1000。 |
nick_name |
String |
参数解释: 用户昵称。 取值范围: 字符串长度不少于1,不超过1000。 |
is_group_creator |
Boolean |
参数解释: 是否为代码组创建者。 |
is_project_admin |
Boolean |
参数解释: 是否为项目管理员。 |
path |
String |
参数解释: 路径。 取值范围: 字符串长度不少于1,不超过1000。 |
role_chinese_name |
String |
参数解释: 角色中文名称。 取值范围: 字符串长度不少于1,不超过1000。 |
can_remove |
Boolean |
参数解释: 是否可移除。 |
access_level |
Integer |
参数解释: 角色。 取值范围: 1-2147483647 |
service_license_status |
Integer |
参数解释: 服务license状态。 取值范围: 1-2147483647 |
iam_id |
String |
参数解释: 用户iam_id。 取值范围: 字符串长度不少于1,不超过1000。 |
current_group_member |
Boolean |
参数解释: 是否为当前代码组成员。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 |
error_msg |
String |
参数解释: 错误信息。 |
请求示例
GET https://{endpoint}/v4/groups/{group_id}/members/list
响应示例
状态码:200
获取代码组下可添加的成员列表
[ { "id" : 1067730, "source_id" : 2111919928, "user_id" : 9091, "user_from" : "项目成员", "role_id" : "42501d8587994fb1ace57dc2bd80a51f", "role_name" : "项目经理", "cn_role_name" : "项目经理", "req_role_id" : "42501d8587994fb1ace57dc2bd80a51f", "req_role_name" : "项目经理", "user_group_id" : null, "group_name" : "p_group3", "user_name" : "03e2dc950c7441df8d26972e33cadb15", "domain_id" : "159b65b41ead484d8ddff250a4731781", "domain_name" : "devcloud_codehub_l00314597_01", "nick_name" : null, "is_group_creator" : false, "is_project_admin" : false, "path" : null, "role_chinese_name" : null, "can_remove" : true, "access_level" : 40, "service_license_status" : 1, "iam_id" : "03e2dc950c7441df8d26972e33cadb15", "current_group_member" : true } ]
状态码:401
Unauthorized
{ "error_code" : "DEV.00000003", "error_msg" : "认证信息过期" }
状态码:403
Bad Request
{ "error_code" : "CH.004403", "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.codehub.v4.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v4.*; import com.huaweicloud.sdk.codehub.v4.model.*; public class ListGroupMembersSolution { 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); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ListGroupMembersRequest request = new ListGroupMembersRequest(); request.withGroupId({group_id}); try { ListGroupMembersResponse response = client.listGroupMembers(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 huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.v4 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 = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListGroupMembersRequest() request.group_id = {group_id} response = client.list_group_members(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" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/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 := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListGroupMembersRequest{} request.GroupId = int32({group_id}) response, err := client.ListGroupMembers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
获取代码组下可添加的成员列表 |
401 |
Unauthorized |
403 |
Bad Request |
错误码
请参见错误码。