获取工作空间列表
功能介绍
获取工作空间列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{instance_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
instance_id |
是 |
String |
DataArts Studio实例ID,获取方法请参见实例ID和工作空间ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每次查询的数据连接条数的限制量,默认20。 |
offset |
否 |
Integer |
数据偏移量,默认0。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,使用Token认证时必选。通过调用ManageOne平台的IAM服务的“获取用户Token”接口获取响应消息头中X-Subject-Token的值。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
当前工作空间用户记录数。 |
total_page |
Integer |
查询结果总页数。 |
data |
Array of Workspacebody objects |
工作空间列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
bad_record_location_name |
String |
脏数据OBS路径。 |
description |
String |
工作空间描述。 |
eps_id |
String |
企业项目ID,获取方法请参见项目ID和账号ID。 |
job_log_location_name |
String |
作业日志OBS路径。 |
name |
String |
工作空间名称。 |
id |
String |
工作空间ID ,获取方法请参见实例ID和工作空间ID。 |
is_default |
Integer |
是否为默认空间,0为私有空间,1为默认空间,2为公共空间。 |
owner_name |
String |
创建者名称。 |
project_id |
String |
项目ID,获取方法请参见项目ID和账号ID。 |
domain_id |
String |
租户id,可在IAM侧用户信息中查询账号ID。 |
instance_id |
String |
DataArts Studio实例ID,获取方法请参见实例ID和工作空间ID。 |
create_time |
Number |
创建时间。 |
create_user |
String |
创建用户名称。 |
member_num |
Integer |
当前工作空间成员数量。 |
update_time |
Number |
更新时间。 |
update_user |
String |
更新用户名称。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
返回的错误信息。 |
error_code |
String |
返回的错误码。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
返回的错误信息。 |
error_code |
String |
返回的错误码。 |
请求示例
无
响应示例
状态码: 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 ListManagerWorkSpacesSolution { 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(); ListManagerWorkSpacesRequest request = new ListManagerWorkSpacesRequest(); request.withInstanceId("{instance_id}"); try { ListManagerWorkSpacesResponse response = client.listManagerWorkSpaces(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 32 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["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 = ListManagerWorkSpacesRequest() request.instance_id = "{instance_id}" response = client.list_manager_work_spaces(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.ListManagerWorkSpacesRequest{} request.InstanceId = "{instance_id}" response, err := client.ListManagerWorkSpaces(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。 |