创建实例资源池预扣包

最近更新时间:2026-03-31 01:34:32

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(PurchaseResourcePoolPacks)用于创建一个或多个实例资源池,每个资源池绑定一个整机或半整机规格的物理资源容量。

  • 实例资源池为剩余容量按量付费模式,购买前请确保账户余额充足。
  • 本接口为异步接口,创建请求发送成功后会返回DedicatedResourcePackIds,此时创建任务并未完成。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:PurchaseResourcePoolPacks。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Zone String 实例资源池预扣包所在可用区。形如:ap-guangzhou-6。可通过DescribeZones接口获取可用区列表。
示例值:ap-guangzhou-7
InstanceType String 实例资源池预扣包的规格,仅支持半整机/整机规格。形如:SA9.96XLARGE1152(SA9半整机)。
示例值:S9.8XLARGE64
InstanceCount Integer 实例资源池预扣包的数量。1个数量代表1个半整机/整机资源池。取值范围:1-100。
示例值:1
Period Integer 实例资源池预扣包的时长,单位:月。取值范围:1-60。
示例值:1
ResourcePoolPackType String 实例资源池类型。取值范围:
  • EXCLUSIVE:独享(默认值)
  • SHARED:共享

  • 注意:第一期仅支持EXCLUSIVE类型。
    示例值:EXCLUSIVE
    AutoPlacement Boolean 自动放置开关,默认开启(true)。
  • 开启:在不指定实例资源池创建实例时,系统会在开启了该能力的实例资源池里寻找合适的池子创建实例。
  • 关闭:在不指定实例资源池创建实例时,系统不会在该池子里创建实例,只有在指定实例资源池创建实例时,指定了该池子的ID,才允许在池子内创建实例。

  • 示例值:true
    DedicatedResourcePoolPackName String 实例资源池的名称。长度限制:1-60个字符,支持中文、英文、数字、连接线"-"、下划线"_"。
    示例值:测试实例资源池
    RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费(默认值)
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费

  • 示例值:NOTIFY_AND_MANUAL_RENEW
    DryRun Boolean 试运行,用于校验请求参数是否正确。默认为false。
  • true:发送检查请求,不会创建实例资源池。检查项包括是否填写了必需参数,请求格式,业务限制等。如果检查不通过,则返回对应错误码;如果检查通过,则返回RequestId。
  • false(默认值):发送正常请求,通过检查后直接创建实例资源池。

  • 示例值:false

    3. 输出参数

    参数名称 类型 描述
    DedicatedResourcePackIdSet Array of String 创建的实例资源池ID列表。形如:rpp-39kj2fsb。
    示例值:["rpp-2gyonkx7"]
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建实例资源池预扣包

    创建一个实例资源池预扣包

    输入示例

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: PurchaseResourcePoolPacks
    <公共请求参数>
    
    {
        "Zone": "ap-guangzhou-7",
        "InstanceType": "S9.8XLARGE64",
        "InstanceCount": 1,
        "Period": 1
    }

    输出示例

    {
        "Response": {
            "DedicatedResourcePackIdSet": [
                "rpp-2gyonkx7"
            ],
            "RequestId": "b0c7e70b-c576-40d7-b2fd-1807a7400616"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameter 参数错误。
    InvalidParameter.InstanceTypeNotSupport 指定机型不支持。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.DedicatedResourcePackName 专有资源包名称无效。名称长度必须为1-60个字符,只能包含中文、英文字母、数字、连字符(-)和下划线(_)
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidParameterValue.ResourcePoolPackTypeNotSupported 指定的资源池类型无效
    InvalidPeriod 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。
    InvalidZone.MismatchRegion 指定的zone不存在。
    MissingParameter 缺少参数错误。
    ResourceInsufficient.SpecifiedInstanceType 指定的实例类型库存不足。
    ResourceNotFound.InvalidZoneInstanceType 可用区不支持此机型。
    ResourcesSoldOut.AvailableZone 该可用区已售罄
    UnauthorizedOperation 未授权操作。
    UnsupportedOperation.EdgeZoneNotSupportPurchaseReserved 边缘可用区不支持预扣资源包。
    UnsupportedOperation.ResourcePoolPackageInvisibleForUser 该资源池对用户不可见