查询用户某个资源包的实例,仅支持查询有效的资源包。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
bss:DescribeInstances |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ProductCode |
string |
否 |
产品代码。 |
rds |
| ExpiryTimeStart |
string |
否 |
失效起始时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。 |
2020-02-02T12:00:00Z |
| ExpiryTimeEnd |
string |
否 |
失效结束时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。 |
2020-02-02T13:00:00Z |
| PageNum |
integer |
否 |
页码,默认为 1。 |
1 |
| PageSize |
integer |
否 |
每页条数,默认值 20,最大 300。 |
20 |
| IncludePartner |
boolean |
否 |
是否包含合作伙伴。 |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
6000EE23-274B-4E07-A697-FF2E999520A4 |
| Success |
boolean |
是否成功。 |
true |
| Code |
string |
状态码。 |
Success |
| Message |
string |
错误信息。 |
Successful! |
| PageSize |
integer |
每页条数。 |
20 |
| Total |
integer |
总记录数。 |
12 |
| Page |
integer |
页码。 |
1 |
| Data |
object |
返回数据。 |
|
| PageNum |
string |
页码。 |
1 |
| PageSize |
string |
每页条数。 |
20 |
| TotalCount |
string |
总记录数。 |
12 |
| HostId |
string |
主机 ID。 |
cn |
| Instances |
object |
||
| Instance |
array<object> |
实例详情数组。 |
|
|
array<object> |
|||
| ExpiryTime |
string |
失效时间,格式为 ISO 8601 UTC 时间(YYYY-MM-DDTHH:mm:ssZ)。 |
2019-03-12T16:00:00Z |
| Status |
string |
资源包状态,取值:
|
Available |
| Remark |
string |
资源包商品的备注说明,只提供中文说明 |
标准存储包(华东2) |
| RemainingAmountUnit |
string |
剩余量单位。 |
GB |
| InstanceId |
string |
实例 ID。 |
OSSBAG-cn-v0h1s4hma01 |
| PackageType |
string |
资源包类型。 |
FPT_ossbag_absolute_Storage_sh |
| EffectiveTime |
string |
生效时间,格式为 ISO 8601 UTC 时间(YYYY-MM-DDTHH:mm:ssZ)。 |
2018-09-12T09:51:56Z |
| Region |
string |
地域。 |
cn-hangzhou |
| TotalAmount |
string |
总量。 |
40.000 |
| DeductType |
string |
扣费类型:Absolute。 |
Absolute |
| TotalAmountUnit |
string |
总量单位。 |
GB |
| RemainingAmount |
string |
剩余量。 |
40.000 |
| ApplicableProducts |
object |
||
| Product |
array |
适用产品列表。 |
|
|
string |
资源包适用产品。 |
{"Product": ["oss"] } |
|
| CommodityCode |
string |
商品 code |
rds |
示例
正常返回示例
JSON格式
{
"RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
"Success": true,
"Code": "Success",
"Message": "Successful!",
"PageSize": 20,
"Total": 12,
"Page": 1,
"Data": {
"PageNum": "1",
"PageSize": "20",
"TotalCount": "12",
"HostId": "cn",
"Instances": {
"Instance": [
{
"ExpiryTime": "2019-03-12T16:00:00Z",
"Status": "Available",
"Remark": "标准存储包(华东2)",
"RemainingAmountUnit": "GB",
"InstanceId": "OSSBAG-cn-v0h1s4hma01",
"PackageType": "FPT_ossbag_absolute_Storage_sh",
"EffectiveTime": "2018-09-12T09:51:56Z",
"Region": "cn-hangzhou",
"TotalAmount": "40.000",
"DeductType": "Absolute",
"TotalAmountUnit": "GB",
"RemainingAmount": "40.000",
"ApplicableProducts": {
"Product": [
"{\"Product\": [\"oss\"] }"
]
},
"CommodityCode": "rds"
}
]
}
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | NotApplicable | This API is not applicable for caller. | |
| 400 | NotAuthorized | This API is not authorized for caller. | |
| 400 | MissingParameter | Absent some mandatory parameter for this request. | |
| 400 | InvalidParameter | This request contain some invalid parameter | |
| 400 | InvalidOwner | The specified owner doesn't belong to caller. | 用户身份错误 |
| 400 | OwnerIdInvalid | Parameter ownerId is invalid. | |
| 400 | OwnerIdMissing | Paramter ownerId is missing. | |
| 500 | InternalError | The request processing has failed due to some unknown error. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。