高性能计算平台创建工作空间-工作空间相关接口-API 中心-腾讯云

1. 接口描述

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

本接口 (CreateWorkspaces) 用于创建工作空间。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateWorkspaces。
Version	是	String	公共参数，本接口取值：2023-03-21。
Region	是	String	公共参数，详见产品支持的地域列表。
ClientToken	否	String	用于保证请求幂等性的字符串。该字符串由客户生成，需保证不同请求之间唯一，最大值不超过64个ASCII字符。若不指定该参数，则无法保证请求的幂等性。示例值：system-f3827db9-c58a-49cc-bf10-33fc1923a34a
Placement	否	SpacePlacement	实例所在的位置。通过该参数可以指定实例所属可用区，所属项目，所属宿主机（在专用宿主机上创建子机时指定）等属性。注：如果您不指定LaunchTemplate参数，则Placement为必选参数。若同时传递Placement和LaunchTemplate，则默认覆盖LaunchTemplate中对应的Placement的值。
SpaceChargePrepaid	否	SpaceChargePrepaid	预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
SpaceChargeType	否	String	工作空间计费类型示例值：PREPAID
SpaceType	否	String	工作空间规格
ImageId	否	String	镜像ID 示例值：img-irmer45l
SystemDisk	否	SpaceSystemDisk	工作空间系统盘信息
DataDisks.N	否	Array of SpaceDataDisk	工作空间数据盘信息
VirtualPrivateCloud	否	SpaceVirtualPrivateCloud	私有网络相关信息
InternetAccessible	否	SpaceInternetAccessible	公网带宽相关信息设置
SpaceCount	否	Integer	购买工作空间数量示例值：1
SpaceName	否	String	工作空间显示名称
LoginSettings	否	LoginSettings	工作空间登陆设置
SecurityGroupIds.N	否	Array of String	工作空间所属安全组示例值：["sg-ajhn9qtq"]
EnhancedService	否	EnhancedService	增强服务
DryRun	否	Boolean	是否只预检此次请求示例值：false
UserData	否	String	提供给工作空间使用的用户数据示例值：TXlVc2VyRGF0YQo=
DisasterRecoverGroupIds.N	否	Array of String	置放群组id 示例值：['ps-3p88qhfo']
TagSpecification.N	否	Array of TagSpecification	标签描述列表
HpcClusterId	否	String	高性能计算集群ID 示例值：hpc-a5n666lo
CamRoleName	否	String	CAM角色名称示例值：testroleName001
HostName	否	String	实例主机名。点号（.）和短横线（-）不能作为 HostName 的首尾字符，不能连续使用。 Windows 实例：主机名名字符长度为[2, 15]，允许字母（不限制大小写）、数字和短横线（-）组成，不支持点号（.），不能全是数字。其他类型（Linux 等）实例：主机名字符长度为[2, 60]，允许支持多个点号，点之间为一段，每段允许字母（不限制大小写）、数字和短横线（-）组成。购买多台实例，如果指定模式串`{R:x}`，表示生成数字`[x, x+n-1]`，其中`n`表示购买实例的数量，例如`server{R:3}`，购买1台时，实例主机名为`server3`；购买2台时，实例主机名分别为`server3`，`server4`。支持指定多个模式串`{R:x}`。购买多台实例，如果不指定模式串，则在实例主机名添加后缀`1、2...n`，其中`n`表示购买实例的数量，例如`server`，购买2台时，实例主机名分别为`server1`，`server2`。示例值：MyHostName

3. 输出参数

参数名称	类型	描述
SpaceIdSet	Array of String	工作空间ID 示例值：['wks-rn99mzt1']
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建工作空间

创建工作空间

输入示例

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

{

    "SpaceChargeType": "PREPAID",
    "SpaceChargePrepaid": {
        "Period": 1,
        "RenewFlag": "NOTIFY_AND_AUTO_RENEW"
    },
    "Placement": {
        "Zone": "ap-guangzhou-2",
        "ProjectId": 0
    },
    "VirtualPrivateCloud": {
        "AsVpcGateway": false,
        "VpcId": "vpc-nrqwfyzv",
        "SubnetId": "subnet-0tmm4ywk",
        "Ipv6AddressCount": 0
    },
    "SpaceType": "96A.96XLARGE2304",
    "ImageId": "img-9qrfy1xt",
    "SystemDisk": {
        "DiskSize": 50,
        "DiskType": "CLOUD_PREMIUM",
        "DiskBackupQuota": 1
    },
    "DataDisks": [{
        "DiskSize": 50,
        "DiskType": "CLOUD_PREMIUM",
        "DiskBackupQuota": 1
    }, {
        "DiskSize": 50,
        "DiskType": "CLOUD_PREMIUM",
        "DiskBackupQuota": 1
    }],
    "InternetAccessible": {
        "PublicIpAssigned": true,
        "InternetMaxBandwidthOut": 5
    },
    "SecurityGroupIds": ["sg-fsx9rsr1"],
    "SpaceCount": 1,
    "EnhancedService": {
        "SecurityService": {
            "Enabled": true
        },
        "MonitorService": {
            "Enabled": true
        },
        "AutomationService": {
            "Enabled": true
        }
    }
}

输出示例

{
    "Response": {
        "SpaceIdSet": [
            "wks-avs9gqvt"
        ],
        "RequestId": "efbbe00e-0175-4ee7-92c5-debc5763142d"
    }
}

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. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。