{
  "name": "svp",
  "display_name": "节省计划",
  "description": "介绍如何使用API对节省计划相关进行操作，包括购买、查询等。",
  "domain": "other",
  "api_version": "2024-01-25",
  "endpoint": "svp.tencentcloudapi.com",
  "actions": [
    {
      "name": "CreateSavingPlanOrder",
      "description": "创建节省计划订单",
      "status": "online",
      "parameters": [
        {
          "name": "RegionId",
          "type": "integer",
          "required": true,
          "description": "地域编码",
          "example": "47"
        },
        {
          "name": "ZoneId",
          "type": "integer",
          "required": true,
          "description": "区域编码",
          "example": "470004"
        },
        {
          "name": "PrePayType",
          "type": "string",
          "required": true,
          "description": "预付费类型",
          "example": "1全预费    2部分预付   3 不预付"
        },
        {
          "name": "TimeSpan",
          "type": "integer",
          "required": true,
          "description": "时长",
          "example": "示例值：时长为一年时，timeSpan为 1"
        },
        {
          "name": "TimeUnit",
          "type": "string",
          "required": true,
          "description": "时长单位",
          "example": "示例值：时长为一年时，timeUnit为 y"
        },
        {
          "name": "CommodityCode",
          "type": "string",
          "required": true,
          "description": "商品唯一标识",
          "example": "svp_common_CYq7cGNk3FaV"
        },
        {
          "name": "PromiseUseAmount",
          "type": "integer",
          "required": true,
          "description": "承诺时长内的小额金额（单位：元）",
          "example": "10000"
        },
        {
          "name": "SpecifyEffectTime",
          "type": "string",
          "required": false,
          "description": "节省计划的指定生效时间，若不传则为当前下单时间。传参数格式:\"2023-10-01 00:00:00\"，仅支持指定日期的0点时刻",
          "example": "2023-10-21 00:00:00"
        },
        {
          "name": "ClientToken",
          "type": "string",
          "required": false,
          "description": "可重入ID",
          "example": "可重入标记，业务名+64位UUID"
        }
      ],
      "required": [
        "RegionId",
        "ZoneId",
        "PrePayType",
        "TimeSpan",
        "TimeUnit",
        "CommodityCode",
        "PromiseUseAmount"
      ]
    },
    {
      "name": "DescribeSavingPlanCoverage",
      "description": "查询当前用户节省计划覆盖率明细数据，如无特别说明，金额单位均为元（国内站）或者美元（国际站）。",
      "status": "online",
      "parameters": [
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "费用起始日期，格式yyyy-MM-dd",
          "example": "2023-06-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "费用结束日期，格式yyyy-MM-dd",
          "example": "2023-06-30"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页偏移量，Offset=0表示第一页，如果Limit=100，则Offset=100表示第二页，Offset=200表示第三页，以此类推",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "数量，最大值为200",
          "example": "200"
        },
        {
          "name": "PeriodType",
          "type": "integer",
          "required": false,
          "description": "取值包括1（缺省值）和2，1表示按天统计覆盖率，2表示按月统计覆盖率，此参数仅影响返回的RateSet聚合粒度，不影响返回的DetailSet",
          "example": "1"
        }
      ],
      "required": [
        "StartDate",
        "EndDate",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeSavingPlanDeduct",
      "description": "查询节省计划抵扣明细",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "每页数量，最大值为200",
          "example": "200"
        },
        {
          "name": "StartEndDate",
          "type": "string",
          "required": true,
          "description": "节省计划使用开始的查询结束时间",
          "example": "2024-05-11 14:23:57\t"
        },
        {
          "name": "StartStartDate",
          "type": "string",
          "required": true,
          "description": "节省计划使用开始的查询开始时间",
          "example": "2024-05-11 14:23:57\t"
        },
        {
          "name": "RegionId",
          "type": "integer",
          "required": false,
          "description": "地域编码",
          "example": "47"
        },
        {
          "name": "ZoneId",
          "type": "integer",
          "required": false,
          "description": "区域编码",
          "example": "470004"
        },
        {
          "name": "SpId",
          "type": "string",
          "required": false,
          "description": "节省计划资源id",
          "example": "svp-jaq000fk"
        },
        {
          "name": "DeductEndDate",
          "type": "string",
          "required": false,
          "description": "抵扣查询结束时间，格式：yyyy-MM-dd HH:mm:ss",
          "example": "2024-05-11 14:23:57\t"
        },
        {
          "name": "DeductStartDate",
          "type": "string",
          "required": false,
          "description": "抵扣查询开始时间，格式：yyyy-MM-dd HH:mm:ss",
          "example": "2024-05-11 14:23:57\t"
        },
        {
          "name": "EndEndDate",
          "type": "string",
          "required": false,
          "description": "节省计划使用结束的查询结束时间",
          "example": "2024-05-11 14:23:57"
        },
        {
          "name": "EndStartDate",
          "type": "string",
          "required": false,
          "description": "节省计划使用结束的查询开始时间",
          "example": "2024-05-11 14:23:57"
        }
      ],
      "required": [
        "Offset",
        "Limit",
        "StartEndDate",
        "StartStartDate"
      ]
    },
    {
      "name": "DescribeSavingPlanOverview",
      "description": "查用当前用户明细节省计划总览查询时段内的使用情况",
      "status": "online",
      "parameters": [
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "开始时间，格式yyyy-MM-dd 注：查询范围请勿超过6个月",
          "example": "2023-06-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "结束时间，格式yyyy-MM-dd",
          "example": "2023-06-30"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页偏移量",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "每页数量，最大值为200",
          "example": "100"
        }
      ],
      "required": [
        "StartDate",
        "EndDate",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeSavingPlanUsage",
      "description": "查用当前用户明细节省计划查询时段内的使用情况",
      "status": "online",
      "parameters": [
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "开始时间，格式yyyy-MM-dd 注：查询范围请勿超过6个月",
          "example": "2023-06-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "结束时间，格式yyyy-MM-dd",
          "example": "2023-06-30"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "每页数量，最大值为200",
          "example": "200"
        },
        {
          "name": "TimeInterval",
          "type": "string",
          "required": true,
          "description": "查询结果数据的时间间隔",
          "example": "daily:日 month：月"
        }
      ],
      "required": [
        "StartDate",
        "EndDate",
        "Offset",
        "Limit",
        "TimeInterval"
      ]
    }
  ]
}