查询当前用户保有的节省计划实例信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| bssapi:QuerySavingsPlansInstance | READ |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| PageSize | integer | 否 | 每页个数 | 20 |
| Locale | string | 否 | 多语言信息
| ZH |
| PageNum | integer | 否 | 查询页数 | 1 |
| InstanceId | string | 否 | 节省计划实例 ID | spn-xxxxxxx |
| StartTime | string | 否 | 开始时间，格式 yyyy-MM-dd HH:mm:ss | 2020-01-01 00:00:00 |
| EndTime | string | 否 | 结束时间，格式 yyyy-MM-dd HH:mm:ss | 2021-01-01 00:00:00 |
| Tag | object [] | 否 | 标签元素列表 | |
| Key | string | 否 | 标签查询键 | 测试标签 |
| Value | string | 否 | 标签查询值 | 测试标签 |
| Status | string | 否 | 实例状态： NORMAL:有效 RELEASE 失效 | NORMAL |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidOwner | The specified owner does not belong to caller. | 指定的所有者不属于调用方。 |
| 400 | InvalidParameter | The specified request contains invalid parameters. | 请求中包含无效参数。 |
| 400 | MissingParameter | The specified request lacks essential parameters. | 该请求缺少必要参数。 |
| 400 | NotApplicable | The specified API is not applicable for the user. | 此API不适用于调用方。 |
| 400 | NotApplicable | You are not authorized to call the API operation. Please check whether the caller site matches the API domain regionId. | 用户不可调用该API。请检查调用用户站点和API域名的地域信息是否匹配。 |
| 400 | NotAuthorized | The user is not authorized for the specified API. | 此API未对该调用者进行授权。 |
| 400 | NotAuthorized | You 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的权限归属是否正确。 |
| 500 | InternalError | An error occurred in the internal server. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 2023-07-24 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-05-25 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2023-03-27 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
| ||||||||||
| 2022-12-09 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||||
|