更新时间:2024-04-19 GMT+08:00
分享

获取工作空间用户信息

功能介绍

获取工作空间用户信息。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/{workspace_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参见项目ID和账号ID

workspace_id

String

工作空间ID ,获取方法请参见实例ID和工作空间ID

表2 Query参数

参数

是否必选

参数类型

描述

limit

String

每次查询的数据连接条数的限制量。

最小长度:1

最大长度:16

offset

String

每次查询的数据连接条数的分页页码。

最小长度:1

最大长度:16

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,使用Token认证时必选。通过调用ManageOne平台的IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。

最小长度:0

最大长度:4096

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

count

Integer

当前工作空间用户记录数。

最小值:1

最大值:1024

total_page

Integer

查询结果总页数。

最小值:1

最大值:1024

data

Array of ApigWorkspaceUserbody objects

工作空间用户列表。

数组长度:1 - 1024

表5 ApigWorkspaceUserbody

参数

参数类型

描述

id

String

记录id,主键标识。

最小长度:1

最大长度:128

user_id

String

用户id。

最小长度:1

最大长度:128

user_name

String

用户名。

最小长度:1

最大长度:128

domain_id

String

租户id。

最小长度:1

最大长度:128

domain_name

String

租户名。

最小长度:1

最大长度:128

display_user_name

String

租户名。

最小长度:1

最大长度:128

domain_owner

Boolean

是否是空间所有者。

description

String

工作空间用户信息描述

最小长度:1

最大长度:1024

workspace_id

String

工作空间ID ,获取方法请参见实例ID和工作空间ID

最小长度:1

最大长度:128

roles

Array of ApigRoleVo objects

角色列表。

数组长度:0 - 100

create_time

Number

创建时间。

最小值:0

最大值:9223372036854775807

create_user

String

创建人员。

最小长度:1

最大长度:128

update_time

Number

更新时间。

最小值:0

最大值:9223372036854775807

update_user

String

更新人员。

最小长度:1

最大长度:128

type

Integer

用户类型,0用户,1用户组。

最小值:0

最大值:1

表6 ApigRoleVo

参数

参数类型

描述

role_id

String

角色id信息。

最小长度:1

最大长度:128

role_code

String

角色编码信息。

最小长度:1

最大长度:128

role_name

String

角色名称。

最小长度:1

最大长度:128

description

String

角色描述。

最小长度:1

最大长度:1024

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

最小长度:1

最大长度:1024

error_code

String

返回的错误码。

最小长度:1

最大长度:1024

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_msg

String

返回的错误信息。

最小长度:1

最大长度:1024

error_code

String

返回的错误码。

最小长度:1

最大长度:1024

请求示例

响应示例

状态码: 400

{
  "error_code" : "DAYU.4402",
  "error_msg" : "The operation failed, detail msg {0}."
}

状态码: 500

{
  "error_code" : "DAYU.3531",
  "error_msg" : "Internal server error: {0}"
}

SDK代码示例

SDK代码示例如下。

 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
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.dataartsstudio.v1.region.dataartsstudioRegion;
import com.huaweicloud.sdk.dataartsstudio.v1.*;
import com.huaweicloud.sdk.dataartsstudio.v1.model.*;


public class ListWorkspaceusersSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        dataartsstudioClient client = dataartsstudioClient.newBuilder()
                .withCredential(auth)
                .withRegion(dataartsstudioRegion.valueOf("<YOUR REGION>"))
                .build();
        ListWorkspaceusersRequest request = new ListWorkspaceusersRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ListWorkspaceusersResponse response = client.listWorkspaceusers(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());
        }
    }
}
 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

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import dataartsstudioRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdataartsstudio.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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId) \

    client = dataartsstudioClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(dataartsstudioRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListWorkspaceusersRequest()
        request.workspace_id = "{workspace_id}"
        response = client.list_workspaceusers(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/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")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dataartsstudio.NewdataartsstudioClient(
        dataartsstudio.dataartsstudioClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListWorkspaceusersRequest{}
	request.WorkspaceId = "{workspace_id}"
	response, err := client.ListWorkspaceusers(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

Success,返回用户信息列表。

400

BadRequest

500

Internal Server Error

分享:

    相关文档

    相关产品