1. 接口描述
接口请求域名: thpc.tencentcloudapi.com 。
本接口(InquirePriceCreateWorkspaces)用于创建实例询价。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:InquirePriceCreateWorkspaces。 |
| Version | 是 | String | 公共参数,本接口取值:2023-03-21。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-shanghai, ap-singapore, eu-frankfurt 。 |
| 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 | 实例主机名。{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. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Price | Price | 该参数表示对应配置实例的价格 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建实例询价
输入示例
POST / HTTP/1.1
Host: thpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: InquirePriceCreateWorkspaces
<公共请求参数>
{
"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"
},
"DataDisks": [
{
"DiskSize": 50,
"DiskType": "CLOUD_PREMIUM"
},
{
"DiskSize": 50,
"DiskType": "CLOUD_PREMIUM"
}
],
"InternetAccessible": {
"PublicIpAssigned": true,
"InternetMaxBandwidthOut": 5
},
"SecurityGroupIds": [
"sg-fsx9rsr1"
],
"SpaceCount": 1,
"EnhancedService": {
"SecurityService": {
"Enabled": true
},
"MonitorService": {
"Enabled": true
},
"AutomationService": {
"Enabled": true
}
}
}
输出示例
{
"Response": {
"Price": {
"SpacePrice": {
"OriginalPrice": 123630.3,
"DiscountPrice": 123630.3,
"Discount": 100
},
"BandwidthPrice": {
"UnitPrice": 0.8,
"DiscountUnitPrice": 0.8,
"ChargeUnit": "GB",
"Discount": 100
}
},
"RequestId": "dcec1ad4-54a4-4a49-b754-f65cd7274c82"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CallCloudSdkException | 内部错误 |
| InvalidParameter.Combination | 参数组合冲突。 |
| InvalidParameterValue.InvalidUnderwritePeriod | 包销付费模式下,Period仅支持传入[12, 24, 36, 48, 60]中的某一个值。 |
| InvalidParameterValue.SpaceTypeNotAvailable | 工作空间规格不可用 |
| UnauthorizedOperation.UnauthorizedNetworkUser | 账号没有操作公网网络的权限,需要升级到标准网络账号。 |