# View the list of purchased resource packs - DescribeUFilePkg

## Overview

View the list of purchased resource packs






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `DescribeUFilePkg`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.sigcalcloud.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Region. See [List of Regions and Availability Zones](/docs/api/summary/regionlist) |No|
| **Zone** | string | Availability Zones. See [List of Availability Zones](/docs/api/summary/regionlist) |No|
| **ProjectId** | string | Project ID. Leaving this field blank will default to the project ID. This is required for sub-accounts. Please refer to the [GetProjectList API](/docs/api/summary/get_project_list) |No|
| **ResourceId** | string | To query a specified resource package, the Region field is required when specifying ResourceId. |No|
| **Expired** | int | The default value is 0, which means querying all purchased resource packages; 1 means querying expired packages; and -1 means querying non-expired packages. |No|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Pkgs** | array[[*UFilePkg*](#ufilepkg)] | Purchased resource packs |**Yes**|

#### Data Model


#### UFilePkg

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Region** | string | Resource Package Region |**Yes**|
| **ResourceId** | string | Resource Package ID |No|
| **PkgName** | string | Resource Package Name |No|
| **PkgType** | int | Resource Package Type ID |No|
| **Amount** | int | Resource Package Capacity |No|
| **RemainAmount** | string | Remaining Capacity of Resource Package (Only Supports Traffic Package) |No|
| **CreateTime** | int | Resource Package Creation Time |No|
| **ExpiredTime** | int | Resource Package Expiration Time |No|

## Example

### Request Example
    
```
https://api.sigcalcloud.com/?Action=DescribeUFilePkg
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=xhsJdhxW
&ResourceId=qcurMiDR
&Exprired=0
&Expired=0
```

### Response Example
    
```json
{
  "Action": "DescribeUFilePkgResponse",
  "Pkgs": [
    {
      "Amount": 4,
      "CreateTime": 9,
      "ExpiredTime": 9,
      "PkgType": 8,
      "RemainAmount": "tBdjYLgy",
      "ResourceId": "TNMDmPhR"
    }
  ],
  "RetCode": 0
}
```