QueryResourcePackageInstances - Query resource plan instances - Expenses and Costs

Queries the instances of a specific resource plan for a user. Only valid resource plans are supported.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bss:DescribeInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProductCode	string	No	The product code.	rds
ExpiryTimeStart	string	No	The expiration start time. 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
ExpiryTimeEnd	string	No	The expiration end time. 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
PageNum	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 300.	20
IncludePartner	boolean	No	Specifies whether to include partners.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	6000EE23-274B-4E07-A697-FF2E999520A4
Success	boolean	Indicates whether the request is successful.	true
Code	string	The status code.	Success
Message	string	The error message.	Successful!
PageSize	integer	The number of entries per page.	20
Total	integer	The total number of records.	12
Page	integer	The page number.	1
Data	object	The returned data.
PageNum	string	The page number.	1
PageSize	string	The number of entries per page.	20
TotalCount	string	The total number of records.	12
HostId	string	The host ID.	cn
Instances	object
Instance	array<object>	The array of instance details.
	array<object>
ExpiryTime	string	The expiration time in the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is in UTC.	2019-03-12T16:00:00Z
Status	string	The status of the resource plan. Valid values: Available: The resource plan is valid. Expired: The resource plan has expired.	Available
Remark	string	The remarks for the resource plan commodity. Only Chinese descriptions are provided.	标准存储包(华东2)
RemainingAmountUnit	string	The unit of the remaining amount.	GB
InstanceId	string	The instance ID.	OSSBAG-cn-v0h1s4hma01
PackageType	string	The type of the resource plan.	FPT_ossbag_absolute_Storage_sh
EffectiveTime	string	The effective period in the ISO 8601 standard in the YYYY-MM-DDTHH:mm:ssZ format. The time is in UTC.	2018-09-12T09:51:56Z
Region	string	The region.	cn-hangzhou
TotalAmount	string	The total amount.	40.000
DeductType	string	The deduction type. Valid value: Absolute.	Absolute
TotalAmountUnit	string	The unit of the total amount.	GB
RemainingAmount	string	The remaining amount.	40.000
ApplicableProducts	object
Product	array	The list of applicable products.
	string	The applicable product of the resource plan.	{"Product": ["oss"] }
CommodityCode	string	The commodity code.	rds

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.	Invalid user identity.
400	OwnerIdInvalid	Parameter ownerId is invalid.
400	OwnerIdMissing	Paramter ownerId is missing.
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.