文档

QueryResourcePackageInstances - 查询资源包实例服务

更新时间:

查询用户某个资源包的实例,限定支持查询失效时间一年以内的资源包。

调试

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

授权信息

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

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

请求参数

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

产品代码。

rds
ExpiryTimeStartstring

失效起始时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

2020-02-02T12:00:00Z
ExpiryTimeEndstring

失效结束时间。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

2020-02-02T13:00:00Z
PageNuminteger

页码,默认为 1。

1
PageSizeinteger

每页条数,默认值 20,最大 300。

20
IncludePartnerboolean

是否包含合作伙伴。

true

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

6000EE23-274B-4E07-A697-FF2E999520A4
Successboolean

是否成功。

true
Codestring

状态码。

Success
Messagestring

错误信息。

Successful!
PageSizeinteger

每页条数。

20
Totalinteger

总记录数。

12
Pageinteger

页码。

1
Dataobject

返回数据。

PageNumstring

页码。

1
PageSizestring

每页条数。

20
TotalCountstring

总记录数。

12
HostIdstring

主机 ID。

cn
Instancesobject []

实例详情数组。

ExpiryTimestring

失效时间。

2019-03-12T16:00:00Z
Statusstring

资源包状态,取值:

  • Available(有效)。
  • Expired(失效)。
Available
Remarkstring

资源包商品的备注说明,只提供中文说明

标准存储包(华东2)
RemainingAmountUnitstring

剩余量单位。

GB
InstanceIdstring

实例 ID。

OSSBAG-cn-v0h1s4hma01
PackageTypestring

资源包类型。

FPT_ossbag_absolute_Storage_sh
EffectiveTimestring

生效时间。

2018-09-12T09:51:56Z
Regionstring

地域。

cn-hangzhou
TotalAmountstring

总量。

40.000
DeductTypestring

扣费类型:Absolute。

Absolute
TotalAmountUnitstring

总量单位。

GB
RemainingAmountstring

剩余量。

40.000
ApplicableProductsarray

适用产品列表。

string

资源包适用产品。

{"Product": ["oss"] }
CommodityCodestring

商品 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错误码错误信息描述
400NotApplicableThis API is not applicable for caller.-
400NotAuthorizedThis API is not authorized for caller.-
400MissingParameterAbsent some mandatory parameter for this request.-
400InvalidParameterThis request contain some invalid parameter-
400InvalidOwnerThe specified owner doesn't belong to caller.用户身份错误
400OwnerIdInvalidParameter ownerId is invalid.-
400OwnerIdMissingParamter ownerId is missing.-
500InternalErrorThe request processing has failed due to some unknown error.内部服务器错误。

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

  • 本页导读 (0)
文档反馈