All Products
Search
Document Center

BSS OpenAPI:QueryResourcePackageInstances

Last Updated:Mar 01, 2024

Queries the instances of a resource plan. You can query the resource plans that are expired within one year.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bssapi:QueryResourcePackageInstancesREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductCodestringNo

The code of the service.

rds
ExpiryTimeStartstringNo

The beginning of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2020-02-02T12:00:00Z
ExpiryTimeEndstringNo

The end of the expiration time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

2020-02-02T13:00:00Z
PageNumintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. Maximum value: 300.

20
IncludePartnerbooleanNo

Specifies whether partners are involved.

true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Indicates whether the request is successful.

true
Codestring

The status code returned.

Success
Messagestring

The message returned.

Successful!
PageSizeinteger

The number of entries returned per page.

20
Totalinteger

The total number of returned entries.

12
Pageinteger

The page number of the returned page.

1
Dataobject

The data returned.

PageNumstring

The page number of the returned page.

1
PageSizestring

The number of entries returned per page.

20
TotalCountstring

The total number of returned entries.

12
HostIdstring

The ID of the host.

cn
Instancesobject []

The details of the instances.

ExpiryTimestring

The time when the resource plan expired.

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

The status of the resource plan. Valid values:

  • Available
  • Expired
Available
Remarkstring

The remarks on the resource plan. The remarks must be made in Chinese.

RemainingAmountUnitstring

The unit of the remaining quota.

GB
InstanceIdstring

The ID of the instance.

OSSBAG-cn-v0h1s4hma01
PackageTypestring

The type of the resource plan.

FPT_ossbag_absolute_Storage_sh
EffectiveTimestring

The time when the resource plan took effect.

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

The ID of the region.

cn-hangzhou
TotalAmountstring

The total quota of the resource plan.

40.000
DeductTypestring

The deduction type. Example: Absolute.

Absolute
TotalAmountUnitstring

The unit of the total quota.

GB
RemainingAmountstring

The remaining quota.

40.000
ApplicableProductsarray

The services to which the resource plan is applicable.

string

The service to which the resource plan is applicable.

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

The commodity code.

rds

Examples

Sample success responses

JSONformat

{
  "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": "",
          "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"
        }
      ]
    }
  }
}

Error codes

HTTP status codeError codeError messageDescription
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.Invalid user identity.
400OwnerIdInvalidParameter ownerId is invalid.-
400OwnerIdMissingParamter ownerId is missing.-
500InternalErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.