文档

QuerySavingsPlansInstance - 节省计划实例查询

更新时间:
一键部署

查询当前用户保有的节省计划实例信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
bssapi:QuerySavingsPlansInstanceREAD
  • 全部资源
    *

请求参数

名称类型必填描述示例值
PageSizeinteger

每页个数

20
Localestring

多语言信息

  • ZH 中文
  • EN 英文
ZH
PageNuminteger

查询页数

1
InstanceIdstring

节省计划实例 ID

spn-xxxxxxx
StartTimestring

开始时间,格式 yyyy-MM-dd HH:mm:ss

2020-01-01 00:00:00
EndTimestring

结束时间,格式 yyyy-MM-dd HH:mm:ss

2021-01-01 00:00:00
Tagobject []

标签元素列表

Keystring

标签查询键

测试标签
Valuestring

标签查询值

测试标签
Statusstring

实例状态: NORMAL:有效 RELEASE 失效

NORMAL

返回参数

名称类型描述示例值
object

返回值对象

Codestring

错误码

Success
Messagestring

错误信息

Successful
RequestIdstring

请求 ID

61293E7A-3406-4447-8620-EC88B0AA66AD
Successboolean

是否成功

true
Dataobject

返回元素

PageNuminteger

查询页数

1
PageSizeinteger

每页个数

20
TotalCountinteger

总个数

100
Itemsobject []

实例信息列表

Statusstring

当前状态

  • NORMAL 正常状态

  • LIMIT 欠费停机

  • RELEASE 释放

NORMAL
Cyclestring

购买年限

1:Year
StartTimestamplong

开始时间戳

1663135741039
SavingsTypestring

节省计划类型:

  • unversal 通用型
  • ecs 计算型
ECS
Utilizationstring

总使用率

1.0
PrepayFeestring

预付金额

8760.00
InstanceIdstring

节省计划实例 ID

spn-xxxxxxxx
Currencystring

货币单位:CNY 人民币 USD 美元

CNY
EndTimestamplong

结束时间戳

1663135741039
EndTimestring

实例失效时间,格式 yyyy-MM-dd HH:mm:ss

2021-01-01 00:00:00
StartTimestring

实例生效时间,格式 yyyy-MM-dd HH:mm:ss

2020-01-01 00:00:00
AllocationStatusstring

分配状态:

  • unallocated 未分配
  • allocated 分配中
  • beAllocated 被分配中
unallocated
InstanceFamilystring

如果是 ECS 型实例,表示对应的规格族信息或者规格族套餐信息

ecs.g6
Regionstring

地域信息

cn-zhangjiakou-na62-a01
LastBillTotalUsagestring

上一周期抵扣总金额

100.0
LastBillUtilizationstring

上一周期使用率

0.8
TotalSavestring

总节省金额

20.00
PoolValuestring

承付款

1.00
PayModestring

付款类型:

  • total 全预付
  • half 半预付
  • zero 0 预付
total
Tagsobject []

标签信息列表

Keystring

标签键

标签1
Valuestring

标签值

标签1
DeductCycleTypestring

抵扣周期类型: HOUR:小时 DAY:天 ONCE:一次性(总量递减)

HOUR
RestPoolValuestring

弹性版,按月,按天保底当前周期剩余金额

100.0
CommodityCodestring

商品 Code

savingplan_common_public_cn
CurrentPoolValuestring

按月周期型当前周期池额度

100.0

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful",
  "RequestId": "61293E7A-3406-4447-8620-EC88B0AA66AD",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Items": [
      {
        "Status": "NORMAL",
        "Cycle": "1:Year",
        "StartTimestamp": 1663135741039,
        "SavingsType": "ECS",
        "Utilization": "1.0",
        "PrepayFee": "8760.00",
        "InstanceId": "spn-xxxxxxxx",
        "Currency": "CNY",
        "EndTimestamp": 1663135741039,
        "EndTime": "2021-01-01 00:00:00",
        "StartTime": "2020-01-01 00:00:00",
        "AllocationStatus": "unallocated",
        "InstanceFamily": "ecs.g6",
        "Region": "cn-zhangjiakou-na62-a01",
        "LastBillTotalUsage": "100.0",
        "LastBillUtilization": "0.8",
        "TotalSave": "20.00",
        "PoolValue": "1.00",
        "PayMode": "total",
        "Tags": [
          {
            "Key": "标签1",
            "Value": "标签1"
          }
        ],
        "DeductCycleType": "HOUR",
        "RestPoolValue": "100.0",
        "CommodityCode": "savingplan_common_public_cn",
        "CurrentPoolValue": "100.0"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidOwnerThe specified owner does not belong to caller.指定的所有者不属于调用方。
400InvalidParameterThe specified request contains invalid parameters.请求中包含无效参数。
400MissingParameterThe specified request lacks essential parameters.该请求缺少必要参数。
400NotApplicableThe specified API is not applicable for the user.此API不适用于调用方。
400NotApplicableYou are not authorized to call the API operation. Please check whether the caller site matches the API domain regionId.用户不可调用该API。请检查调用用户站点和API域名的地域信息是否匹配。
400NotAuthorizedThe user is not authorized for the specified API.此API未对该调用者进行授权。
400NotAuthorizedYou are not authorized to call the API operation. Please check whether RAM user has the permission or check whether ownerId and callerId have been given the appropriate permission.用户没有调用该API的权限。如果是RAM调用,请检查是否授予相应权限。否则请检查ownerId和callerId的权限归属是否正确。
500InternalErrorAn error occurred in the internal server.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-24OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-05-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2023-03-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更
2022-12-09OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:500
出参OpenAPI 返回结构发生变更