高性能计算平台查询工作空间列表-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： thpc.tencentcloudapi.com 。

本接口（DescribeWorkspaces）用于查询工作空间列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeWorkspaces。
Version	是	String	公共参数，本接口取值：2023-03-21。
Region	是	String	公共参数，详见产品支持的地域列表。
SpaceIds.N	否	Array of String	集群ID列表。通过该参数可以指定需要查询信息的集群列表。如果您不指定该参数，则返回Limit数量以内的集群信息。
Offset	否	Integer	偏移量，默认为0。关于`Offset`的更进一步介绍请参考 API 简介中的相关小节。示例值：0
Limit	否	Integer	返回数量，默认为20，最大值为100。关于`Limit`的更进一步介绍请参考 API 简介中的相关小节。示例值：20
Filters.N	否	Array of Filter	过滤列表

3. 输出参数

参数名称	类型	描述
SpaceSet	Array of SpaceInfo	集群概览信息列表
TotalCount	Integer	集群数量示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询工作空间列表

查看在广州二区的实例信息,限制返回结果最多为一项

输入示例

POST / HTTP/1.1
Host: thpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWorkspaces
<公共请求参数>

{
    "Limit": "1",
    "Filters": [
        {
            "Values": [
                "ap-guangzhou-2"
            ],
            "Name": "zone"
        }
    ],
    "Offset": "0"
}

输出示例

{
    "Response": {
        "SpaceSet": [
            {
                "SpaceId": "abc",
                "SpaceFamily": "abc",
                "SpaceType": "abc",
                "SpaceName": "abc",
                "SpaceState": "abc",
                "SpaceChargeType": "abc",
                "ResourceId": "abc",
                "RenewFlag": "abc",
                "Tags": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "CreatedTime": "2020-09-22T00:00:00+00:00",
                "ExpiredTime": "2020-09-22T00:00:00+00:00",
                "Placement": {
                    "Zone": "abc"
                },
                "LatestOperation": "abc",
                "LatestOperationState": "abc"
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter.Malformed	参数格式有误。

查询工作空间列表

本页目录：