DescribeResourcePackages API Reference for PolarDB Cross-Cloud Plans - PolarDB - Alibaba Cloud - PolarDB

Describes cross-cloud resource plans.

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

polardb:DescribeResourcePackages

get

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E56531A4-E552-40BA-9C58-137B80******
ResourcePackageList	array<object>	A list of cross-cloud resource plans.
	array<object>
ResourcePackageId	string	The ID of the cross-cloud resource plan.	pm-bp11b0i9389******
ResourcePackageType	string	The type of the cross-cloud resource plan.	MySQL
Status	string	The status of the cross-cloud resource plan. Valid values: Normal: Normal. Maintaining: Under maintenance.	Normal
UsedCapacity	integer	The used capacity.	4
TotalCapacity	integer	The total capacity.	8
CreateTime	integer	The time when the resource plan was created.	1744621511000
ExpireTime	integer	The time when the resource plan expires.	1747238400000
AutoQuota	boolean	Indicates whether automatic quota allocation is enabled.	true
ResourcePackageQuotaList	array<object>	The quota allocation details.
	object
ProjectId	string	The ID of the resource pool.	pj-87681rbcef6******
UsedCapacity	integer	The used capacity of the resource pool.	2
AllocatedCapacity	integer	The capacity allocated to the resource pool.	6
Tags	array<object>	The list of tags.
	object
Key	string	The tag key.	Key
Value	string	The tag value.	Value

Examples

Success response

JSON format

{
  "RequestId": "E56531A4-E552-40BA-9C58-137B80******",
  "ResourcePackageList": [
    {
      "ResourcePackageId": "pm-bp11b0i9389******",
      "ResourcePackageType": "MySQL",
      "Status": "Normal",
      "UsedCapacity": 4,
      "TotalCapacity": 8,
      "CreateTime": 1744621511000,
      "ExpireTime": 1747238400000,
      "AutoQuota": true,
      "ResourcePackageQuotaList": [
        {
          "ProjectId": "pj-87681rbcef6******",
          "UsedCapacity": 2,
          "AllocatedCapacity": 6
        }
      ],
      "Tags": [
        {
          "Key": "Key",
          "Value": "Value"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.