DescribeUserResourcePackage - Edge Security Acceleration

Queries the resource plan information of the current user.

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

esa:DescribeUserResourcePackage

none

*All Resource

*

None

Request syntax

GET  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID of the resource plan.	**_ResourcePack-cn-**
Status	string	No	The status of the resource plan. Default value: valid. Valid values: valid: Valid. invalid: Invalid. exhaust: Exhausted. Valid values: valid : Valid. invalid : Invalid. exhaust : Exhausted.	valid
SortField	string	No	The sorting field. Valid values: startTime: the effective period of the instance. endTime: the expiration time of the instance. StartTime: the effective period of the instance. EndTime: the expiration time of the instance. default: no sorting field. Valid values: startTime : The effective period of the instance. endTime : Instance expiration time. default : No sorting field. EndTime : Instance expiration time. StartTime : The effective period of the instance.	startTime
SortRule	string	No	The sorting rule. Default value: desc. Valid values: asc desc Valid values: asc : Ascending order. desc : Descending order.	desc
PageSize	integer	No	The number of entries per page. Default value: 20.	20
PageNumber	integer	No	The page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	CB1A380B-09F0-41BB-A198-72F8FD6DA2FE
TotalCount	integer	The total number of records.	68
PageSize	integer	The number of entries per page.	20
PageNumber	integer	The current page number.	1
ResourcePackageInfos	array<object>	The array of ResourcePackageInfo objects.
	object	The array of ResourcePackageInfo objects.
EndTime	string	The expiration time in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.	2024-12-02T15:59:59Z
Status	string	The status of the resource plan.	valid
DisplayName	string	The name of the resource plan.	Data Transfer Plan in Asia Pacific 1
StartTime	string	The effective period in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.	2024-03-20T16:00:00Z
CommodityCode	string	The commodity code of the resource plan.	dcdnpaybag
InstanceId	string	The instance ID of the resource plan.	**_ResourcePack-cn-**
TemplateName	string	The template name.	FPT_dcdnpaybag_deadlineAcc_****
CurrCapacity	string	The current remaining capacity of the instance. Unit for traffic plans: Byte. Unit for request plans: count.	53661095687
InitCapacity	string	The total capacity of the resource plan. Unit for traffic plans: Byte. Unit for request plans: count.	107374182400
Region	string	The region.	CN
CurrCapacityShowValue	string	The display value of the current remaining capacity of the instance.	49.975789
CurrCapacityShowUnit	string	The display unit of the current remaining capacity of the instance.	GB
CurrCapacityBaseUnit	string	The base unit of the current remaining capacity of the instance.	Byte
InitCapacityShowValue	string	The display value of the total capacity of the resource plan.	100.000000
InitCapacityShowUnit	string	The display unit of the total capacity of the resource plan.	GB
InitCapacityBaseUnit	string	The base unit of the total capacity of the resource plan.	Byte

Examples

Success response

JSON format

{
  "RequestId": "CB1A380B-09F0-41BB-A198-72F8FD6DA2FE\n",
  "TotalCount": 68,
  "PageSize": 20,
  "PageNumber": 1,
  "ResourcePackageInfos": [
    {
      "EndTime": "2024-12-02T15:59:59Z",
      "Status": "valid",
      "DisplayName": "Data Transfer Plan in Asia Pacific 1\n",
      "StartTime": "2024-03-20T16:00:00Z",
      "CommodityCode": "dcdnpaybag",
      "InstanceId": "****_ResourcePack-cn-****",
      "TemplateName": "FPT_dcdnpaybag_deadlineAcc_****",
      "CurrCapacity": "53661095687",
      "InitCapacity": "107374182400",
      "Region": "CN",
      "CurrCapacityShowValue": "49.975789",
      "CurrCapacityShowUnit": "GB",
      "CurrCapacityBaseUnit": "Byte",
      "InitCapacityShowValue": "100.000000\n",
      "InitCapacityShowUnit": "GB",
      "InitCapacityBaseUnit": "Byte"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.