更新时间:2026-06-26 GMT+08:00
分享

查询工作空间详情 - ShowWorkspace

功能介绍

查询工作空间名称、描述等详情信息

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

GET /v1/{project_id}/workspaces/{workspace_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型 - application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

workspace

workspace object

参数解释:

空间详情

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

表4 workspace

参数

参数类型

描述

id

String

参数解释:

工作空间id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

create_time

String

参数解释:

创建时间

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

update_time

String

参数解释:

更新时间

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

name

String

参数解释:

工作空间名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

description

String

参数解释:

工作空间描述

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

creator_id

String

参数解释:

创建人id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

creator_name

String

参数解释:

创建人名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

modifier_id

String

参数解释:

修改人id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

modifier_name

String

参数解释:

修改人名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

project_id

String

参数解释:

所属项目id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

project_name

String

参数解释:

所属项目名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

domain_id

String

参数解释:

所属租户id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

domain_name

String

参数解释:

所属租户名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

enterprise_project_id

String

参数解释:

企业项目id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

enterprise_project_name

String

参数解释:

企业项目名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

is_view

Boolean

参数解释:

是否是视图

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

region_id

String

参数解释:

区域id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

view_bind_id

String

参数解释:

视图绑定的空间id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

view_bind_name

String

参数解释:

视图绑定的空间名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

workspace_agency_list

Array of workspace_agency_list objects

参数解释:

纳管空间列表

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

表5 workspace_agency_list

参数

参数类型

描述

project_id

String

参数解释:

委托空间所属项目id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

id

String

参数解释:

空间委托id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

name

String

参数解释:

空间委托名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

region_id

String

参数解释:

委托空间所属region id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

workspace_attribution

String

参数解释:

THIS_ACCOUNT:本账号空间,CROSS_ACCOUNT:跨账号空间

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

agency_version

String

参数解释:

委托版本

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

domain_id

String

参数解释:

委托租户id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

domain_name

String

参数解释:

委托租户名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

iam_agency_id

String

参数解释:

iam委托id

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

iam_agency_name

String

参数解释:

iam委托名称

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

resource_spec_code

Array of strings

参数解释:

资源规格编码

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

selected

Boolean

参数解释:

是否被视图选中

约束限制:

不涉及

取值范围:

不涉及

默认值:

不涉及

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

约束限制:

取值范围:

Secmaster.000000~Secmaster.99999

默认取值:

不涉及

error_msg

String

参数解释:

错误描述

约束限制:

取值范围:

默认取值:

不涉及

状态码:500

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码

约束限制:

取值范围:

Secmaster.000000~Secmaster.99999

默认取值:

不涉及

error_msg

String

参数解释:

错误描述

约束限制:

取值范围:

默认取值:

不涉及

请求示例

响应示例

状态码:200

请求成功

{
  "workspace" : {
    "create_time" : "2024-07-02T09:25:17Z+0800",
    "creator_id" : "b4*****************************46a",
    "creator_name" : "l0******",
    "description" : "my workspace",
    "domain_id" : "ac*****************************bf4",
    "domain_name" : "scc****09",
    "enterprise_project_id" : "",
    "enterprise_project_name" : "",
    "id" : "39*************bf",
    "is_view" : false,
    "modifier_id" : "",
    "modifier_name" : "",
    "name" : "workspaceName",
    "project_id" : "15**************************da6",
    "project_name" : "project_name",
    "region_id" : "region_id",
    "update_time" : "2024-07-02T09:25:17Z+0800",
    "view_bind_id" : "",
    "view_bind_name" : "",
    "workspace_agency_list" : [ ]
  }
}

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


public class ShowWorkspaceSolution {

    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);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        ShowWorkspaceRequest request = new ShowWorkspaceRequest();
        request.withWorkspaceId("{workspace_id}");
        try {
            ShowWorkspaceResponse response = client.showWorkspace(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 huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.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 = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ShowWorkspaceRequest()
        request.workspace_id = "{workspace_id}"
        response = client.show_workspace(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
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := secmaster.SecMasterClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := secmaster.NewSecMasterClient(hcClient)

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

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

状态码

状态码

描述

200

请求成功

400

请求参数有误

500

请求失败

错误码

请参见错误码

相关文档